{ "openapi": "3.1.2", "info": { "version": "1.0.0", "title": "Customer Search", "description": "This is an OpenAPI Specification for APIs that provide unified customer identity and account search.", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner.att.com/omni-svcs" } ], "security": [], "tags": [ { "name": "Customer Search", "description": "Omni Customer Search" } ], "paths": { "/v1/customers/search": { "post": { "tags": [ "Customer Search" ], "description": "Returns Customers associated individuals, and account information.", "summary": "Search customers by identity and account attributes", "operationId": "CustomerSearch", "parameters": [ { "$ref": "#/components/parameters/ParameterAppname" } ], "requestBody": { "description": "Customer search request payload", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSearchResponse" }, "examples": { "wirelessAccountLookupResponse": { "summary": "Wireless Account Lookup response", "x-tags": [ "Wireless" ], "value": { "individuals": [ { "id": "00d9cf1d-9266-4b0d-b008-7fa562dc6707", "firstName": "Joe", "lastName": "Smith", "title": "Mr", "preferredName": "Joe", "preferredPronoun": "He", "suffix": "JR", "middleInitial": "D", "additionalTitle": "Spine", "languageAbility": [ { "languageCode": "en", "languageName": "English" } ], "status": "initialized", "passcodeStatus": "DEFAULT", "contactMedium": [ { "mediumType": "telephone", "preferred": true, "characteristic": { "contactType": "homephone", "phoneNumber": "1234556679", "verified": true, "establishmentDate": "2023-07-06T20:24:19.820Z" } }, { "mediumType": "email", "preferred": true, "characteristic": { "contactType": "other", "emailAddress": "smitha@yahoo.com", "verified": true, "verifiedOn": "2024-09-03T00:56:11.650Z", "establishmentDate": "2024-09-03T00:56:11.650Z" } }, { "mediumType": "postalAddress", "characteristic": { "contactType": "shipping", "city": "TAMPA", "country": "USA", "postCode": "60042-6252", "stateOrProvince": "FL", "street1": "201 WOODLAND ST", "place": { "id": "0000161MNE" }, "verified": false, "establishmentDate": "2023-07-06T20:24:46.935Z", "updatedOn": "2023-07-06T20:24:46.935Z" } } ], "relatedAccounts": [ { "accountId": "558792209760", "role": "owner", "customerId": "5dcb178f-f81c-4da4-9cf4-efce4d4add6d" }, { "accountId": "558792209762", "role": "au" }, { "accountId": "558792209765", "role": "alternate-user" } ], "createdOn": "2023-07-06T20:24:19.820Z", "updatedOn": "2025-01-15T00:43:16.866Z", "statusUpdatedOn": "2025-07-28T13:14:37.497Z", "targetSOR": "CG", "relatedParty": [ { "id": "cfbb99dd-0ceb-4347-8ba1-bccd5b0ddc65", "role": "customer" } ], "accounts": [ { "id": "55000990898", "accountType": "I", "accountSubType": "R", "accountNickname": "accountnickname", "ratingType": "post-prepaid", "serviceType": "wireless", "targetSOR": "CG", "subscriberId": "cg-01335f90-fb78-4946-ab63-45bcba6a39e5", "state": { "state": "active", "stateChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "passcodeStatus": "DEFAULT", "additionalSecurity": "Y", "accountBalance": [ { "amount": -55, "balanceType": "Total Balance" }, { "amount": 0, "balanceType": "Disputed Amount" }, { "amount": 0, "balanceType": "PastDue Balance" } ], "fanDetails": { "fanId": "04085530", "fanDescription": "ABC Corporation", "associationDate": "2025-03-29T10:00:00Z" }, "createdOn": "2023-07-06T20:24:38.159Z", "lastModified": "2023-08-12T15:38:45.127Z", "openDate": "2023-08-12T15:38:45.127Z", "billingMarket": "abc", "contact": [ { "contactMedium": [ { "mediumType": "postalAddress", "preferred": "true", "characteristic": { "contactType": "billing", "city": "LAKE ZURICH", "country": "USA", "postCode": "60047-6252", "stateOrProvince": "IL", "street1": "728 JUNE TER", "place": { "id": "0000171MNE" }, "establishmentDate": "2023-07-06T20:24:41.233Z", "geocode": "140971540", "geocodeOverideIndicator": "N", "updatedOn": "2023-07-06T20:24:41.233Z" } } ] } ], "billPay": { "defaultPaymentMethod": { "id": "RTB,XX,00d9cf1d-9266-4b6d-b118-7fa562dc6707,PK0TQVMB87R246WZF", "paymentMethod": "CreditCard", "citiCoBrandCard": "false", "cardNumber": "XXXXXXXXXXXX1955", "validFor": { "startDateTime": "2023-07-06T20:56:36.133Z" } } }, "bill": { "billStructure": { "presentationMedia": [ { "id": "string", "name": "email" } ], "cycleSpecification": { "id": "12", "name": "BillingCycleSpecification", "frequency": "month" } }, "paymentDueDate": "2025-03-20T05:59:59.000Z", "paymentDate": "2025-03-19T05:59:59.000Z", "paymentStatus": "inTreatment" }, "relatedIndividuals": [ { "individualId": "00d9cf1d-9266-4b6d-b008-7fa562dc6707", "customerId": "e446eacb-4e62-405d-8d2a-a3f4ceafd890", "role": "owner" } ], "subscribers": [ { "id": "8aa3cec-8920-43b1-92c4-b37321916af0", "phoneNumber": "2146561306", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2024-05-28T14:04:26.962Z" } ] }, "subscriberType": "WIRELESS, AIA, FIBER,BAPWIRELESS", "isPreferredCTN": true, "createdOn": "2025-03-05T19:05:13.856Z", "updatedOn": "2025-03-05T19:05:13.856Z", "activationDate": "2025-03-05T19:05:13.856Z", "effectiveDate": "2022-07-11T22:10:48.448Z", "openDate": "2022-07-11T22:10:48.448Z", "isSMSCapable": true, "isFirstNetSubscriber": false, "contactMedium": [ { "mediumType": "postalAddress", "characteristic": { "contactType": "ppu", "city": "Morristown", "country": "USA", "postCode": "07960", "stateOrProvince": "New Jersey", "street1": "240 Headquarters Plazza", "street2": "East Tower - 10th Floor", "geocode": "String", "geocodeOverideIndicator": "false", "updatedOn": "2022-07-11T22:10:48.448Z", "establishmentDate": "2022-07-02T10:48:48.448Z", "place": { "id": "OIUDDA011" }, "timezone": "EST", "dst": "Y", "latitude": "31.464", "longitude": "-83.985" } } ], "profile": { "individualId": "00d9cf1d-9266-4bgd-b008-7fa562dc6707", "firstName": "optional", "lastName": "optional" }, "serviceCharacteristic": { "isWifiCalling": true, "callerid": "Joesmith", "callerIdBlockIndicator": true, "devices": [ { "type": "iPhone", "imei": 90154203237518, "imeiType": "J2", "serialNumber": "string", "sim": { "iccid": 89012807331583700000, "imsi": 310150123456789, "activationDate": "2022-07-02T10:48:48.448Z" } } ] }, "products": [ { "productOfferingTypeGroup": "mobileOffer", "id": "41843320465562077", "isBundle": true, "productOfferingClassification": "subscriberMainOffer", "rootProductId": "41843320465562077", "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "productPath": "/41843320465562077/", "name": "Value Plus VL FFA", "description": "Value Plus VL FFA", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ] }, { "productOfferingTypeGroup": "mobilePlan", "id": "40858614205792238", "isBundle": false, "productOfferingClassification": "subscriberOffer", "rootProductId": "41843320465562077", "productOfferingId": "e4b75a80-22f9-40b7-8dec-0c8e0368546c", "productPath": "/41843320465562077/40858614205792238", "name": "Value Plus VL FFA", "description": "Value Plus VL FFA", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "productCharacteristic": [ { "name": "Technology", "value": "5G", "valueType": "String", "characteristicMetadata": [] } ], "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ], "productFeature": [ { "id": "48736264283950950", "name": "Voice" }, { "id": "45782145504641433", "name": "Messaging" }, { "id": "39873907946022399", "name": "International" }, { "id": "46766851764411272", "name": "Phone Number", "productFeatureCharactersitics": [ { "name": "Phone_Number", "value": "2138788712", "valueType": "String" } ] }, { "id": "47751558024181111", "name": "Data", "productFeatureCharactersitics": [ { "name": "dataPolicy", "value": "95050", "valueType": "String" } ] }, { "id": "42828026725331916", "name": "Roaming" } ] }, { "productOfferingTypeGroup": "sim", "isBundle": false, "id": "44797439244871594", "productOfferingClassification": "subscriberOffer", "rootProductId": "41843320465562077", "productOfferingId": "790650ec-b512-4bee-ae7f-535668eadf1b", "productPath": "/41843320465562077/44797439244871594", "name": "Subscriber Identity Module", "description": "Subscriber Identity Module card for eSIM", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "productCharacteristic": [ { "name": "SIM_Type", "value": "eSIM", "valueType": "String", "characteristicMetadata": [ { "name": "Visible", "value": "True", "metadataType": "Configuration" } ] }, { "name": "EID", "value": "89043051202300838924015302630338", "valueType": "String" }, { "name": "SKU", "value": "NA", "valueType": "String" }, { "name": "SKU_With_Prefix", "value": "NA", "valueType": "String" }, { "name": "ICCID", "value": 89012807331583700000, "valueType": "String" }, { "name": "IMSI", "value": "310280158379713", "valueType": "String" } ], "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ] }, { "productOfferingTypeGroup": "mobileDevice", "isBundle": false, "id": "43812732985101755", "productOfferingClassification": "subscriberOffer", "rootProductId": "41843320465562077", "productOfferingId": "c9715944-afed-42eb-a35f-51c2ced6bea4", "productPath": "/41843320465562077/43812732985101755", "name": "Bring Your Own Phone", "description": "Bring Your Own Phone", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "productCharacteristic": [ { "name": "IMEI", "value": "351366676414220", "valueType": "String" }, { "name": "make", "value": "Apple", "valueType": "String" }, { "name": "model", "value": "16-pro", "valueType": "String" }, { "name": "imageUrl", "value": "https/iphone", "valueType": "String" }, { "name": "Variant_Group", "value": "Apple iPhone 12 Pro Max", "valueType": "String" }, { "name": "eSIM_Enabled", "value": "true", "valueType": "String" }, { "name": "ED_Model", "value": "SM-S921U", "valueType": "String" }, { "name": "IMEI_Type", "value": "PA", "valueType": "String" }, { "name": "BYOD", "value": "true", "valueType": "String" } ], "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ] }, { "type": "addon", "id": "HOMEPRO", "productOfferingTypeGroup": "mobileAddon", "productOfferingClassification": "Regular SOC", "rootProductId": "UNLIMTSDG", "productOfferingId": "HOMEPRO", "name": "HomeTech Protection", "description": "HomeTech Protection", "activationDate": "2023-04-03 00:00:00", "creationDate": "2023-04-02 20:38:28", "effectiveIssueDate": "2023-04-02 00:00:00", "productCharacteristic": [ { "name": "socNetwork", "value": "O" }, { "name": "isHPPChargeSOC", "value": "true" }, { "name": "genAttribute", "value": "RTP;SOCCOMB;CRU_RESTRICTED;NON_RESUMABLE_SOC;NON_MOVE;FBF_HPPCHG;RESADDPOBOX;RES_FUT_DT_ALW_PARK;" }, { "name": "agentCode", "value": "9HKJ9" }, { "name": "agentLocation", "value": "9HKJ9" }, { "name": "slbTargetBan", "value": "0" }, { "name": "offerInstanceId", "value": "0" }, { "name": "socVerNo", "value": "0" }, { "name": "delayRePriceInd", "value": "false" }, { "name": "maxMembers", "value": "0" }, { "name": "maxAllowedCtns", "value": "0" }, { "name": "lteInd", "value": "N" }, { "name": "socDuration", "value": "0" } ] }, { "productOfferingTypeGroup": "mobileAddon", "isBundle": false, "id": "65537566747764223", "productOfferingClassification": "subscriberOffer", "rootProductId": "41843320465562077", "productOfferingId": "3e841296-e828-4c13-adf1-3115f6ccb614", "productPath": "/41843320465562077/65537566747764223", "name": "AT&T ActiveArmor", "description": "AT&T ActiveArmor", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "productCharacteristic": [ { "name": "Mobile_Security_and_Call_Protect_Plus", "value": "AEGP", "valueType": "String" } ], "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ] }, { "productOfferingTypeGroup": "mobileAddon", "isBundle": false, "id": "73415216825922935", "productOfferingClassification": "subscriberOffer", "rootProductId": "41843320465562077", "productOfferingId": "1e6d9cf0-13cc-49a9-9e19-907ef46d6eb2", "productPath": "/41843320465562077/73415216825922935", "name": "International Day Pass", "description": "International Day Pass", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2025-03-05T19:05:13.856Z" } ] }, "activationDate": "2025-03-05T19:05:13.856Z", "creationDate": "2025-03-05T19:05:34.032Z", "lastUpdate": "2025-03-06T01:56:50Z", "productCharacteristic": [ { "name": "Mobile_Security_and_Call_Protect_Plus", "value": "AEGP", "valueType": "String" } ], "place": [ { "id": "00000PEYRX", "name": "ServiceAddress", "role": "PPU" } ] } ] } ] } ] } ] } } } } } }, "400": { "description": "Bad request - Missing fields, Invalid input data, validation failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "MissingSearchParameters": { "summary": "Missing search parameters", "value": { "error": { "errorId": "EXT_CUSTOMER_SEARCH-CG-0001", "message": "No search parameters provided. At least one search parameter combination must be supplied in the request.", "errorSystemId": "extpartnercustmgmtms", "details": [ { "code": "MISSING_SEARCHPARAMETERS", "message": "At least one search parameter combination must be provided." } ] } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "CustomerSearchSystemError": { "summary": "System Error", "value": { "error": { "errorId": "EXT_CUSTOMER_SEARCH-CG-500", "message": "System Error", "errorSystemId": "Customer Search", "details": [ { "code": "INTERNAL_SERVER", "message": "Unexpected server error occurred during processing. Please try again later." } ] } } } } } } } } } } }, "components": { "schemas": { "CustomerSearchRequest": { "type": "object", "description": "Search criteria to filter individuals and associated accounts.", "properties": { "accountId": { "type": "string", "description": "Unique billing account identifier (BAN or account number)." }, "firstName": { "type": "string", "description": "Customer first name." }, "lastName": { "type": "string", "description": "Customer last name." }, "phoneNumber": { "type": "string", "description": "Customer contact number, CTN, or CBR." }, "emailAddress": { "type": "string", "description": "Customer email address." }, "serviceType": { "$ref": "#/components/schemas/ServiceType", "description": "Type of service associated with the customer." }, "pageSize": { "type": "integer", "format": "int32", "description": "Number of results to return per page.", "default": 5, "minimum": 1 }, "pageOffset": { "type": "integer", "format": "int32", "description": "Offset for pagination. Starts at 1.", "default": 1, "minimum": 1 } } }, "CustomerSearchResponse": { "type": "object", "properties": { "individuals": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "totalCount": { "type": "integer", "format": "int32" } } }, "PageInfo": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32" }, "pageOffset": { "type": "integer", "format": "int32" } } }, "Individual": { "type": "object", "properties": { "id": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "preferredName": { "type": "string" }, "relatedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAccount" } }, "profile": { "$ref": "#/components/schemas/Profile" }, "status": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "updatedOn": { "type": "string", "format": "date-time" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "RelatedAccount": { "type": "object", "properties": { "accountId": { "type": "string" }, "role": { "type": "string" }, "customerId": { "type": "string" } } }, "Profile": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleInitial": { "type": "string" }, "emailAddress": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "ServiceType": { "type": "string", "enum": [ "WIRELESS", "UVERSE", "WIRELESSBROADBAND", "FIBER" ] }, "ProductCustomerSearch": { "type": "object", "description": "Product resource for unified customer search.", "properties": { "productOfferingTypeGroup": { "type": "string", "description": "Product offering type group." }, "id": { "type": "string", "description": "Unique product identifier." }, "isBundle": { "type": "boolean", "description": "Indicates whether the product is a bundle." }, "productOfferingClassification": { "type": "string", "description": "Product offering classification." }, "rootProductId": { "type": "string", "description": "Root product identifier." }, "productOfferingId": { "type": "string", "description": "Product offering identifier." }, "name": { "type": "string", "description": "Product name." }, "productCode": { "type": "string", "description": "Product code." }, "description": { "type": "string", "description": "Product description." }, "status": { "type": "object", "description": "Current product status details.", "additionalProperties": true }, "place": { "type": "array", "description": "Places associated with the product.", "items": { "type": "object", "additionalProperties": true } }, "productCharacteristic": { "type": "array", "description": "Characteristics associated with the product.", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": true }, "Subscriber": { "type": "object", "description": "Subscriber resource for unified customer search.", "properties": { "id": { "type": "string", "description": "Unique subscriber identifier." }, "phoneNumber": { "type": "string", "description": "Subscriber phone number (CTN/MSISDN)." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the subscriber record was created." }, "updatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the subscriber record was last updated." }, "activationDate": { "type": "string", "format": "date-time", "description": "Subscriber activation date and time." }, "effectiveDate": { "type": "string", "format": "date-time", "description": "Effective date and time for current subscriber state." }, "subMarket": { "type": "string", "description": "Subscriber submarket code." }, "status": { "type": "object", "description": "Subscriber status details.", "properties": { "state": { "type": "string", "description": "Current lifecycle state value." }, "stateChangeReason": { "type": "array", "description": "History of reasons associated with subscriber state transitions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reason name." }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the reason was recorded." }, "description": { "type": "string", "description": "Reason description." } } } } } }, "products": { "type": "array", "description": "Products associated with the subscriber.", "items": { "$ref": "#/components/schemas/ProductCustomerSearch" } } } }, "Account": { "type": "object", "description": "Account resource for unified customer search.", "properties": { "id": { "type": "string", "description": "Unique account identifier." }, "givenName": { "type": "string", "description": "Given name of the account holder." }, "familyName": { "type": "string", "description": "Family name of the account holder." }, "title": { "type": "string", "description": "Title of the account holder (for example, Mr, Ms, or Dr)." }, "middleInitial": { "type": "string", "description": "Middle initial of the account holder." }, "accountType": { "type": "string", "description": "Primary account type classification." }, "accountSubType": { "type": "string", "description": "Secondary account type classification." }, "ratingType": { "type": "string", "description": "Rating category used for billing and charging." }, "serviceType": { "type": "string", "description": "Line-of-business service type (for example, wireless, fiber, or U-verse)." }, "targetSOR": { "type": "string", "description": "Target SOR (System of Record) for this account." }, "subscribersCount": { "type": "string", "description": "Number of subscribers linked to the account, represented as a source string." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the account record was created." }, "lastModified": { "type": "string", "format": "date-time", "description": "Timestamp when the account record was last modified." }, "openDate": { "type": "string", "format": "date-time", "description": "Date and time when the account became active." }, "billingMarket": { "type": "string", "description": "Billing market code for the account." }, "billingSubMarket": { "type": "string", "description": "Billing submarket code for the account." }, "accountLocked": { "type": "string", "description": "Indicates whether the account is locked and, if applicable, the lock state." }, "state": { "type": "object", "description": "Lifecycle state information for the account.", "properties": { "state": { "type": "string", "description": "Current lifecycle state value." }, "stateChangeReason": { "type": "array", "description": "History of reasons associated with account state transitions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reason name." }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the reason was recorded." }, "description": { "type": "string", "description": "Reason description." }, "activity": { "type": "string", "description": "Associated activity that triggered the state change." } }, "additionalProperties": true } } }, "additionalProperties": true }, "isDigitalAccount": { "type": "boolean", "description": "Indicates whether this account is marked as digital." }, "languagePreference": { "type": "string", "description": "Preferred language for account communications." }, "smbContactInfo": { "type": "object", "description": "SMB (Small and Medium Business) contact details.", "additionalProperties": true }, "subscribers": { "description": "List of subscribers associated with this account.", "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } } } }, "PartnerServiceError": { "type": "object", "properties": { "errorId": { "type": "string", "example": "Top level error code" }, "message": { "type": "string", "example": "Top level error message" }, "errorSystemId": { "type": "string", "example": "System name" }, "details": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "Detail code 1" }, "message": { "type": "string", "example": "Detail message 1" } } } } } }, "WrappedPartnerServiceError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/PartnerServiceError" } } } }, "parameters": { "ParameterAppname": { "name": "appname", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Application name making the request" } } } }