{ "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" }, "examples": { "searchFiberSMBCustomerByAccountIdAndServiceType": { "summary": "Search fiber smb customer by account ID and service type", "x-tags": [ "Fiber-Provide-Business", "Fiber-Change-Business" ], "value": { "accountId": "124865774", "serviceType": "FIBER", "pageSize": 5, "pageOffset": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSearchResponse" }, "examples": { "fibersmbcustomerAuthenticatedResponse": { "summary": "Fiber smb customer search response with all individual fields", "x-tags": [ "Fiber-Provide-Business", "Fiber-Change-Business" ], "value": { "totalCount": 1, "pageInfo": { "pageSize": 5, "pageOffset": 1 }, "individuals": [ { "id": "1f7041b5-de51-400a-b3fa-a5046f71665f", "givenName": "Travis", "familyName": "Widman", "status": "ACTIVE", "createdOn": "2013-02-14 14:28:09", "updatedOn": "2013-02-14 14:28:09", "accounts": [ { "id": "124865774", "givenName": "Travis", "familyName": "Widman", "accountType": "Consumer", "accountSubType": "Consumer Small Office", "serviceType": "UVERSE", "targetSOR": "LS-CRM-DB", "createdOn": "2013-02-14 14:28:09", "isDigitalAccount": false, "languagePreference": "English", "state": { "state": "O", "stateChangeReason": [ { "name": "DR" } ] }, "subscribers": [ { "id": "124865774", "products": [ { "productOfferingTypeGroup": "Equipment", "id": "104340", "isBundle": false, "productOfferingClassification": "customerOffer", "rootProductId": "17766100350", "name": "Network Access Device", "status": { "status": "Active" }, "productCharacteristic": [ { "name": "EQUIPMENT_TYPE", "value": "RG" }, { "name": "EQUIPMENT_ATTR_DESC", "value": "Network Access Device needed for all types of products." }, { "name": "equipmentTypeCode", "value": "RG" }, { "name": "isReceiver", "value": "false" }, { "name": "isDVR", "value": "false" }, { "name": "isHD", "value": "false" }, { "name": "productType", "value": "PLST" }, { "name": "manufacturer", "value": "Humax" }, { "name": "modelNumber", "value": "BGW320-500" }, { "name": "isRecoverable", "value": "true" } ] }, { "productOfferingTypeGroup": "UMC", "id": "2000001", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088458", "productCode": "UMC", "status": { "status": "Active" }, "productCharacteristic": [ { "name": "thirdPartyFulfillmentIndicator", "value": "N" }, { "name": "ADPI_Status", "value": "NA" }, { "name": "ACSBundleBroken", "value": "NA" }, { "name": "supersedeIndicator", "value": "NA" }, { "name": "SCIndication", "value": "No" }, { "name": "CRMbundleindication", "value": "NA" }, { "name": "tdmExistingInd", "value": "N" }, { "name": "shipmentIndicator", "value": "N" }, { "name": "migrationIndicator", "value": "N" }, { "name": "isETFapplied", "value": "No" }, { "name": "hasPendingGigaPowerOrder", "value": "No" }, { "name": "UverseTVatRisk", "value": "N" }, { "name": "VoiceatRisk", "value": "N" }, { "name": "InternetatRisk", "value": "N" }, { "name": "DTVatRisk", "value": "N" }, { "name": "SDEligibilityIndicator", "value": "No" }, { "name": "WirelessatRisk", "value": "N" }, { "name": "inRegionInd", "value": "Y" }, { "name": "ABFIndicator", "value": "false" }, { "name": "numberOfWiFiExtendersAssigned", "value": "0" }, { "name": "numberofWiFiExtendersunderwarranty", "value": "0" }, { "name": "unifyDeunifyIndicator", "value": "NA" }, { "name": "BundleBreakageCauseNew", "value": "NA" }, { "name": "FBDIndicator", "value": "N" }, { "name": "inventoryComponentType", "value": "UMC" }, { "name": "AMSS_LinkInd", "value": "Yahoo_DVR_Link:SDP_Link" }, { "name": "DefaultDisplayOrder", "value": "700" }, { "name": "tosIndicator", "value": "Y" }, { "name": "GVPromoEligibilityIndicator", "value": "N" }, { "name": "managerOverrideInd", "value": "No" }, { "name": "assignedBundleBreakageCause", "value": "NA" }, { "name": "totalBandwidthUpStream", "value": "1010.0" }, { "name": "assignedBundleBreakageReasonCode", "value": "NA" }, { "name": "currentlyUsedBandwidthUpStream", "value": "0.0" }, { "name": "servicesAddedOrUpgraded", "value": "true" }, { "name": "lastUpgradeDate", "value": "2022-09-16T12:23:41" }, { "name": "isPackageValid", "value": "NA" }, { "name": "contractStatus", "value": "NA" }, { "name": "customerPaidADPI", "value": "0" }, { "name": "availableBandwidthUpStream", "value": "1009.99" } ] }, { "productOfferingTypeGroup": "QUEST", "id": "2002941", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088626", "productCode": "QHSIA", "status": { "status": "Active" }, "productCharacteristic": [ { "name": "EligibleForBundleDiscount", "value": "N" }, { "name": "DefaultDisplayOrder", "value": "1800" }, { "name": "AMSS_eDSP", "value": "0" }, { "name": "wasTTForced", "value": "N" }, { "name": "AMSS_LinkInd", "value": "No_Link" } ] }, { "productOfferingTypeGroup": "PLST", "id": "104338", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088518", "productCode": "PLSTECH", "status": { "status": "Active" }, "price": [ { "priceType": "PR", "name": "Residential Gateway", "id": "32243" } ], "productCharacteristic": [ { "name": "moveIndicator", "value": "NA" }, { "name": "reUseDSLMemID", "value": "NA" }, { "name": "isNewCoExists", "value": "No" }, { "name": "DefaultDisplayOrder", "value": "800" }, { "name": "POTSLineInd1", "value": "No" }, { "name": "inventoryComponentType", "value": "PLS" }, { "name": "POTSLineInd2", "value": "No" }, { "name": "LSCircuitId", "value": "A9/MCXX/096880//LB" }, { "name": "fttxConversionIndicator", "value": "N" }, { "name": "dSLSearchBy", "value": "DMID" } ] }, { "productOfferingTypeGroup": "ACCS", "id": "6110425", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088506", "productCode": "Accessories", "status": { "status": "Active" }, "productCharacteristic": [ { "name": "moveIndicator", "value": "NA" } ] }, { "productOfferingTypeGroup": "FL", "id": "2000000", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088482", "productCode": "FreedomLink", "status": { "status": "Active" }, "productCharacteristic": [ { "name": "inventoryComponentType", "value": "WiFi" }, { "name": "EligibleForBundleDiscount", "value": "N" }, { "name": "moveIndicator", "value": "NA" }, { "name": "DefaultDisplayOrder", "value": "900" } ] }, { "productOfferingTypeGroup": "RG", "id": "104340", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088518", "productOfferingId": "17766100350", "name": "Network Access Device", "productCode": "RG", "status": { "status": "Active" }, "price": [ { "priceType": "AD", "name": "AT&T Internet Equipment Fee", "id": "846356" } ], "productCharacteristic": [ { "name": "RMA", "value": "Y" }, { "name": "nadType", "value": "UVRG-X" }, { "name": "amssRefresh", "value": "No" }, { "name": "shipmentType", "value": "NotApplicable" }, { "name": "fulfillmentIndicator", "value": "Yes" }, { "name": "numAtaPorts", "value": "2" }, { "name": "shippingIndicator", "value": "Tech" }, { "name": "internalWAPIndicator", "value": "No" }, { "name": "forceNADSwap", "value": "No" }, { "name": "easyMeshIndicator", "value": "false" }, { "name": "recordOnly", "value": "N" }, { "name": "materialCode", "value": "200006871" }, { "name": "reShipReason", "value": "NA" }, { "name": "actualMaterialDescription", "value": "HSI NOK BGW320MP 505" }, { "name": "rgId", "value": "A9/MCXX/096880//LB" } ] }, { "productOfferingTypeGroup": "HSIA", "id": "2000466", "isBundle": false, "productOfferingClassification": "Product", "rootProductId": "17766088458", "productOfferingId": "17766088566", "name": "AT&T Internet", "productCode": "HSIA", "status": { "status": "Active" }, "price": [ { "priceType": "AD", "id": "32231" }, { "priceType": "PR", "name": "Broadband Access", "id": "33311" }, { "priceType": "AD", "id": "89032753" } ], "productCharacteristic": [ { "name": "DDTier", "value": "NA" }, { "name": "eITier", "value": "NA" }, { "name": "flatRateConnectivity", "value": "N" }, { "name": "waiveWifiEXTInstallFee", "value": "N" }, { "name": "action_type", "value": "O" }, { "name": "IPDSLAMInterceptRedirect", "value": "N" }, { "name": "originalInstallationType", "value": "Tech" }, { "name": "AMSSDefaultInd", "value": "No" }, { "name": "EligibleForBundleDiscount", "value": "Y" }, { "name": "moveIndicator", "value": "NA" }, { "name": "RLC_Action type", "value": "O" }, { "name": "exemptionReasonCode", "value": "NA" }, { "name": "walledGarden", "value": "No" }, { "name": "eDSP", "value": "0" }, { "name": "internetPreference", "value": "NA" }, { "name": "provisionedWiFiExtenders", "value": "0" }, { "name": "numberOfWiFiExtenders", "value": "0" }, { "name": "wasTTForced", "value": "N" }, { "name": "recordOnly", "value": "N" }, { "name": "reShipInd", "value": "N" }, { "name": "inventoryComponentType", "value": "HSIA" }, { "name": "materialCode", "value": "100000290" }, { "name": "AMSS_LinkInd", "value": "No_Link" }, { "name": "DefaultDisplayOrder", "value": "200" }, { "name": "flatRatePlanName", "value": "NA" }, { "name": "componentBandwidthMinUpStream", "value": "0.01" }, { "name": "PSnameTemp", "value": "NA" }, { "name": "NPCRFAMATCode", "value": "NA" }, { "name": "reShipReason", "value": "NA" }, { "name": "eDDInd", "value": "N" }, { "name": "speedMB", "value": "6 Mbps Elite" }, { "name": "EDSPpromo", "value": "NA" } ] } ] } ] } ] } ] } } } } } }, "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" }, "updatedOn": { "type": "string" }, "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, "properties": { "status": { "type": "string", "description": "Current lifecycle state value." }, "statusCode": { "type": "string", "description": "Product status code." }, "statusChangeReason": { "type": "array", "description": "History of reasons associated with product 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 } } } }, "place": { "type": "array", "description": "Places associated with the product.", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Unique place identifier." }, "name": { "type": "string", "description": "Place name." }, "role": { "type": "string", "description": "Place role." } } } }, "productCharacteristic": { "type": "array", "description": "Characteristics associated with the product.", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Characteristic name." }, "value": { "type": "string", "description": "Characteristic value." } } } } }, "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": { "status": { "type": "string", "description": "Current lifecycle state value." }, "statusChangeReason": { "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." }, "autoBillPayIndicator": { "type": "string", "description": "Indicates the auto-bill pay status of the account." }, "bill": { "type": "object", "description": "Billing information for the account.", "properties": { "billStructure": { "type": "object", "description": "Structure of the bill including presentation and cycle details.", "properties": { "presentationMedia": { "type": "object", "description": "Presentation media for the bill.", "properties": { "name": { "type": "string", "description": "Name of the presentation media (e.g., paperless)." } } }, "cycleSpecification": { "type": "object", "description": "Billing cycle specification details.", "properties": { "id": { "type": "string", "description": "Identifier of the billing cycle specification." }, "name": { "type": "string", "description": "Name of the billing cycle specification." }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (e.g., month)." } } } } }, "billCycleStartDay": { "type": "string", "description": "Day of the month when the bill cycle starts." }, "billCycleEndDay": { "type": "string", "description": "Day of the month when the bill cycle ends." }, "nextBillCycleStartDay": { "type": "string", "description": "Day of the month when the next bill cycle starts." }, "noOfDaysLeftInCurrentBillCycle": { "type": "string", "description": "Number of days remaining in the current bill cycle." }, "billDueDate": { "type": "string", "description": "Due date for the bill payment." }, "isPaperlessBill": { "type": "string", "description": "Indicates whether the bill is paperless." }, "lastBillCycleEndDate": { "type": "string", "description": "End date of the last bill cycle." }, "lastBillTotalAmount": { "type": "string", "description": "Total amount of the last bill." } } }, "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." } } } } } }, "isDigitalAccount": { "type": "boolean", "description": "Indicates whether this account is marked as digital." }, "languagePreference": { "type": "string", "description": "Preferred language for account communications." }, "smbContact": { "type": "object", "description": "SMB (Small and Medium Business) contact details.", "properties": { "firstName": { "type": "string", "description": "First name of the SMB contact." }, "lastName": { "type": "string", "description": "Last name of the SMB contact." } } }, "extensions": { "type": "object", "description": "Extension attributes for the account.", "properties": { "businessType": { "type": "string", "description": "Business type classification of the account holder." }, "enterpriseType": { "type": "string", "description": "Enterprise type classification of the account." }, "migrationIndicator": { "type": "string", "description": "Indicates the migration status of the account." }, "migrationAccountLock": { "type": "string", "description": "Indicates the migration account lock status." }, "customerSubType": { "type": "string", "description": "Customer sub-type classification." }, "customerType": { "type": "string", "description": "Customer type classification." }, "fiberProvider": { "type": "string", "description": "Fiber service provider name." }, "isEmployee": { "type": "string", "description": "Indicates whether the account holder is an employee." }, "suspensionStatus": { "type": "string", "description": "Current suspension status of the account." }, "voluntarySuspensionStatus": { "type": "string", "description": "Voluntary suspension status of the account." }, "voluntarySuspensionReason": { "type": "string", "description": "Reason for the voluntary suspension." }, "convergedCustomerOption": { "type": "string", "description": "Converged customer option code." }, "convergedCustomerOptionDisplay": { "type": "string", "description": "Display value for the converged customer option." }, "wirelessAccountLock": { "type": "string", "description": "Indicates the wireless account lock status." }, "walUpdatedBy": { "type": "string", "description": "Identifier of who last updated the wireless account lock." }, "unifiedBan": { "type": "string", "description": "Unified billing account number." }, "uverseCombinedBillBan": { "type": "string", "description": "U-verse combined bill billing account number." }, "digitalCustomer": { "type": "string", "description": "Indicates whether the customer is a digital customer." }, "instantHSIAOnIndicator": { "type": "string", "description": "Indicates whether instant HSIA (High Speed Internet Access) is enabled." } } }, "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" } } } }