{ "info": { "title": "ATT APIs based on TMF622(v4.0.0) - ProductOrder - ResellerMobileLine", "version": "4.0.0", "description": "The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market. \n\nThe product order references the product offer and identifies any specific requests made by the customer." }, "paths": { "/productOrder": { "post": { "summary": "Activate Subscriber Reseller", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_ResellerMobileLineResponse" }, "example": { "id": "400e5b64-130d-479a-8e50-146ea334d798", "@type": "ResellerMobileLineResponse", "state": "acknowledged", "@baseType": "ProductOrder", "@schemaLocation": "tbd", "productOrderItem": [ { "id": "01", "action": "add", "@baseType": "ProductOrderItem", "@schemaLocation": "string", "@type": "ResellerMobileLineItem", "product": { "id": "product-d472890c-16d3-4237-8afd-d7f35d35fb1b", "description": "", "startDate": "2023-10-20T03:37:30.663Z", "subscriberNumber": "7064297756", "agreement": [ { "id": "agreement-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "AgreementItemRef", "@schemaLocation": "string", "@type": "ResellerAgreement", "contractTerm": { "startDate": "2023-10-20T03:37:30.662Z", "term": 10, "commission": { "id": "commission-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerCommissionInfo", "DualCommission": { "creditCheckAgent": "cca", "creditCheckAgentLocation": "cc-loc" }, "billingTelephoneNumber": "1111111111", "customerCode": "str", "dealer": { "id": "dealer-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerInfo", "code": "03", "secondaryCode": "04" }, "location": "NJ", "salesRepresentative": "John Doe", "affiliateSalesRepCode": "01" }, "tAndCIndicator": "N", "commitStartDate": "2023-11-03T03:37:30.662Z" }, "termsConditionsStatus": "N", "prePaid": { "prePaidPin": "1234" }, "waiveActivationFeeReasonCode": "string", "suspendImmediately": false } ], "productPrice": [ { "priceType": "", "recurringChargePeriod": "", "unitOfMeasure": "", "price": {}, "@baseType": "ProductPrice", "@schemaLocation": "tbd", "@type": "ResellerPrice", "pricePlan": { "groupPlanOrSingleUserChoice": { "groupPlanDetails": { "groupPlanCode": "code", "primarySubscriber": "true", "referenceSubscriberOrGroupIdChoice": { "referenceSubscriber": "0000000000", "groupId": "01" }, "lineLimitation": 0, "additionalLineCharge": "0" }, "singleUserCode": "0" }, "recurringCharge": "", "description": "description", "pricePlanAttributes": [ { "attributeName": "exName", "attributeValue": "exValue" } ], "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "technologyType": "GSM", "promotionCode": "0", "cbDiscount": 100, "cbBundeledDiscount": 100, "restrictedSubMarkets": [ { "code": "", "description": "desc" } ], "commission": { "id": "place-d472890c-16d3-4237-8afd-d7f35d35fb1b", "href": "href", "name": "name", "role": "role", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerCommissionInfo", "DualCommission": { "creditCheckAgent": "cca", "creditCheckAgentLocation": "cc-loc" }, "billingTelephoneNumber": "0000000000", "customerCode": "01", "dealer": { "id": "dealer-d472890c-16d3-4237-8afd-d7f35d35fb1b", "href": "href", "name": "name", "role": "role", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerInfo", "code": "01", "secondaryCode": "01" }, "location": "string", "salesRepresentative": "string", "affiliateSalesRepCode": "string" }, "actionCode": "", "originalRatePlanMRC": "", "originalRatePlanCode": "", "offeringNetworkType": "", "parkPpIndicator": "", "term": 0 } } ], "productTerm": [ { "@baseType": "ProductTerm", "@schemaLocation": "tbd", "@type": "ResellerTerm", "activationDate": "2023-11-03T03:37:30.663Z" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string", "baseConfiguration": [ { "action": "A", "offeringCode": "string", "offeringName": "string", "offeringDescription": "string", "offeringFeatures": [ { "featureCode": "string", "featureDescription": "string", "dataUsageCategory": "GPRS" } ], "valueAddedParameters": { "voiceMailParameters": { "forwardNumber": "0000000000", "language": "string", "pin": 1234, "mailBox": "string" }, "auxilliaryServiceParameters": { "associatedSubscriberNumber": "0000000000", "serviceArea": "string", "service": "string", "ldc": "str" }, "emailParameters": { "domain": "string", "boxName": "string" }, "vvpnParameters": { "companyName": "string", "userGroup": "string", "dialingCode": "string" }, "pdpParameters": { "pdpName": "string", "sequence": { "ipAddress": "string", "companyOwnedIp": false, "ipV6Address": "string" }, "context": "string", "lteIndicator": 0, "defaultApnIndicator": false, "accessPointName": "string", "ocsIndicator": false }, "voiceActivatedDialingParameters": { "language": "string", "sequence": { "share": 0, "telephoneNumber": "string" }, "numberExists": "string" }, "m2xParameters": { "telephoneNumber": "string" }, "productAttributes": [ { "attributeName": "string", "attributeValue": "string" } ], "macAddressParameters": { "macAddress": "string" }, "dispatchParameters": { "telephoneNumber": "string" }, "priorityAccessServiceParameters": { "priorityLevel": "string", "specialHandling": "string" }, "wwifParameters": { "salesCode": "string", "forwardNumber": "0000000000", "pin": "1234", "mailBox": "string" }, "unifiedMessagingParameters": { "mailBoxNumber": "string", "voiceMailAccessNumber": "string", "callForwardNumber": "string" }, "manifestUrlParameters": { "manifestUrl": "string" }, "mappingCtnParameters": { "mappingCtn": "string" }, "switchDetails": { "featureCode": "string", "switchParameter": [ { "switchParameterName": "string", "switchSetting": "string" } ] }, "vQosSpecialParameters": { "url": "string", "enterpriseId": "string", "label": "string" } }, "splitLiability": { "targetAccountNumber": "000000000000" }, "genAttribute": "string", "productCategoryIndicator": 0, "productIMSIndicator": "0", "category": "string", "offeringLevel": "G", "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "networkType": "string", "discountedFeaturePlanIndicator": "string", "dataOnlyIndicator": "string", "payPerUseIndicator": "string", "fanMACDiscount": "string", "fanMSCDiscount": "string", "blsIndicator": "string", "socDescription": "string", "parkSocIndicator": false } ], "additionalConfiguration": [ { "action": "A", "offeringCode": "string", "offeringType": "string", "offeringDescription": "string", "commission": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string", "DualCommission": { "creditCheckAgent": "string", "creditCheckAgentLocation": "string" }, "billingTelephoneNumber": "1111111111", "customerCode": "str", "dealer": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string", "code": "string", "secondaryCode": "string" }, "location": "string", "salesRepresentative": "string", "affiliateSalesRepCode": "string" }, "serviceType": "string", "offeringFeatures": [ { "featureCode": "string", "featureDescription": "string", "dataUsageCategory": "GPRS" } ], "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "oneTimeCharge": "string", "valueAddedParameters": { "voiceMailParameters": { "forwardNumber": "0000000000", "language": "string", "pin": 1234, "mailBox": "string" }, "auxilliaryServiceParameters": { "associatedSubscriberNumber": "0000000000", "serviceArea": "string", "service": "string", "ldc": "str" }, "emailParameters": { "domain": "string", "boxName": "string" }, "vvpnParameters": { "companyName": "string", "userGroup": "string", "dialingCode": "string" }, "pdpParameters": { "pdpName": "string", "sequence": { "ipAddress": "string", "companyOwnedIp": false, "ipV6Address": "string" }, "context": "string", "lteIndicator": 0, "defaultApnIndicator": false, "accessPointName": "string", "ocsIndicator": false }, "voiceActivatedDialingParameters": { "language": "string", "sequence": { "share": 0, "telephoneNumber": "string" }, "numberExists": "string" }, "m2xParameters": { "telephoneNumber": "string" }, "productAttributes": [ { "attributeName": "string", "attributeValue": "string" } ], "macAddressParameters": { "macAddress": "string" }, "dispatchParameters": { "telephoneNumber": "string" }, "priorityAccessServiceParameters": { "priorityLevel": "string", "specialHandling": "string" }, "wwifParameters": { "salesCode": "string", "forwardNumber": "string", "pin": "1234", "mailBox": "string" }, "unifiedMessagingParameters": { "mailBoxNumber": "string", "voiceMailAccessNumber": "string", "callForwardNumber": "string" }, "manifestUrlParameters": { "manifestUrl": "string" }, "mappingCtnParameters": { "mappingCtn": "string" }, "switchDetails": { "featureCode": "string", "switchParameter": [ { "switchParameterName": "string", "switchSetting": "string" } ] }, "vQosSpecialParameters": { "url": "string", "enterpriseId": "string", "label": "string" } }, "appId": [ "string" ], "splitLiability": { "targetAccountNumber": "000000000000" }, "integrationFeatureIndicator": false, "transferFeatureIndicator": false, "switchParameters": { "salesCode": "string", "callForwardNumber": "string", "mailboxNumber": "string", "voicemailAccessNumber": "string" }, "offerType": "string", "sharedDataGroup": { "groupDetailsChoice": { "groupReferenceChoice": { "dataGroupId": "string", "subscriberNumber": "0000000000" }, "createDataGroupIndicator": "string" } }, "primarySharedDataPlanIndicator": false, "socMode": "string", "socSalesExpDate": "2023-10-20T03:37:30.662Z", "crossMarketIndicator": false, "mobileSessionData": { "sessionId": "string", "sessionStatus": "string", "sessionStatusReasonCode": "string", "sessionStatusReasonDescription": "string", "sessionDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" } }, "socOrderId": "string", "autoRenewIndicator": "string", "sequenceNumber": "string", "switchCode": "string", "offeringLevel": "G", "category": "string", "hasIntegratedMessaging": false, "macAddress": "string", "promotionEndDate": "2023-10-27T17:57:48.140Z", "usagePooling": { "type": "string", "profile": "string" }, "turboSessionPaymentMethod": "string", "parkSocIndicator": false, "referenceSoc": "string", "parkIndicator": "string" } ], "line": { "equipmentType": "C", "technologyType": "GSM", "imsi": "string", "imei": "string", "imeiType": "string", "imeiFrequency": "string", "sim": "001004234814455936F", "esn": "string", "msid": "string", "min": "string", "manufacturer": { "marketingName": "string", "make": "string", "model": "string" }, "umtsCapability": "string", "imeiDeviceFirmware": { "softwareVersionNumber": "string", "osType": "string", "osVersion": "string", "networkActivityDateTime": "2023-10-20T03:37:30.662Z" }, "smsCapabilityIndicator": "string", "sku": "string", "dcapValue": "st", "osType": "string", "osVersion": "string", "imeiSofwareVersion": "string", "deviceCertificationStatus": "string", "eidDataIndicator": "True", "simStatus": "A" }, "subscriberStatus": "pendingActive", "status": "pendingActive" }, "portingLocator": { "portRequestNumber": "0000", "portRequestVersion": "12", "teleportPortRecordId": "01" }, "state": "acknowledged" } ], "marketServiceInfo": { "id": "market-d472890c-16d3-4237-8afd-d7f35d35fb1b", "role": "MarketServiceArea", "storeId": "", "localMarket": "lmt", "serviceArea": "", "billingMarket": "GAC", "serviceZipCode": "07728", "billingSystemId": "", "billingSubMarket": "708" } } } }, "description": "Acknowledgement" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Forbidden" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-ClientId" } ], "x-page-slug": "activate-subscriber-reseller", "description": "This service enables the client to activate a pending device that was added through some of the order equipment flows or a device that the customer already has. (TMF 622)", "operationId": "productOrder", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineCreate" } ], "description": "The information regarding the activation." }, "example": { "@type": "ResellerMobileLineCreate", "@baseType": "ProductOrder_Create", "@schemaLocation": "tbd", "productOrderItem": [ { "id": "01", "action": "add", "@baseType": "ProductOrderItem", "@schemaLocation": "tbd", "@type": "ResellerMobileLineItem", "product": { "id": "product-d472890c-16d3-4237-8afd-d7f35d35fb1b", "description": "", "startDate": "2023-10-20T03:37:30.663Z", "subscriberNumber": "7064297756", "agreement": [ { "id": "agreement-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "AgreementItemRef", "@schemaLocation": "string", "@type": "ResellerAgreement", "contractTerm": { "startDate": "2023-10-20T03:37:30.662Z", "term": 10, "commission": { "id": "commission-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerCommissionInfo", "DualCommission": { "creditCheckAgent": "cca", "creditCheckAgentLocation": "cc-loc" }, "billingTelephoneNumber": "1111111111", "customerCode": "str", "dealer": { "id": "dealer-d472890c-16d3-4237-8afd-d7f35d35fb1b", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerInfo", "code": "03", "secondaryCode": "04" }, "location": "NJ", "salesRepresentative": "John Doe", "affiliateSalesRepCode": "01" }, "tAndCIndicator": "N", "commitStartDate": "2023-11-03T03:37:30.662Z" }, "termsConditionsStatus": "N", "prePaid": { "prePaidPin": "1234" }, "waiveActivationFeeReasonCode": "string", "suspendImmediately": false } ], "productPrice": [ { "priceType": "", "recurringChargePeriod": "", "unitOfMeasure": "", "price": {}, "@baseType": "ProductPrice", "@schemaLocation": "tbd", "@type": "ResellerPrice", "pricePlan": { "groupPlanOrSingleUserChoice": { "groupPlanDetails": { "groupPlanCode": "code", "primarySubscriber": "true", "referenceSubscriberOrGroupIdChoice": { "referenceSubscriber": "0000000000", "groupId": "01" }, "lineLimitation": 0, "additionalLineCharge": "0" }, "singleUserCode": "0" }, "recurringCharge": "", "description": "description", "pricePlanAttributes": [ { "attributeName": "exName", "attributeValue": "exValue" } ], "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "technologyType": "GSM", "promotionCode": "0", "cbDiscount": 100, "cbBundeledDiscount": 100, "restrictedSubMarkets": [ { "code": "", "description": "desc" } ], "commission": { "id": "place-d472890c-16d3-4237-8afd-d7f35d35fb1b", "href": "href", "name": "name", "role": "role", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerCommissionInfo", "DualCommission": { "creditCheckAgent": "cca", "creditCheckAgentLocation": "cc-loc" }, "billingTelephoneNumber": "0000000000", "customerCode": "01", "dealer": { "id": "dealer-d472890c-16d3-4237-8afd-d7f35d35fb1b", "href": "href", "name": "name", "role": "role", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerInfo", "code": "01", "secondaryCode": "01" }, "location": "string", "salesRepresentative": "string", "affiliateSalesRepCode": "string" }, "actionCode": "", "originalRatePlanMRC": "", "originalRatePlanCode": "", "offeringNetworkType": "", "parkPpIndicator": "", "term": 0 } } ], "productTerm": [ { "@baseType": "ProductTerm", "@schemaLocation": "tbd", "@type": "ResellerTerm", "activationDate": "2023-11-03T03:37:30.663Z" } ], "@baseType": "ProductRefOrValue", "@schemaLocation": "tbd", "@type": "ResellerMobileLineProduct", "baseConfiguration": [ { "action": "A", "offeringCode": "string", "offeringName": "string", "offeringDescription": "string", "offeringFeatures": [ { "featureCode": "string", "featureDescription": "string", "dataUsageCategory": "GPRS" } ], "valueAddedParameters": { "voiceMailParameters": { "forwardNumber": "0000000000", "language": "string", "pin": 1234, "mailBox": "string" }, "auxilliaryServiceParameters": { "associatedSubscriberNumber": "0000000000", "serviceArea": "string", "service": "string", "ldc": "str" }, "emailParameters": { "domain": "string", "boxName": "string" }, "vvpnParameters": { "companyName": "string", "userGroup": "string", "dialingCode": "string" }, "pdpParameters": { "pdpName": "string", "sequence": { "ipAddress": "string", "companyOwnedIp": false, "ipV6Address": "string" }, "context": "string", "lteIndicator": 0, "defaultApnIndicator": false, "accessPointName": "string", "ocsIndicator": false }, "voiceActivatedDialingParameters": { "language": "string", "sequence": { "share": 0, "telephoneNumber": "string" }, "numberExists": "string" }, "m2xParameters": { "telephoneNumber": "string" }, "productAttributes": [ { "attributeName": "string", "attributeValue": "string" } ], "macAddressParameters": { "macAddress": "string" }, "dispatchParameters": { "telephoneNumber": "string" }, "priorityAccessServiceParameters": { "priorityLevel": "string", "specialHandling": "string" }, "wwifParameters": { "salesCode": "string", "forwardNumber": "0000000000", "pin": "1234", "mailBox": "string" }, "unifiedMessagingParameters": { "mailBoxNumber": "string", "voiceMailAccessNumber": "string", "callForwardNumber": "string" }, "manifestUrlParameters": { "manifestUrl": "string" }, "mappingCtnParameters": { "mappingCtn": "string" }, "switchDetails": { "featureCode": "string", "switchParameter": [ { "switchParameterName": "string", "switchSetting": "string" } ] }, "vQosSpecialParameters": { "url": "string", "enterpriseId": "string", "label": "string" } }, "splitLiability": { "targetAccountNumber": "000000000000" }, "genAttribute": "string", "productCategoryIndicator": 0, "productIMSIndicator": "0", "category": "string", "offeringLevel": "G", "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "networkType": "string", "discountedFeaturePlanIndicator": "string", "dataOnlyIndicator": "string", "payPerUseIndicator": "string", "fanMACDiscount": "string", "fanMSCDiscount": "string", "blsIndicator": "string", "socDescription": "string", "parkSocIndicator": false } ], "additionalConfiguration": [ { "action": "A", "offeringCode": "string", "offeringType": "string", "offeringDescription": "string", "commission": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerCommissionInfo", "DualCommission": { "creditCheckAgent": "string", "creditCheckAgentLocation": "string" }, "billingTelephoneNumber": "1111111111", "customerCode": "str", "dealer": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "RelatedParty", "@schemaLocation": "tbd", "@referredType": "DealerInfo", "code": "string", "secondaryCode": "string" }, "location": "string", "salesRepresentative": "string", "affiliateSalesRepCode": "string" }, "serviceType": "string", "offeringFeatures": [ { "featureCode": "string", "featureDescription": "string", "dataUsageCategory": "GPRS" } ], "effectiveDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" }, "oneTimeCharge": "string", "valueAddedParameters": { "voiceMailParameters": { "forwardNumber": "0000000000", "language": "string", "pin": 1234, "mailBox": "string" }, "auxilliaryServiceParameters": { "associatedSubscriberNumber": "0000000000", "serviceArea": "string", "service": "string", "ldc": "str" }, "emailParameters": { "domain": "string", "boxName": "string" }, "vvpnParameters": { "companyName": "string", "userGroup": "string", "dialingCode": "string" }, "pdpParameters": { "pdpName": "string", "sequence": { "ipAddress": "string", "companyOwnedIp": false, "ipV6Address": "string" }, "context": "string", "lteIndicator": 0, "defaultApnIndicator": false, "accessPointName": "string", "ocsIndicator": false }, "voiceActivatedDialingParameters": { "language": "string", "sequence": { "share": 0, "telephoneNumber": "string" }, "numberExists": "string" }, "m2xParameters": { "telephoneNumber": "string" }, "productAttributes": [ { "attributeName": "string", "attributeValue": "string" } ], "macAddressParameters": { "macAddress": "string" }, "dispatchParameters": { "telephoneNumber": "string" }, "priorityAccessServiceParameters": { "priorityLevel": "string", "specialHandling": "string" }, "wwifParameters": { "salesCode": "string", "forwardNumber": "string", "pin": "1234", "mailBox": "string" }, "unifiedMessagingParameters": { "mailBoxNumber": "string", "voiceMailAccessNumber": "string", "callForwardNumber": "string" }, "manifestUrlParameters": { "manifestUrl": "string" }, "mappingCtnParameters": { "mappingCtn": "string" }, "switchDetails": { "featureCode": "string", "switchParameter": [ { "switchParameterName": "string", "switchSetting": "string" } ] }, "vQosSpecialParameters": { "url": "string", "enterpriseId": "string", "label": "string" } }, "appId": [ "string" ], "splitLiability": { "targetAccountNumber": "000000000000" }, "integrationFeatureIndicator": false, "transferFeatureIndicator": false, "switchParameters": { "salesCode": "string", "callForwardNumber": "string", "mailboxNumber": "string", "voicemailAccessNumber": "string" }, "offerType": "string", "sharedDataGroup": { "groupDetailsChoice": { "groupReferenceChoice": { "dataGroupId": "string", "subscriberNumber": "0000000000" }, "createDataGroupIndicator": "string" } }, "primarySharedDataPlanIndicator": false, "socMode": "string", "socSalesExpDate": "2023-10-20T03:37:30.662Z", "crossMarketIndicator": false, "mobileSessionData": { "sessionId": "string", "sessionStatus": "string", "sessionStatusReasonCode": "string", "sessionStatusReasonDescription": "string", "sessionDates": { "effectiveDate": "2023-10-27T17:57:48.140Z", "expirationDate": "2023-10-27T17:57:48.140Z" } }, "socOrderId": "string", "autoRenewIndicator": "string", "sequenceNumber": "string", "switchCode": "string", "offeringLevel": "G", "category": "string", "hasIntegratedMessaging": false, "macAddress": "string", "promotionEndDate": "2023-10-27T17:57:48.140Z", "usagePooling": { "type": "string", "profile": "string" }, "turboSessionPaymentMethod": "string", "parkSocIndicator": false, "referenceSoc": "string", "parkIndicator": "string" } ], "line": { "equipmentType": "C", "technologyType": "GSM", "imsi": "string", "imei": "string", "imeiType": "string", "imeiFrequency": "string", "sim": "001004234814455936F", "esn": "string", "msid": "string", "min": "string", "manufacturer": { "marketingName": "string", "make": "string", "model": "string" }, "umtsCapability": "string", "imeiDeviceFirmware": { "softwareVersionNumber": "string", "osType": "string", "osVersion": "string", "networkActivityDateTime": "2023-10-20T03:37:30.662Z" }, "smsCapabilityIndicator": "string", "sku": "string", "dcapValue": "st", "osType": "string", "osVersion": "string", "imeiSofwareVersion": "string", "deviceCertificationStatus": "string", "eidDataIndicator": "True", "simStatus": "A" } }, "portingLocator": { "portRequestNumber": "0000", "portRequestVersion": "12", "teleportPortRecordId": "01" } } ], "marketServiceInfo": { "id": "market-d472890c-16d3-4237-8afd-d7f35d35fb1b", "role": "MarketServiceArea", "storeId": "", "localMarket": "lmt", "serviceArea": "", "billingMarket": "GAC", "serviceZipCode": "07728", "billingSystemId": "", "billingSubMarket": "708" } } } }, "required": true, "description": "The information regarding the activation." } } } }, "servers": [ { "url": "https://lgw.att.com/" } ], "openapi": "3.0.3", "components": { "links": {}, "schemas": { "lib_Note": { "type": "object", "title": "Note", "required": [ "text" ], "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" }, "date": { "type": "string", "title": "date", "format": "date-time", "description": "Date of the note" }, "text": { "type": "string", "title": "text", "description": "Text of the note" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "author": { "type": "string", "title": "author", "description": "Author of the note" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Money": { "type": "object", "title": "Money", "properties": { "unit": { "type": "string", "title": "unit", "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" }, "value": { "type": "number", "title": "value", "format": "double", "description": "A positive floating point number" } } }, "lib_Error": { "type": "object", "title": "Error", "required": [ "code", "reason" ], "properties": { "code": { "type": "string", "title": "code", "description": "Application relevant detail, defined in the API or a common list." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user." }, "status": { "type": "string", "title": "status", "description": "HTTP Error code extension" }, "message": { "type": "string", "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class." }, "referenceError": { "type": "string", "title": "referenceError", "description": "URI of documentation describing the error." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Price": { "type": "object", "title": "Price", "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "taxRate": { "type": "number", "title": "taxRate", "format": "double", "description": "Tax rate" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "percentage": { "type": "number", "title": "percentage", "format": "double", "description": "Percentage to apply for ProdOfferPriceAlteration" }, "dutyFreeAmount": { "oneOf": [ { "$ref": "#/components/schemas/lib_Money" } ], "title": "dutyFreeAmount", "description": "A base / value business entity used to represent money" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "taxIncludedAmount": { "oneOf": [ { "$ref": "#/components/schemas/lib_Money" } ], "title": "taxIncludedAmount", "description": "A base / value business entity used to represent money" } } }, "lib_Place": { "type": "object", "title": "Place", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the place" }, "href": { "type": "string", "title": "href", "description": "Unique reference of the place" }, "name": { "type": "string", "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Product": { "type": "object", "title": "Product", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the product" }, "href": { "type": "string", "title": "href", "description": "Reference of the product" }, "name": { "type": "string", "title": "name", "description": "Name of the product. It could be the same as the name of the product offering" }, "place": { "type": "array", "items": {}, "title": "place" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "enum": [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted" ], "title": "status", "description": "Possible values for the status of the product" }, "product": { "type": "array", "items": {}, "title": "product" }, "isBundle": { "type": "boolean", "title": "isBundle", "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." }, "orderDate": { "type": "string", "title": "orderDate", "format": "date-time", "description": "Is the date when the product was ordered" }, "startDate": { "type": "string", "title": "startDate", "format": "date-time", "description": "Is the date from which the product starts" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "Is the description of the product. It could be copied from the description of the Product Offering." }, "productTerm": { "type": "array", "items": {}, "title": "productTerm" }, "productPrice": { "type": "array", "items": {}, "title": "productPrice" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "terminationDate": { "type": "string", "title": "terminationDate", "format": "date-time", "description": "Is the date when the product was terminated" }, "productOffering": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingRef" } ], "title": "productOffering", "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "realizingService": { "type": "array", "items": {}, "title": "realizingService" }, "isCustomerVisible": { "type": "boolean", "title": "isCustomerVisible", "description": "If true, the product is visible by the customer." }, "realizingResource": { "type": "array", "items": {}, "title": "realizingResource" }, "productSerialNumber": { "type": "string", "title": "productSerialNumber", "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." }, "productRelationship": { "type": "array", "items": {}, "title": "productRelationship" }, "productSpecification": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductSpecificationRef" } ], "title": "productSpecification", "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." }, "productCharacteristic": { "type": "array", "items": {}, "title": "productCharacteristic" } } }, "lib_Quantity": { "type": "object", "title": "Quantity", "properties": { "units": { "type": "string", "title": "units", "description": "Unit" }, "amount": { "type": "number", "title": "amount", "format": "double", "default": 1, "description": "Numeric value in a given unit" } } }, "lib_Sequence": { "type": "object", "title": "Sequence", "required": [ "companyOwnedIp" ], "properties": { "ipAddress": { "type": "string", "title": "ipAddress", "description": "Static IP Address" }, "ipV6Address": { "type": "string", "title": "ipV6Address", "description": "Static IP Address" }, "companyOwnedIp": { "type": "boolean", "title": "companyOwnedIp", "description": "Set to true if the pdpName is associated with a Cingular-owned Static IP Address for which monthly recurring charges should be applied; else set to false." } } }, "lib_PlaceRef": { "type": "object", "title": "PlaceRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_NameInfo": { "type": "object", "title": "NameInfo", "required": [ "firstName", "lastName" ], "properties": { "lastName": { "type": "string", "title": "lastName", "description": "Last Name" }, "firstName": { "type": "string", "title": "firstName", "description": "First Name" }, "namePrefix": { "type": "string", "title": "namePrefix", "description": "Name prefix or title (e.g. Dr., Mr., Mrs., etc.)" }, "middleName": { "type": "string", "title": "middleName", "description": "Middle name." }, "nameSuffix": { "type": "string", "title": "nameSuffix", "description": "Name suffix (e.g. Jr. - Junior, Sr. - Senior, etc.)" }, "additionalTitle": { "type": "string", "title": "additionalTitle", "description": "A free text field that holds the additional title of the name (e.g. President, Major, General, etc.)" } } }, "lib_QuoteRef": { "type": "object", "title": "QuoteRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Customer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "businessName": { "title": "businessName", "type": "string", "description": "If this individual is the contact of a business, the name of the business. If this is omitted, individual is not a business contact." }, "familyName": { "title": "familyName", "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "generation": { "title": "generation", "type": "string", "description": "e.g.. Sr, Jr, III (the third),…" }, "givenName": { "title": "givenName", "type": "string", "description": "First name of the individual" }, "middleName": { "title": "middleName", "type": "string", "description": "Middles name or initial" }, "ContactInformation": { "description": "Contact name and ppu address associated with the service area for the subscriber number(s).", "oneOf": [ { "$ref": "#/components/schemas/lib_ContactInformation" } ], "title": "ContactInformation" }, "title": { "title": "title", "type": "string", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." }, "@baseType": { "title": "@baseType", "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "title": "@schemaLocation", "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "title": "@type", "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } } ], "title": "Customer" }, "lib_UnitInfo": { "type": "object", "title": "UnitInfo", "required": [ "unitDesignator", "unitNumber" ], "properties": { "unitNumber": { "type": "string", "title": "unitNumber", "maxLength": 8 }, "unitDesignator": { "type": "string", "enum": [ "APT", "BLDG", "DEPT", "FL", "HNGR", "LOT", "PIER", "RM", "SLIP", "STE", "SPC", "STOP", "TRLR", "UNIT", "BSMT", "FRNT", "OFC", "PH", "REAR", "LOWR", "LBBY", "SIDE", "UPPR", "#" ], "title": "unitDesignator", "description": "APARTMENT -APT, BUILDING -BLDG, DEPARTMENT -DEPT, FLOOR -FL, HANGER -HNGR, LOT -LOT, PIER -PIER, ROOM -RM, SLIP -SLIP, SUITE -STE, STOOP -STOP, TRAILER -TRLR, UNIT -UNIT, BASEMENT -BSMT, FRONT -FRNT, OFFICE -OFC, PENTHOUSE -PH, REAR -REAR, LOWER -LOWR, LOBBY -LBBY, SIDE -SIDE, UPPER-UPPR, SPACE-SPC, #-APT Number" } } }, "lib_EntityRef": { "type": "object", "title": "EntityRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PhoneInfo": { "type": "object", "title": "PhoneInfo", "required": [ "canBeReachedPhone" ], "properties": { "homePhone": { "type": "string", "title": "homePhone", "maxLength": 10, "description": "Home phone" }, "workPhone": { "type": "string", "title": "workPhone", "maxLength": 10, "description": "Work phone" }, "canBeReachedPhone": { "type": "string", "title": "canBeReachedPhone", "maxLength": 10, "description": "Can be reached phone" }, "workPhoneExtension": { "type": "string", "title": "workPhoneExtension", "maxLength": 4, "description": "Work phone extension." } } }, "lib_ErrorInfo": { "type": "object", "title": "ErrorInfo", "required": [ "code" ], "properties": { "code": { "type": "string", "title": "code" }, "description": { "type": "string", "title": "description" } } }, "lib_OrderTerm": { "type": "object", "title": "OrderTerm", "properties": { "name": { "type": "string", "title": "name", "description": "Name of the productOrderTerm" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "duration": { "oneOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "title": "duration", "description": "An amount in a given unit" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "Description of the productOrderTerm" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Sequence1": { "type": "object", "title": "Sequence1", "required": [ "share", "telephoneNumber" ], "properties": { "share": { "type": "number", "title": "share", "description": "The share value." }, "telephoneNumber": { "type": "string", "title": "telephoneNumber", "maxLength": 10, "description": "The telephone number." } } }, "lib_response1": { "type": "object", "title": "response1", "required": [ "reason", "code" ], "properties": { "code": { "type": "string", "title": "code", "description": "Application relevant detail, defined in the API or a common list." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user." }, "status": { "type": "string", "title": "status", "description": "HTTP Error code extension" }, "message": { "type": "string", "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class." }, "referenceError": { "type": "string", "title": "referenceError", "description": "URI of documentation describing the error." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EmailInfo": { "type": "object", "title": "EmailInfo", "required": [ "emailAddress" ], "properties": { "language": { "type": "string", "enum": [ "E", "S", "N", "P", "B", "L", "F", "V", "M", "C", "K", "T", "J" ], "title": "language", "description": "Language Indicator: English Standard = E, Spanish Standard = S, English Prorated = N, Spanish Prorated = P, Braille = B, Large Font = L, French = F, Vietnamese = V, Mandarin = M, Cantonese = C, Korean = K, Tagalong = T, Japanese = J" }, "emailType": { "type": "string", "enum": [ "B", "P", "O" ], "title": "emailType", "description": "Business = B, Personal =P, Other = O" }, "emailAddress": { "type": "string", "title": "emailAddress", "maxLength": 80, "description": "E-mail address" }, "effectiveDate": { "type": "string", "title": "effectiveDate", "pattern": ".+Z", "description": "Designates a date in UTC format. The following formats is accepted: YYYY-MM-DDZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - Z is a fixed character, indicating UTC time zone" }, "bounceIndicator": { "type": "string", "title": "bounceIndicator", "maxLength": 1, "description": "valid values Y, N or null" }, "primaryAddressIndicator": { "type": "boolean", "title": "primaryAddressIndicator", "description": "Email primary address indicator." } } }, "lib_TimePeriod": { "type": "object", "title": "TimePeriod", "properties": { "endDateTime": { "type": "string", "title": "endDateTime", "format": "date-time", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "title": "startDateTime", "format": "date-time", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } } }, "lib_ProductRef": { "type": "object", "title": "ProductRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_DealerInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Primary Dealer (/Agent/Comp) code", "maxLength": 6 }, "secondaryCode": { "title": "secondaryCode", "type": "string", "description": "Secondary Dealer (/Agent/Comp) code. Required in some Cingular markets. Contact Cingular business team for details.", "maxLength": 6 } }, "required": [ "code" ] } ], "title": "DealerInfo" }, "lib_Commission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "dealerCode": { "title": "dealerCode", "type": "string", "maxLength": 6 }, "secondaryCode": { "title": "secondaryCode", "type": "string", "maxLength": 6 }, "location": { "title": "location", "type": "string" }, "salesRepresentative": { "title": "salesRepresentative", "type": "string", "maxLength": 9 }, "creditCheckAgent": { "title": "creditCheckAgent", "type": "string", "minLength": 1, "maxLength": 10 }, "creditCheckAgentLocation": { "title": "creditCheckAgentLocation", "type": "string", "minLength": 1, "maxLength": 10 }, "affiliateSalesRepCode": { "title": "affiliateSalesRepCode", "type": "string", "maxLength": 15 }, "billingTelephoneNumber": { "title": "billingTelephoneNumber", "type": "string", "maxLength": 10 }, "customerCode": { "title": "customerCode", "type": "string", "maxLength": 3 }, "storeId": { "title": "storeId", "type": "string" } } } ], "title": "Commission" }, "lib_DeviceInfo": { "type": "object", "title": "DeviceInfo", "required": [ "equipmentType", "technologyType" ], "properties": { "sim": { "type": "string", "title": "sim", "minLength": 18, "maxLength": 20 }, "esn": { "type": "string", "title": "esn", "maxLength": 11 }, "min": { "type": "string", "title": "min", "maxLength": 10 }, "sku": { "type": "string", "title": "sku", "minLength": 1, "maxLength": 25 }, "imsi": { "type": "string", "title": "imsi", "maxLength": 15 }, "imei": { "type": "string", "title": "imei", "maxLength": 15, "description": "IMEI is a required field when performing Swap of the Cross Upgrade Equipment" }, "msid": { "type": "string", "title": "msid", "maxLength": 15 }, "osType": { "type": "string", "title": "osType", "maxLength": 20 }, "imeiType": { "type": "string", "title": "imeiType", "description": "IMEI type represents specific kind of device. IMEI Type should be provided when an real IMEI number is not known while provisioning rateplans or features." }, "dcapValue": { "type": "string", "title": "dcapValue", "maxLength": 2 }, "osVersion": { "type": "string", "title": "osVersion", "maxLength": 50 }, "simStatus": { "type": "string", "title": "simStatus", "maxLength": 1, "description": "possible values: A-active, E-expire" }, "manufacturer": { "oneOf": [ { "$ref": "#/components/schemas/lib_ManufacturerInfo" } ], "title": "manufacturer", "description": "Manufacturer related identification information" }, "equipmentType": { "type": "string", "enum": [ "C", "G" ], "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)" }, "imeiFrequency": { "type": "string", "title": "imeiFrequency", "description": "Device Frequency 850, 900, 1800, 1900" }, "technologyType": { "type": "string", "enum": [ "GSM", "TDMA", "GSM-GAIT", "GAIT", "TDMA-GAIT", "GSM-UMTS", "UMTS", "LTE" ], "title": "technologyType", "description": "Literal representation of the technology type: GSM = the mobile is homed to a GSM switch but does not have the GAIT feature; GSM-GAIT = the mobile is homed to a GSM switch and has the GAIT feature; GAIT = the mobile is GAIT enabled TDMA = the mobile is homed to a TDMA switch but does not have the GAIT feature; TDMA-GAIT = the mobile is homed to a TDMA switch and has the GAIT feature. GSM-UMTS = the mobile is homed to a GSM switch and has the UMTS feature UMTS = the mobile is UMTS enabled LTE= Long Term Evolution Based on the technology some fields are required for the device ESN is used with Tdma technology based devices or GAIT capable devices SIM is used with GMS technology or UMTS feature based devices IMSI and IMEI is used with GSM technology or UMTS or GAIT capable devices" }, "umtsCapability": { "type": "string", "title": "umtsCapability", "description": "The UMTS Capability of the device" }, "eidDataIndicator": { "type": "string", "title": "eidDataIndicator", "maxLength": 4, "description": "possible values: True" }, "imeiDeviceFirmware": { "$ref": "#/components/schemas/lib_ImeiDeviceFirmwareInfo" }, "imeiSofwareVersion": { "type": "string", "title": "imeiSofwareVersion" }, "smsCapabilityIndicator": { "type": "string", "title": "smsCapabilityIndicator", "description": "The SMS Capability of the device" }, "deviceCertificationStatus": { "type": "string", "title": "deviceCertificationStatus" } } }, "lib_ServiceRef": { "type": "object", "title": "ServiceRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PaymentRef": { "type": "object", "title": "PaymentRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "A name for the payment" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_OrderPrice": { "type": "object", "title": "OrderPrice", "properties": { "name": { "type": "string", "title": "name", "description": "A short descriptive name such as \"Subscription price\"." }, "price": { "oneOf": [ { "$ref": "#/components/schemas/lib_Price" } ], "title": "price", "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "priceType": { "type": "string", "title": "priceType", "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A narrative that explains in detail the semantics of this order item price." }, "unitOfMeasure": { "type": "string", "title": "unitOfMeasure", "description": "Could be minutes, GB..." }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "priceAlteration": { "type": "array", "items": {}, "title": "priceAlteration" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOfferingPrice": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingPriceRef" } ], "title": "productOfferingPrice", "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased" }, "recurringChargePeriod": { "type": "string", "title": "recurringChargePeriod", "description": "Could be month, week..." } } }, "lib_AddressInfo": { "type": "object", "title": "AddressInfo", "properties": { "Zip": { "$ref": "#/components/schemas/lib_AddressZipInfo" }, "Unit": { "$ref": "#/components/schemas/lib_UnitInfo" }, "City": { "type": "string", "title": "City", "maxLength": 40, "description": "The City of this address.Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'." }, "State": { "type": "string", "enum": [ "JA", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "DR", "MB", "MX", "NB", "NF", "NS", "ON", "PE", "PQ", "PR", "SK", "VI", "DF", "NA", "GT", "PU", "YA", "SN", "BA", "AP", "CL", "AA", "BI", "PB", "AG", "BN", "CI", "CP", "CS", "DU", "GJ", "GR", "HD", "HK", "MC", "MR", "NL", "NZ", "OX", "QT", "QR", "SL", "SO", "TA", "TB", "TL", "VE", "YC", "ZA", "ZZ", "AE", "BE", "YT", "AS", "FM", "GM", "MH", "NO", "PL", "UM", "VZ", "CE", "CR", "LM", "TE", "FS", "FN", "CN", "GU", "MP", "PW", "NT", "NU", "QC" ], "title": "State", "description": "State abbreviation" }, "Street": { "$ref": "#/components/schemas/lib_AddressStreetInfo" }, "County": { "$ref": "#/components/schemas/lib_AddressCountyInfo" }, "Country": { "type": "string", "title": "Country", "pattern": "(([A-Z]{2}|[A-Z]{2})|(([A-Z]{2}|[A-Z]{2})|[A-Z]{2}))", "minLength": 2, "maxLength": 2, "description": "International standard (ISO) 2-character country code." }, "Attention": { "type": "string", "title": "Attention", "maxLength": 25 }, "lastUpdate": { "type": "string", "title": "lastUpdate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "RuralRoute": { "$ref": "#/components/schemas/lib_AddressRuralRouteInfo" }, "addressType": { "type": "string", "enum": [ "S", "M", "P", "R", "F" ], "title": "addressType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F" }, "AddressLine1": { "type": "string", "title": "AddressLine1", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "AddressLine2": { "type": "string", "title": "AddressLine2", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "PostOfficeBox": { "type": "string", "title": "PostOfficeBox", "maxLength": 10, "description": "Post Office Box Number." }, "fieldIndicator": { "type": "boolean", "title": "fieldIndicator", "description": "In the request, specifies whether the address validation should take place. If true or not provided, the validation will take place. If false, the validation will be bypassed. In the response, indicates whether the address was reformatted during the validation." }, "addressSubType": { "type": "string", "enum": [ "S", "M", "P", "R", "F" ], "title": "addressSubType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F" }, "UrbanizationCode": { "type": "string", "title": "UrbanizationCode", "maxLength": 30, "description": "An urbanization denotes an area, sector, or residential development within a geographic area. In addition to being a descriptive word, it precedes the name of that area. This descriptor, commonly used in Puerto Rican urban areas, is an important part of the addressing format as it describes the location of a given street." }, "internationalZip": { "type": "string", "title": "internationalZip", "description": "This should be populated when the addressSubType is F Foreign\\International" }, "incorporatedIndicator": { "type": "boolean", "title": "incorporatedIndicator", "description": "Incorporated indicator retrieved from Vertex" }, "ruralAddressAttention": { "type": "string", "title": "ruralAddressAttention", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "internationalAddressLine": { "type": "string", "title": "internationalAddressLine", "maxLength": 255, "description": "International address Line 1 of an International address which includes street number, street name, etc. Required if address subtype is 'F'" } } }, "lib_PrePaidInfo": { "type": "object", "title": "PrePaidInfo", "required": [ "prePaidPin" ], "properties": { "prePaidPin": { "type": "string", "title": "prePaidPin", "description": "PIN number for prepaid accounts." } } }, "lib_ProductTerm": { "type": "object", "title": "ProductTerm", "properties": { "name": { "type": "string", "title": "name", "description": "Name of the productTerm" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "duration": { "oneOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "title": "duration", "description": "An amount in a given unit" }, "validFor": { "oneOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "Description of the productTerm" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_CancelOrder": { "type": "object", "title": "CancelOrder", "properties": { "id": { "type": "string", "title": "id", "description": "id of the cancellation request (this is not an order id)" }, "href": { "type": "string", "title": "href", "description": "Hyperlink to access the cancellation request" }, "state": { "type": "string", "enum": [ "acknowledged", "terminatedWithError", "inProgress", "done" ], "title": "state", "description": "Possible values for the state of a task" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled." }, "effectiveCancellationDate": { "type": "string", "title": "effectiveCancellationDate", "format": "date-time", "description": "Date when the order is cancelled." }, "requestedCancellationDate": { "type": "string", "title": "requestedCancellationDate", "format": "date-time", "description": "Date when the submitter wants the order to be cancelled" } } }, "lib_ResourceRef": { "type": "object", "title": "ResourceRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the resource" }, "value": { "type": "string", "title": "value", "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedParty": { "type": "object", "title": "RelatedParty", "required": [ "id", "@referredType" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "role": { "type": "string", "title": "role", "description": "Role played by the related party" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ProductOrder": { "type": "object", "title": "ProductOrder", "required": [ "productOrderItem" ], "properties": { "id": { "type": "string", "title": "id", "description": "ID created on repository side (OM system)" }, "href": { "type": "string", "title": "href", "description": "Hyperlink to access the order" }, "note": { "type": "array", "items": {}, "title": "note" }, "quote": { "type": "array", "items": {}, "title": "quote" }, "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state", "description": "Possible values for the state of the order" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "channel": { "type": "array", "items": {}, "title": "channel" }, "payment": { "type": "array", "items": {}, "title": "payment" }, "category": { "type": "string", "title": "category", "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" }, "priority": { "type": "string", "title": "priority", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" }, "orderDate": { "type": "string", "title": "orderDate", "format": "date-time", "description": "Date when the order was created" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "externalId": { "type": "string", "title": "externalId", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" }, "description": { "type": "string", "title": "description", "description": "Description of the product order" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "completionDate": { "type": "string", "title": "completionDate", "format": "date-time", "description": "Date when the order was completed" }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": {}, "title": "orderTotalPrice" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "format": "date-time", "description": "Date when the order is cancelled. This is used when order is cancelled." }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled. This is used when order is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "format": "date-time", "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date." }, "notificationContact": { "type": "string", "title": "notificationContact", "description": "Contact attached to the order to send back information regarding this order" }, "expectedCompletionDate": { "type": "string", "title": "expectedCompletionDate", "format": "date-time", "description": "Expected delivery date amended by the provider" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "format": "date-time", "description": "Requested delivery date from the requestor perspective" }, "productOfferingQualification": { "type": "array", "items": {}, "title": "productOfferingQualification" } } }, "lib_ProductPrice": { "type": "object", "title": "ProductPrice", "required": [ "priceType", "price" ], "properties": { "name": { "type": "string", "title": "name", "description": "A short descriptive name such as \"Subscription price\"." }, "price": { "oneOf": [ { "$ref": "#/components/schemas/lib_Price" } ], "title": "price", "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "priceType": { "type": "string", "title": "priceType", "description": "To be changed . This is required. A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A narrative that explains in detail the semantics of this product price." }, "unitOfMeasure": { "type": "string", "title": "unitOfMeasure", "description": "Could be minutes, GB..." }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOfferingPrice": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingPriceRef" } ], "title": "productOfferingPrice", "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased" }, "recurringChargePeriod": { "type": "string", "title": "recurringChargePeriod", "description": "Could be month, week..." }, "productPriceAlteration": { "type": "array", "items": {}, "title": "productPriceAlteration" } } }, "lib_QuoteItemRef": { "type": "object", "title": "QuoteItemRef", "required": [ "id", "quoteId" ], "properties": { "id": { "type": "string", "title": "id", "description": "Id of an item of a quote" }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "quoteId": { "type": "string", "title": "quoteId", "description": "Unique identifier of a related entity." }, "quoteHref": { "type": "string", "title": "quoteHref", "description": "Reference of the related entity." }, "quoteName": { "type": "string", "title": "quoteName", "description": "Name of the related entity." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResponseCode": { "type": "object", "title": "ResponseCode", "required": [ "code", "reason", "message", "status" ], "properties": { "code": { "type": "string", "title": "code" }, "reason": { "type": "string", "title": "reason" }, "status": { "type": "string", "title": "status" }, "message": { "type": "string", "title": "message" } } }, "lib_ResellerTerm": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductTerm" }, { "type": "object", "properties": { "activationDate": { "title": "activationDate", "type": "string", "format": "date-time" } } } ], "title": "ResellerTerm" }, "lib_OfferingInfo": { "type": "object", "title": "OfferingInfo", "required": [ "action", "offeringCode" ], "properties": { "action": { "type": "string", "enum": [ "A", "Q", "R", "U" ], "title": "action", "maxLength": 1 }, "category": { "type": "string", "title": "category", "description": "On Inquiry, identicates the offering category/generic attributes" }, "networkType": { "type": "string", "title": "networkType" }, "offeringCode": { "type": "string", "title": "offeringCode", "maxLength": 9 }, "offeringName": { "type": "string", "title": "offeringName" }, "genAttribute": { "type": "string", "title": "genAttribute" }, "blsIndicator": { "type": "string", "title": "blsIndicator" }, "offeringLevel": { "type": "string", "title": "offeringLevel", "description": "Indicates the offering level of the rate plan/price plan or feature/SOC A = Account, S = Subscriber, G = Group" }, "splitLiability": { "$ref": "#/components/schemas/lib_SplitLiabilityInfo" }, "effectiveDates": { "oneOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "effectiveDates", "description": "Generic structure for start and end date for specified event." }, "fanMACDiscount": { "type": "string", "title": "fanMACDiscount" }, "fanMSCDiscount": { "type": "string", "title": "fanMSCDiscount" }, "socDescription": { "type": "string", "title": "socDescription" }, "offeringFeatures": { "type": "array", "items": {}, "title": "offeringFeatures" }, "parkSocIndicator": { "type": "boolean", "title": "parkSocIndicator", "description": "Indicates whether to park a new SOC. Set it True if you want to park SOC on a subscriber along with current parking (subscriber should have a device parked)." }, "dataOnlyIndicator": { "type": "string", "title": "dataOnlyIndicator", "description": "true - Data only soc., false - Voice only soc.," }, "payPerUseIndicator": { "type": "string", "title": "payPerUseIndicator" }, "offeringDescription": { "type": "string", "title": "offeringDescription", "maxLength": 160 }, "productIMSIndicator": { "type": "string", "title": "productIMSIndicator" }, "valueAddedParameters": { "$ref": "#/components/schemas/lib_ValueAddedParameterInfo" }, "productCategoryIndicator": { "type": "number", "title": "productCategoryIndicator" }, "discountedFeaturePlanIndicator": { "type": "string", "title": "discountedFeaturePlanIndicator" } } }, "lib_AgreementRef": { "type": "object", "title": "AgreementRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the agreement" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResellerPlace": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 } }, "required": [ "serviceArea" ] } ], "title": "ResellerPlace" }, "lib_SubMarketInfo": { "type": "object", "title": "SubMarketInfo", "required": [ "code" ], "properties": { "code": { "type": "string", "title": "code", "maxLength": 3, "description": "sub market code, defined as a 3 digit string" }, "description": { "type": "string", "title": "description", "description": "Sub market description as it's defined within th billing system" } } }, "lib_PricePlanInfo": { "type": "object", "title": "PricePlanInfo", "properties": { "cbDiscount": { "type": "string", "title": "cbDiscount", "description": "Returns true if any of the subscribers under the account has the CB/WRD discount" }, "commission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "actionCode": { "type": "string", "title": "actionCode" }, "description": { "type": "string", "title": "description", "maxLength": 160, "description": "Price plan description." }, "promotionCode": { "type": "string", "title": "promotionCode", "description": "Discounts are ongoing discounts, like combined billing, what differentiates them from promotions is that promotions are tied to the plan. Discounts adjust the price and promotions do not directly adjust the price, the price is lowered through the fact that the price plan with the particular promotion is used." }, "effectiveDates": { "oneOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "effectiveDates", "description": "Generic structure for start and end date for specified event." }, "technologyType": { "type": "string", "title": "technologyType" }, "commitmentTerm": { "type": "string", "title": "commitmentTerm", "description": "This attribute holds the commitment term (duration) of the price plan. Mandarofy for certain priceplans during new Activation flow for GetAgreementAndEquipmentConflicts API" }, "recurringCharge": { "type": "number", "title": "recurringCharge" }, "parkPpIndicator": { "type": "string", "title": "parkPpIndicator", "description": "Indicates whether to park a new price plan. Set it True if you want to park PP on a subscriber along with current parking (subscriber should have a device parked)." }, "offeringsBundled": { "type": "array", "items": {}, "title": "offeringsBundled" }, "cbBundeledDiscount": { "type": "string", "title": "cbBundeledDiscount", "description": "Returns true if any of the subscribers under the account has the bundle discount. It was applicable to CARE but now TLG after Migration" }, "pricePlanAttributes": { "type": "array", "items": {}, "title": "pricePlanAttributes" }, "originalRatePlanMRC": { "type": "string", "title": "originalRatePlanMRC", "description": "This will be return during Change rate plan transactions from PDC" }, "offeringNetworkType": { "type": "string", "title": "offeringNetworkType", "description": "Indicates the network where the rate plan/price plan can be used, B - Applicable to Blue Network, D - Applicable to Dobson (Red) Network, O - Applicable to Orange Network, M - Applicable to both Orange and Blue Network, A- Extended calling plan (Pluto rate plan)" }, "restrictedSubMarkets": { "type": "array", "items": {}, "title": "restrictedSubMarkets" }, "originalRatePlanCode": { "type": "string", "title": "originalRatePlanCode", "description": "This will be return during Change rate plan transactions from PDC" }, "groupPlanOrSingleUserChoice": { "$ref": "#/components/schemas/lib_GroupPlanOrSingleUserChoice" } } }, "lib_M2xParameters": { "type": "object", "title": "M2xParameters", "required": [ "telephoneNumber" ], "properties": { "telephoneNumber": { "type": "string", "title": "telephoneNumber", "maxLength": 10, "description": "The customer's landline telephone number." } } }, "lib_DataUsageInfo": { "type": "object", "title": "DataUsageInfo", "required": [ "usageCategory", "allottedUnits", "usedUnits", "remainingUnits" ], "properties": { "usedUnits": { "type": "number", "title": "usedUnits", "format": "double", "description": "The data unit" }, "offerType": { "type": "string", "title": "offerType", "description": "Valid values: H, SH. This will identify if usage for offer is for Tethering or combined. H - Tethering, SH - SDG and Tethering combined. NOTE 6/13/18: this is NOT used in InquireCustomerSnapshotResponse mode M. For mode M, the same information is mapped in usageCategory because EnablerM uses usageCategory." }, "actualUnits": { "type": "number", "title": "actualUnits", "format": "double", "description": "The data unit" }, "usageCategory": { "type": "string", "title": "usageCategory", "description": "The usage type category" }, "allottedUnits": { "type": "number", "title": "allottedUnits", "format": "double", "description": "The data unit" }, "remainingUnits": { "type": "number", "title": "remainingUnits", "format": "double", "description": "The data unit" }, "sharedDataOverage": { "type": "number", "title": "sharedDataOverage", "format": "double", "description": "Shared Data Group overage volume" }, "offerPropertyType": { "type": "string", "title": "offerPropertyType", "description": "Indicator for Usage offer type. G = Indicates usages are for SDG Offers; P = Indicates usages are for PROMO Bolt-On Offers; S = Indicates usages are for Sandy Bolt-On Offers; N = Indicates usages are not for SDG or Bolt-On Offers (Default); E: External Bolt on; I: Internal Bolt On" }, "deviceViolationType": { "type": "string", "title": "deviceViolationType", "description": "Indicates the type of device usage violation. - S = SIM Swapping, T= Tetheringn" } } }, "lib_ResellerParty": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "longDistanceCarrier": { "$ref": "#/components/schemas/lib_LongDistanceCarrierInfo" } } } ], "title": "ResellerParty" }, "lib_NameValuePair": { "type": "object", "title": "NameValuePair", "required": [ "attributeName", "attributeValue" ], "properties": { "attributeName": { "type": "string", "title": "attributeName", "description": "Identifies the different Attributes that are associated with the Parent" }, "attributeValue": { "type": "string", "title": "attributeValue", "description": "The value that is assigned to the attributeName. This will often be Y/N" } } }, "lib_ResellerPrice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductPrice" }, { "type": "object", "properties": { "pricePlan": { "$ref": "#/components/schemas/lib_PricePlanPriceOnlyInfo" } }, "required": [ "pricePlan" ] } ], "title": "ResellerPrice" }, "lib_AddressZipInfo": { "type": "object", "title": "AddressZipInfo", "required": [ "zipCode" ], "properties": { "zipCode": { "type": "string", "title": "zipCode", "pattern": "((\\d{5}|\\d{5})|((\\d{5}|\\d{5})|\\d{5}))", "minLength": 5, "maxLength": 5, "description": "Standard Zip Code" }, "zipGeoCode": { "type": "string", "title": "zipGeoCode", "maxLength": 10 }, "zipCodeExtension": { "type": "string", "title": "zipCodeExtension", "pattern": "((\\d{4}|\\d{4})|((\\d{4}|\\d{4})|\\d{4}))", "minLength": 4, "maxLength": 4, "description": "Zip code extension used with Zip+4" } } }, "lib_SubscriberInfo": { "type": "object", "title": "SubscriberInfo", "required": [ "subscriberNumber", "depositAmount", "reserved" ], "properties": { "msid": { "type": "string", "title": "msid", "description": "The MSID associated for an MDN/Subscriber Number. This is mandatory data element for some Reseller partners." }, "error": { "$ref": "#/components/schemas/lib_ErrorInfo" }, "reserved": { "type": "string", "title": "reserved", "description": "The fields designates whether the subscriber number successfully reserved or not." }, "serviceArea": { "type": "string", "title": "serviceArea", "maxLength": 12 }, "equipmentType": { "type": "string", "title": "equipmentType" }, "depositAmount": { "type": "string", "title": "depositAmount", "description": "The deposit amount required for this subscriber." }, "subscriberNumber": { "type": "string", "title": "subscriberNumber", "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))", "minLength": 10, "maxLength": 10 } } }, "lib_RelatedChannel": { "type": "object", "title": "RelatedChannel", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the channel." }, "role": { "type": "string", "title": "role", "description": "Role playing by the channel." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_VvpnParameters": { "type": "object", "title": "VvpnParameters", "required": [ "companyName", "userGroup" ], "properties": { "userGroup": { "type": "string", "title": "userGroup", "description": "The user group." }, "companyName": { "type": "string", "title": "companyName", "description": "The company name." }, "dialingCode": { "type": "string", "title": "dialingCode", "description": "The abbreviated dialing code." } } }, "lib_AppointmentRef": { "type": "object", "title": "AppointmentRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "The identifier of the referred appointment" }, "href": { "type": "string", "title": "href", "description": "The reference of the appointment" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "An explanatory text regarding the appointment made with a party" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Characteristic": { "type": "object", "title": "Characteristic", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "title": "name", "description": "Name of the characteristic" }, "value": { "title": "value" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "valueType": { "type": "string", "title": "valueType", "description": "Data type of the value of the characteristic" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_WwifParameters": { "type": "object", "title": "WwifParameters", "properties": { "pin": { "type": "string", "title": "pin", "description": "The voice mail Personal Identification Number." }, "mailBox": { "type": "string", "title": "mailBox", "description": "voice mail box" }, "salesCode": { "type": "string", "title": "salesCode", "description": "WWIF Sales Code" }, "forwardNumber": { "type": "string", "title": "forwardNumber", "description": "The voice mail forward number." } } }, "lib_EmailParameters": { "type": "object", "title": "EmailParameters", "required": [ "domain", "boxName" ], "properties": { "domain": { "type": "string", "title": "domain", "description": "The domain id." }, "boxName": { "type": "string", "title": "boxName", "description": "The email box name." } } }, "lib_PriceAlteration": { "type": "object", "title": "PriceAlteration", "required": [ "priceType", "price" ], "properties": { "name": { "type": "string", "title": "name", "description": "Name of the order item price alteration" }, "price": { "oneOf": [ { "$ref": "#/components/schemas/lib_Price" } ], "title": "price", "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "priority": { "type": "number", "title": "priority", "format": "int32", "description": "Priority level for applying this alteration among all the defined alterations on the order item price" }, "priceType": { "type": "string", "title": "priceType", "description": "A category that describes the price such as recurring, one time and usage." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A narrative that explains in detail the semantics of this order item price alteration" }, "unitOfMeasure": { "type": "string", "title": "unitOfMeasure", "description": "Could be minutes, GB..." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "applicationDuration": { "type": "number", "title": "applicationDuration", "format": "int32", "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" }, "productOfferingPrice": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingPriceRef" } ], "title": "productOfferingPrice", "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased" }, "recurringChargePeriod": { "type": "string", "title": "recurringChargePeriod", "description": "Could be month, week..." } } }, "lib_ProductOrderRef": { "type": "object", "title": "ProductOrderRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PlanDetailsInfo": { "type": "object", "title": "PlanDetailsInfo", "properties": { "counterType": { "type": "string", "title": "counterType", "maxLength": 10, "description": "Type of counter: examples: NXT-> Next, IP -> installment Plan, TT -> Total, EIP -> Equipment Installment Plan" }, "counterTypeDescription": { "type": "string", "title": "counterTypeDescription", "maxLength": 70, "description": "Counter type description VV: counter type description from ELIG_MAX_ALLOWED, e.g., Installment for IP, Total for TT" }, "currentUsedCountForPlan": { "type": "number", "title": "currentUsedCountForPlan", "format": "int32", "description": "BAN’s current used counters per plan type" }, "counterEligibilityIndicator": { "type": "boolean", "title": "counterEligibilityIndicator", "description": "Eligibility Indicator per plan type/counter type." }, "referenceMaximumAllowedCountForPlan": { "type": "number", "title": "referenceMaximumAllowedCountForPlan", "format": "int32", "description": "Reference max allowed numbers counter per plan type" } } }, "lib_SwitchParameter": { "type": "object", "title": "SwitchParameter", "required": [ "switchParameterName", "switchSetting" ], "properties": { "switchSetting": { "type": "string", "title": "switchSetting", "maxLength": 30, "description": "Parameter Value" }, "switchParameterName": { "type": "string", "title": "switchParameterName", "maxLength": 30, "description": "Parameter Name" } } }, "lib_VanityNumberInfo": { "type": "object", "title": "VanityNumberInfo", "required": [ "npa" ], "properties": { "npa": { "type": "string", "title": "npa", "description": "Also Known As area code; the first 3 digits of the telephone number" }, "vanityPattern": { "type": "string", "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits. Pattern requirements will vary depending upon the back-end system. Refer to Interface Specifications for usage." } } }, "lib_AgreementItemRef": { "type": "object", "title": "AgreementItemRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity. In the future this could come from a catalog or will have information on how to derive it" }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "agreementItemId": { "type": "string", "title": "agreementItemId", "description": "Identifier of the agreement" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PdpParameterInfo": { "type": "object", "title": "PdpParameterInfo", "required": [ "pdpName" ], "properties": { "pdpName": { "type": "string", "title": "pdpName", "maxLength": 16, "description": "PDP Name" }, "context": { "type": "string", "title": "context", "description": "The context field used to distinguish EOD subscribers." }, "sequence": { "$ref": "#/components/schemas/lib_Sequence" }, "lteIndicator": { "type": "number", "title": "lteIndicator", "description": "Indicator set by client to enable CCS LTE" }, "ocsIndicator": { "type": "boolean", "title": "ocsIndicator", "description": "Indicator to publish APN_NAME and OCS attributes to switch" }, "accessPointName": { "type": "string", "title": "accessPointName", "maxLength": 16, "description": "Access Point Name" }, "defaultApnIndicator": { "type": "boolean", "title": "defaultApnIndicator", "description": "Indicator set by client to enable Default APN" } } }, "lib_UsagePoolingInfo": { "type": "object", "title": "UsagePoolingInfo", "required": [ "type" ], "properties": { "type": { "type": "string", "title": "type", "description": "Indicates the type of usage to be pooled - voice or data. V = NBI VOICE, D = NBI DATA, B = BEST VOICE, E = BEST DATA" }, "profile": { "type": "string", "title": "profile", "description": "The pooled group to which an offering belongs." } } }, "lib_BusinessNameInfo": { "type": "object", "title": "BusinessNameInfo", "required": [ "businessName", "contact" ], "properties": { "contact": { "$ref": "#/components/schemas/lib_NameInfo" }, "businessName": { "type": "string", "title": "businessName", "description": "Business Name" } } }, "lib_ManufacturerInfo": { "type": "object", "title": "ManufacturerInfo", "properties": { "make": { "type": "string", "title": "make" }, "model": { "type": "string", "title": "model" }, "marketingName": { "type": "string", "title": "marketingName", "description": "Device friendly name" } } }, "lib_ReasonDetailInfo": { "type": "object", "title": "ReasonDetailInfo", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "title": "code" }, "severity": { "type": "string", "enum": [ "Recoverable", "UnRecoverable" ], "title": "severity" }, "description": { "type": "string", "title": "description" }, "origination": { "type": "string", "title": "origination" } } }, "lib_MinutesUsageInfo": { "type": "object", "title": "MinutesUsageInfo", "required": [ "usageCategory", "allottedMinutes", "usedMinutes", "remainingMinutes" ], "properties": { "year": { "type": "string", "title": "year", "pattern": "(\\d{4})" }, "month": { "type": "string", "enum": [ "'01'", "'02'", "'03'", "'04'", "'05'", "'06'", "'07'", "'08'", "'09'", "'10'", "'11'", "'12'" ], "title": "month", "description": "Two digits, 01 thru 12" }, "usedMinutes": { "type": "number", "title": "usedMinutes", "format": "double", "description": "The unbilled used minutes" }, "usageCategory": { "type": "string", "title": "usageCategory", "description": "The usage type category" }, "allottedMinutes": { "type": "number", "title": "allottedMinutes", "format": "double", "description": "Total voice minutes allotted. 999999 indicates unlimited usage." }, "remainingMinutes": { "type": "number", "title": "remainingMinutes", "format": "double", "description": "allottedMinutes - used Minutes = remainingMinutes. 999999 indicates unlimited usage." }, "midCycleIndicator": { "type": "boolean", "title": "midCycleIndicator" }, "offerEffectiveDate": { "type": "string", "title": "offerEffectiveDate", "format": "date-time", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" }, "offerExpirationDate": { "type": "string", "title": "offerExpirationDate", "format": "date-time", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" } } }, "lib_ContractTermInfo": { "type": "object", "title": "ContractTermInfo", "required": [ "term" ], "properties": { "term": { "type": "number", "title": "term", "description": "This is the term for the contract which is the number of months for the contract" }, "startDate": { "type": "string", "title": "startDate", "format": "date-time" }, "commission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "tAndCIndicator": { "type": "string", "enum": [ "B", "C", "E", "I", "N", "P", "S", "T", "V", "W", "X", "Y" ], "title": "tAndCIndicator", "maxLength": 1, "description": "Terms and Conditions Indicator" }, "commitStartDate": { "type": "string", "title": "commitStartDate", "format": "date-time", "description": "Commit Start Date" } } }, "lib_ProductOrderItem": { "type": "object", "title": "ProductOrderItem", "required": [ "id", "action" ], "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" }, "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "assessingCancellation", "pendingCancellation" ], "title": "state", "description": "Possible values for the state of the product order item" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "action": { "type": "string", "enum": [ "add", "modify", "delete", "noChange" ], "title": "action", "description": "action to be performed on the product" }, "payment": { "type": "array", "items": {}, "title": "payment" }, "product": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductRefOrValue" } ], "title": "product", "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself" }, "quantity": { "type": "number", "title": "quantity", "format": "int32", "description": "Quantity ordered" }, "itemTerm": { "type": "array", "items": {}, "title": "itemTerm" }, "itemPrice": { "type": "array", "items": {}, "title": "itemPrice" }, "quoteItem": { "oneOf": [ { "$ref": "#/components/schemas/lib_QuoteItemRef" } ], "title": "quoteItem", "description": "It's a Quote item that has been executed previously." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "appointment": { "oneOf": [ { "$ref": "#/components/schemas/lib_AppointmentRef" } ], "title": "appointment", "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit" }, "qualification": { "type": "array", "items": {}, "title": "qualification" }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "itemTotalPrice": { "type": "array", "items": {}, "title": "itemTotalPrice" }, "productOffering": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingRef" } ], "title": "productOffering", "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "productOrderItemRelationship": { "type": "array", "items": {}, "title": "productOrderItemRelationship" }, "productOfferingQualificationItem": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingQualificationItemRef" } ], "title": "productOfferingQualificationItem", "description": "It's a productOfferingQualification item that has been executed previously." } } }, "lib_SwitchDetailInfo": { "type": "object", "title": "SwitchDetailInfo", "required": [ "featureCode", "switchParameter" ], "properties": { "featureCode": { "type": "string", "title": "featureCode", "description": "The Feature Code." }, "switchParameter": { "type": "array", "items": {}, "title": "switchParameter" } } }, "lib_ProductRefOrValue": { "type": "object", "title": "ProductRefOrValue", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the product" }, "href": { "type": "string", "title": "href", "description": "Reference of the product" }, "name": { "type": "string", "title": "name", "description": "Name of the product. It could be the same as the name of the product offering" }, "place": { "type": "array", "items": {}, "title": "place" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "enum": [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted" ], "title": "status", "description": "Possible values for the status of the product" }, "isBundle": { "type": "boolean", "title": "isBundle", "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." }, "orderDate": { "type": "string", "title": "orderDate", "format": "date-time", "description": "Is the date when the product was ordered" }, "startDate": { "type": "string", "title": "startDate", "format": "date-time", "description": "Is the date from which the product starts" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "Is the description of the product. It could be copied from the description of the Product Offering." }, "productTerm": { "type": "array", "items": {}, "title": "productTerm" }, "productPrice": { "type": "array", "items": {}, "title": "productPrice" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "terminationDate": { "type": "string", "title": "terminationDate", "format": "date-time", "description": "Is the date when the product was terminated" }, "productOffering": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingRef" } ], "title": "productOffering", "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "realizingService": { "type": "array", "items": {}, "title": "realizingService" }, "isCustomerVisible": { "type": "boolean", "title": "isCustomerVisible", "description": "If true, the product is visible by the customer." }, "realizingResource": { "type": "array", "items": {}, "title": "realizingResource" }, "productSerialNumber": { "type": "string", "title": "productSerialNumber", "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." }, "productRelationship": { "type": "array", "items": {}, "title": "productRelationship" }, "productSpecification": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductSpecificationRef" } ], "title": "productSpecification", "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." }, "productCharacteristic": { "type": "array", "items": {}, "title": "productCharacteristic" } } }, "lib_ResellerAgreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_AgreementItemRef" }, { "type": "object", "properties": { "contractTerm": { "$ref": "#/components/schemas/lib_ContractTermInfo" }, "termsConditionsStatus": { "title": "termsConditionsStatus", "type": "string", "description": "this value can only be \"N\"", "maxLength": 1, "enum": [ "B", "C", "E", "I", "N", "P", "S", "T", "V", "W", "X", "Y" ] }, "prePaid": { "$ref": "#/components/schemas/lib_PrePaidInfo" }, "waiveActivationFeeReasonCode": { "title": "waiveActivationFeeReasonCode", "type": "string", "description": "The reason for waiving the activation fee." }, "suspendImmediately": { "title": "suspendImmediately", "type": "boolean", "description": "Indicates whether the subscriber's service should be suspended immediately upon activation. A suspended subscriber must activate the service via the prescribed means upon receipt of the mobile device." } }, "required": [ "contractTerm", "termsConditionsStatus", "suspendImmediately" ] } ], "title": "ResellerAgreement" }, "lib_AddressCountyInfo": { "type": "object", "title": "AddressCountyInfo", "properties": { "countyType": { "type": "string", "title": "countyType", "maxLength": 1 }, "countyName": { "type": "string", "title": "countyName", "maxLength": 3 } } }, "lib_MarketServiceInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "type": "string", "description": "Zip code used to evaluate billingMarket", "minLength": 5, "maxLength": 5, "pattern": "[0-9]{5}" }, "billingMarket": { "title": "billingMarket", "type": "string", "description": "Used for activation", "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "type": "string", "description": "Used for activation", "maxLength": 3 }, "localMarket": { "title": "localMarket", "type": "string", "maxLength": 3 }, "billingSystemId": { "title": "billingSystemId", "type": "string", "maxLength": 9 }, "storeId": { "title": "storeId", "type": "string", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "maxLength": 10 }, "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 } }, "required": [ "serviceArea" ] } ], "title": "MarketServiceInfo" }, "lib_BillingAccountRef": { "type": "object", "title": "BillingAccountRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the billing account" }, "href": { "type": "string", "title": "href", "description": "Reference of the billing account" }, "name": { "type": "string", "title": "name", "description": "Name of the billing account" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_GeographicAddress": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "city": { "title": "city", "type": "string", "description": "City that the address is in" }, "country": { "title": "country", "type": "string", "description": "Country that the address is in" }, "locality": { "title": "locality", "type": "string", "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" }, "postcode": { "title": "postcode", "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" }, "stateOrProvince": { "title": "stateOrProvince", "type": "string", "description": "the State or Province that the address is in" }, "streetName": { "title": "streetName", "type": "string", "description": "Name of the street or other street type" }, "streetNr": { "title": "streetNr", "type": "string", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" }, "streetNrLast": { "title": "streetNrLast", "type": "string", "description": "Last number in a range of street numbers allocated to a property" }, "streetNrLastSuffix": { "title": "streetNrLastSuffix", "type": "string", "description": "Last street number suffix for a ranged address" }, "streetNrSuffix": { "title": "streetNrSuffix", "type": "string", "description": "the first street number suffix" }, "streetSuffix": { "title": "streetSuffix", "type": "string", "description": "A modifier denoting a relative direction" }, "streetType": { "title": "streetType", "type": "string", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf" }, "geographicSubAddress": { "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", "oneOf": [ { "$ref": "#/components/schemas/lib_GeographicSubAddress" } ], "title": "geographicSubAddress" } } } ], "title": "GeographicAddress" }, "lib_EventSubscription": { "type": "object", "title": "EventSubscription", "required": [ "id", "callback" ], "properties": { "id": { "type": "string", "title": "id", "description": "Id of the listener" }, "query": { "type": "string", "title": "query", "description": "additional data to be passed" }, "callback": { "type": "string", "title": "callback", "description": "The callback being registered." } } }, "lib_AddressStreetInfo": { "type": "object", "title": "AddressStreetInfo", "required": [ "streetNumber", "streetName" ], "properties": { "streetType": { "type": "string", "enum": [ "ALY", "ANX", "ARC", "AVE", "BCH", "BG", "BGS", "BLF", "BLFS", "BLVD", "BND", "BR", "BRG", "BRK", "BRKS", "BTM", "BYP", "BYU", "CIR", "CIRS", "CLB", "CLF", "CLFS", "CMN", "COR", "CORS", "CP", "CPE", "CRES", "CRK", "CRSE", "CRST", "CSWY", "CT", "CTR", "CTRS", "CTS", "CURV", "CV", "CVS", "CYN", "DL", "DM", "DR", "DRS", "DV", "EST", "ESTS", "EXPY", "EXT", "EXTS", "FALL", "FLD", "FLDS", "FLS", "FLT", "FLTS", "FRD", "FRDS", "FRG", "FRGS", "FRK", "FRKS", "FRST", "FRY", "FT", "FWY", "GDN", "GDNS", "GLN", "GLNS", "GRN", "GRNS", "GRV", "GRVS", "GTWY", "HBR", "HBRS", "HCR", "HL", "HLS", "HOLW", "HTS", "HVN", "HWY", "INLT", "INST", "IS", "ISLE", "ISS", "JCT", "JCTS", "KNL", "KNLS", "KY", "KYS", "LAND", "LCK", "LCKS", "LDG", "LF", "LGT", "LGTS", "LK", "LKS", "LN", "LNDG", "LOOP", "MALL", "MDW", "MDWS", "MEWS", "ML", "MLS", "MNR", "MNRS", "MSN", "MT", "MTN", "MTNS", "MTWY", "NCK", "OPAS", "ORCH", "OVAL", "PARK", "PASS", "PATH", "PIKE", "PKWY", "PL", "PLN", "PLNS", "PLZ", "PNE", "PNES", "PR", "PRT", "PRTS", "PSGE", "PT", "PTS", "RADL", "RAMP", "RD", "RDG", "RDGS", "RDS", "RIV", "RNCH", "ROW", "RPD", "RPDS", "RST", "RTE", "RUE", "RUN", "SHL", "SHLS", "SHR", "SHRS", "SKWY", "SMT", "SPG", "SPGS", "SPUR", "SQ", "SQS", "ST", "STA", "STRA", "STRM", "STS", "TER", "TPKE", "TRAK", "TRCE", "TRFY", "TRL", "TRLR", "TRWY", "TUNL", "UN", "UNS", "UPAS", "VIA", "VIS", "VL", "VLG", "VLGS", "VLY", "VLYS", "VW", "VWS", "WALK", "WALL", "WAY", "WAYS", "WL", "WLS", "XING", "XRD" ], "title": "streetType", "description": "The street type, e.g., Street, Avenue, Grove, etc. to be checked against a decoding table: ALLEY=ALY,ANNEX=ANX,ARCADE=ARC,AVENUE=AVE,BAYOU=BYU,BEACH=BCH,BEND=BND,BLUFF=BLF,BLUFFS=BLFS, BOTTOM=BTM,BOULEVARD=BLVD,BRANCH=BR,BRIDGE=BRG,BROOK=BRK,BROOKS=BRKS,BURG=BG,BURGS=BGS, BYPASS=BYP,CAMP=CP,CANYON=CYN,CAPE=CPE,CAUSEWAY=CSWY,CENTER=CTR,CENTERS=CTRS,CIRCLE=CIR, CIRCLES=CIRS,CLIFF=CLF,CLIFFS=CLFS,CLUB=CLB,COMMON=CMN,CORNER=COR,CORNERS=CORS,COURSE=CRSE, COURT=CT,COURTS=CTS,COVE=CV,COVES=CVS,CREEK=CRK,CRESENT=CRES,CREST=CRST,CROSSING=XING, CROSSROAD=XRD,CURVE=CURV,DALE=DL,DAM=DM,DIVIDE=DV,DRIVE=DR,DRIVES=DRS,ESTATE=EST,ESTATES=ESTS ,EXPRESSWAY=EXPY,EXTENSION=EXT,EXTENSIONS=EXTS,FALL=FALL,FALLS=FLS,FERRY=FRY,FIELD=FLD,FIELDS=FLDS, FLAT=FLT,FLATS=FLTS,FORD=FRD,FORDS=FRDS,FOREST=FRST,FORGE=FRG,FORGES=FRGS,FORK=FRK,FORKS=FRKS, FORT=FT,FREEWAY=FWY,GARDEN=GDN,GARDENS=GDNS,GARDENS=GDNS,GATEWAY=GTWY,GLEN=GLN,GLENS=GLNS, GREEN=GRN,GREENS=GRNS,GROVE=GRV,GROVES=GRVS,HARBOR=HBR,HARBORS=HBRS,HAVEN=HVN,HEIGHTS=HTS, HIGHWAY=HWY,HILL=HL,HILLS=HLS,HOLLOW=HOLW,INLET=INLT,ISLAND=IS,ISLANDS=ISS,ISLE=ISLE,JUNCTION=JCT, JUNCTIONS=JCTS,KEY=KY,KEYS=KYS,KNOLL=KNL,KNOLLS=KNLS,LAKE=LK,LAKES=LKS,LAND=LAND,LANDING=LNDG, LANE=LN,LIGHT=LGT,LIGHTS=LGTS,LOAF=LF,LOCK=LCK,LOCKS=LCKS,LODGE=LDG,LOOP=LOOP,MALL=MALL,MANOR=MNR, MANORS=MNRS,MEADOW=MDW,MEADOWS=MDWS,MEWS=MEWS,MILL=ML,MILLS=MLS,MISSION=MSN,MOTORWAY=MTWY, MOUNT=MT,MOUNT=MT,MOUNTAIN=MTN,MOUNTAINS=MTNS,NECK=NCK,ORCHARD=ORCH,OVAL=OVAL,OVERPASS=OPAS, PARK=PARK,PARKWAY=PKWY,PARKWAY=PKWY,PARKWAYS=PKWY,PASS=PASS,PASSAGE=PSGE,PATH=PATH,PIKE=PIKE, PINE=PNE,PINES=PNES,PLACE=PL,PLAIN=PLN,PLAINS=PLNS,PLAZA=PLZ,POINT=PT,POINTS=PTS,PORT=PRT,PORTS=PRTS, PRAIRIE=PR,RADIAL=RADL,RAMP=RAMP,RANCH=RNCH,RAPID=RPD,RAPIDS=RPDS,REST=RST,RIDGE=RDG,RIDGES=RDGS, RIVER=RIV,ROAD=RD,ROADS=RDS,ROUTE=RTE,ROW=ROW,RUE=RUE,RUN=RUN,SHOAL=SHL,SHOALS=SHLS,SHORE=SHR, SHORES=SHRS,SKYWAY=SKWY,SPRING=SPG,SPRINGS=SPGS,SPUR=SPUR,SQUARE=SQ,SQUARES=SQS,STATION=STA, STRAVENUE=STRA,STREAM=STRM,STREET=ST,STREETS=STS,SUMMIT=SMT,TERRACE=TER,THROUGHWAY=TRWY, THRUWAY=TRWY,TRACE=TRCE,TRACK=TRAK,TRAFFICWAY=TRFY,TRAIL=TRL,TUNNEL=TUNL,TURNPIKE=TPKE, UNDERPASS=UPAS,UNION=UN,UNIONS=UNS,VALLEY=VLY,VALLEYS=VLYS,VIADUCT=VIA,VIEW=VW,VIEWS=VWS, VILLAGE=VLG,VILLAGES=VLGS,VILLE=VL,VISTA=VIS,WALK=WALK,WALL=WALL,WAY=WAY,WAYS=WAYS,WELL=WL, WELLS=WLS" }, "streetName": { "type": "string", "title": "streetName", "maxLength": 50 }, "streetNumber": { "type": "string", "title": "streetNumber", "maxLength": 10, "description": "The address house number number." }, "streetDirection": { "type": "string", "enum": [ "E", "N", "NE", "NW", "S", "SE", "SW", "W" ], "title": "streetDirection", "description": "The address street direction (east, west. etc.): EAST=E, NORTH=N, NORTH EAST=NE, NORTH WEST=NW, SOUTH=S, SOUTH EAST= SE, SOUTH WEST=SW, WEST=W." }, "streetTrailingDirection": { "type": "string", "enum": [ "E", "N", "NE", "W", "NW", "S", "SE", "SW" ], "title": "streetTrailingDirection", "description": "The address trailing street direction (east, west. etc.). East - E, North - N, North East - NE, North West - NW, South - S, South East - SE, South West - SW, West - W" } } }, "lib_IdentificationInfo": { "type": "object", "title": "IdentificationInfo", "required": [ "idType", "idNumber", "issuingAuthority" ], "properties": { "idType": { "type": "string", "enum": [ "DL" ], "title": "idType", "description": "Identification Type DriversLicense = DL" }, "idNumber": { "type": "string", "title": "idNumber", "description": "Encrypted or Plain Text Personal Ids. Characters must be UPPER CASE. Ex:Drivers License Number and other personal Ids. Dashes are pass through characters. EFPE Format used to encrypt or decrypt this value: DRIVER_LIC_NUM" }, "expirationDate": { "type": "string", "title": "expirationDate", "pattern": ".+Z", "description": "Designates a date in UTC format. The following formats is accepted: YYYY-MM-DDZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - Z is a fixed character, indicating UTC time zone" }, "issuingAuthority": { "type": "string", "title": "issuingAuthority", "maxLength": 2, "description": "Identification Issuing Authority i.e. state code for Drivers Licenses" } } }, "lib_ProductOfferingRef": { "type": "object", "title": "ProductOfferingRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EffectiveDatesInfo": { "type": "object", "title": "EffectiveDatesInfo", "required": [ "effectiveDate" ], "properties": { "effectiveDate": { "type": "string", "title": "effectiveDate", "format": "date-time", "description": "Designates a date in UTC format" }, "expirationDate": { "type": "string", "title": "expirationDate", "format": "date-time", "description": "Designates a date in UTC format" } } }, "lib_PortingLocatorInfo": { "type": "object", "title": "PortingLocatorInfo", "required": [ "portRequestNumber" ], "properties": { "portRequestNumber": { "type": "string", "title": "portRequestNumber", "maxLength": 16 }, "portRequestVersion": { "type": "string", "title": "portRequestVersion", "maxLength": 2 }, "teleportPortRecordId": { "type": "string", "title": "teleportPortRecordId" } } }, "lib_CancelProductOrder": { "type": "object", "title": "CancelProductOrder", "required": [ "productOrder" ], "properties": { "id": { "type": "string", "title": "id", "description": "id of the cancellation request (this is not an order id)" }, "href": { "type": "string", "title": "href", "description": "Hyperlink to access the cancellation request" }, "state": { "type": "string", "enum": [ "acknowledged", "terminatedWithError", "inProgress", "done" ], "title": "state", "description": "Possible values for the state of a task" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderRef" } ], "title": "productOrder", "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled." }, "effectiveCancellationDate": { "type": "string", "title": "effectiveCancellationDate", "format": "date-time", "description": "Date when the order is cancelled." }, "requestedCancellationDate": { "type": "string", "title": "requestedCancellationDate", "format": "date-time", "description": "Date when the submitter wants the order to be cancelled" } } }, "lib_DispatchParameters": { "type": "object", "title": "DispatchParameters", "required": [ "telephoneNumber" ], "properties": { "telephoneNumber": { "type": "string", "title": "telephoneNumber", "maxLength": 10, "description": "Ougoing telephone number" } } }, "lib_SplitLiabilityInfo": { "type": "object", "title": "SplitLiabilityInfo", "required": [ "targetAccountNumber" ], "properties": { "targetAccountNumber": { "type": "string", "title": "targetAccountNumber", "description": "The account number to which the split charges will be billed." } } }, "lib_ContactInformation": { "type": "object", "title": "ContactInformation", "required": [ "Address" ], "properties": { "Address": { "oneOf": [ { "$ref": "#/components/schemas/lib_AddressInfo" } ], "title": "Address", "description": "Manditory Fields Field Name Case when Mandatory city Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. stateCode Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. zip Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. pob Mandatory only when Address type = 'P.O. Box'. streetName Mandatory only when Address type = 'Street'." } } }, "lib_GroupDetailsChoice": { "type": "object", "title": "GroupDetailsChoice", "properties": { "groupReferenceChoice": { "$ref": "#/components/schemas/lib_GroupReferenceChoice" }, "createDataGroupIndicator": { "type": "string", "title": "createDataGroupIndicator", "description": "Indicates whether to create a new shared data group." } } }, "lib_GroupDataUsageInfo": { "type": "object", "title": "GroupDataUsageInfo", "required": [ "offerCode", "offerEffectiveDate", "eventsThrough", "roamingIndicator", "usageDetail" ], "properties": { "offerCode": { "type": "string", "title": "offerCode", "maxLength": 9, "description": "Cingular Billing System Code for an offering (Telegence SOC or CARE Feature)." }, "socOrderId": { "type": "string", "title": "socOrderId", "maxLength": 25, "description": "unique, persistent identifier to be associated with any Active or expired SOC to allow tracking those SOC instances against the Mobile order." }, "usageDetail": { "type": "array", "items": {}, "title": "usageDetail" }, "offeringCode": { "type": "string", "title": "offeringCode", "maxLength": 9, "description": "Cingular Billing System Code for an offering (Telegence SOC or CARE Feature)." }, "overageUnits": { "type": "number", "title": "overageUnits", "format": "double" }, "eventsThrough": { "type": "string", "title": "eventsThrough" }, "unitOfMeasure": { "type": "string", "enum": [ "BY", "KB", "MB", "GB", "TB", "MI", "$", "CAD" ], "title": "unitOfMeasure", "description": "The data unit of measurement\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n" }, "offerDescription": { "type": "string", "title": "offerDescription", "maxLength": 160, "description": "The offering Description. Returned on inquiries; not usually expected on input." }, "roamingIndicator": { "type": "string", "enum": [ "H", "R", "I", "B", "D", "U", "L", "A" ], "title": "roamingIndicator", "description": "The home or roaming indicator\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n" }, "offerEffectiveDate": { "type": "string", "title": "offerEffectiveDate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "offerExpirationDate": { "type": "string", "title": "offerExpirationDate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "SDGGroupOfferingCode": { "type": "string", "title": "SDGGroupOfferingCode", "description": "Indicator which group offer id the line level offer is associated with" }, "sharedDataUsageIndicator": { "type": "boolean", "title": "sharedDataUsageIndicator" }, "GroupSubscriberUsageDetail": { "type": "array", "items": {}, "title": "GroupSubscriberUsageDetail" }, "SharedDataGroupUsageSummary": { "$ref": "#/components/schemas/lib_SharedDataGroupUsageSummary" } } }, "lib_DualCommisionsInfo": { "type": "object", "title": "DualCommisionsInfo", "required": [ "creditCheckAgent", "creditCheckAgentLocation" ], "properties": { "creditCheckAgent": { "type": "string", "title": "creditCheckAgent", "minLength": 1, "maxLength": 10, "description": "For DualCommissions, this is the agent to perform the credit check" }, "creditCheckAgentLocation": { "type": "string", "title": "creditCheckAgentLocation", "minLength": 1, "maxLength": 10, "description": "For Dual Commsions, this is the agent location" } } }, "lib_OfferingFeatureInfo": { "type": "object", "title": "OfferingFeatureInfo", "required": [ "featureCode" ], "properties": { "featureCode": { "type": "string", "title": "featureCode", "maxLength": 6, "description": "The Feature Code ." }, "dataUsageCategory": { "type": "string", "title": "dataUsageCategory", "description": "Contains the Data Usage Category code, if the feature code is a data feature" }, "featureDescription": { "type": "string", "title": "featureDescription", "description": "The Feature Description . For order fulfillment with the print contract option selected, with a null feature description, the feature description will be retrieved from the Billing systems if a feature code is present." } } }, "lib_TargetProductSchema": { "type": "object", "title": "TargetProductSchema", "required": [ "@schemaLocation", "@type" ], "properties": { "@type": { "type": "string", "title": "@type", "description": "Class type of the target product" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "This field provides a link to the schema describing the target product" } } }, "lib_ProductOrder_Create": { "type": "object", "title": "ProductOrder_Create", "properties": { "note": { "type": "array", "items": {}, "title": "note" }, "quote": { "type": "array", "items": {}, "title": "quote" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "channel": { "type": "array", "items": {}, "title": "channel" }, "payment": { "type": "array", "items": {}, "title": "payment" }, "category": { "type": "string", "title": "category", "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" }, "priority": { "type": "string", "title": "priority", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "externalId": { "type": "string", "title": "externalId", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" }, "description": { "type": "string", "title": "description", "description": "Description of the product order" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": {}, "title": "orderTotalPrice" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "format": "date-time", "description": "Date when the order is cancelled. This is used when order is cancelled." }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled. This is used when order is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "format": "date-time", "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date." }, "notificationContact": { "type": "string", "title": "notificationContact", "description": "Contact attached to the order to send back information regarding this order" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "format": "date-time", "description": "Requested delivery date from the requestor perspective" }, "productOfferingQualification": { "type": "array", "items": {}, "title": "productOfferingQualification" } } }, "lib_ProductRelationship": { "type": "object", "title": "ProductRelationship", "required": [ "relationshipType" ], "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "title": "relationshipType", "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" } } }, "lib_VoiceMailParameters": { "type": "object", "title": "VoiceMailParameters", "required": [ "language" ], "properties": { "pin": { "type": "number", "title": "pin", "description": "The voice mail Personal Identification Number." }, "mailBox": { "type": "string", "title": "mailBox", "description": "voice mail box" }, "language": { "type": "string", "title": "language", "description": "The voice mail language preference." }, "forwardNumber": { "type": "string", "title": "forwardNumber", "minLength": 10, "maxLength": 10, "description": "The voice mail forward number." } } }, "lib_SharedDataGroupInfo": { "type": "object", "title": "SharedDataGroupInfo", "properties": { "groupDetailsChoice": { "oneOf": [ { "$ref": "#/components/schemas/lib_GroupDetailsChoice" } ], "title": "groupDetailsChoice", "description": "This information is required when adding/updating a SDG Soc." } } }, "lib_ProductOrder_Update": { "type": "object", "title": "ProductOrder_Update", "required": [ "productOrderItem" ], "properties": { "note": { "type": "array", "items": {}, "title": "note" }, "quote": { "type": "array", "items": {}, "title": "quote" }, "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state", "description": "Possible values for the state of the order" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "channel": { "type": "array", "items": {}, "title": "channel" }, "payment": { "type": "array", "items": {}, "title": "payment" }, "category": { "type": "string", "title": "category", "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" }, "priority": { "type": "string", "title": "priority", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "externalId": { "type": "string", "title": "externalId", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" }, "description": { "type": "string", "title": "description", "description": "Description of the product order" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "completionDate": { "type": "string", "title": "completionDate", "format": "date-time", "description": "Date when the order was completed" }, "billingAccount": { "oneOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": {}, "title": "orderTotalPrice" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "format": "date-time", "description": "Date when the order is cancelled. This is used when order is cancelled." }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled. This is used when order is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "format": "date-time", "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date." }, "notificationContact": { "type": "string", "title": "notificationContact", "description": "Contact attached to the order to send back information regarding this order" }, "expectedCompletionDate": { "type": "string", "title": "expectedCompletionDate", "format": "date-time", "description": "Expected delivery date amended by the provider" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "format": "date-time", "description": "Requested delivery date from the requestor perspective" }, "productOfferingQualification": { "type": "array", "items": {}, "title": "productOfferingQualification" } } }, "lib_MacAddressParameters": { "type": "object", "title": "MacAddressParameters", "properties": { "macAddress": { "type": "string", "title": "macAddress" } } }, "lib_MappingCtnParameters": { "type": "object", "title": "MappingCtnParameters", "required": [ "mappingCtn" ], "properties": { "mappingCtn": { "type": "string", "title": "mappingCtn", "maxLength": 10 } } }, "lib_SwitchParametersInfo": { "type": "object", "title": "SwitchParametersInfo", "properties": { "salesCode": { "type": "string", "title": "salesCode" }, "mailboxNumber": { "type": "string", "title": "mailboxNumber" }, "callForwardNumber": { "type": "string", "title": "callForwardNumber" }, "voicemailAccessNumber": { "type": "string", "title": "voicemailAccessNumber" } } }, "lib_GroupPlanDetailsInfo": { "type": "object", "title": "GroupPlanDetailsInfo", "required": [ "groupPlanCode", "primarySubscriber", "referenceSubscriberOrGroupIdChoice" ], "properties": { "groupPlanCode": { "type": "string", "title": "groupPlanCode", "maxLength": 9, "description": "The group plan code which indicates that the price plan is a group plan." }, "lineLimitation": { "type": "number", "title": "lineLimitation", "description": "Indicates the maximum number of subscribers for this group plan if such a limitation exists." }, "primarySubscriber": { "type": "string", "title": "primarySubscriber", "description": "Indicates whether this is the primary subscriber for this group or not." }, "additionalLineCharge": { "type": "string", "title": "additionalLineCharge", "description": "The monthly recurring charge for additional members added to this group plan." }, "referenceSubscriberOrGroupIdChoice": { "$ref": "#/components/schemas/lib_ReferenceSubscriberOrGroupIdChoice" } } }, "lib_DealerCommissionInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "DualCommission": { "$ref": "#/components/schemas/lib_DualCommisionsInfo" }, "billingTelephoneNumber": { "title": "billingTelephoneNumber", "type": "string", "description": "Billing Telephone Number", "maxLength": 10 }, "customerCode": { "title": "customerCode", "type": "string", "description": "The customer code.", "maxLength": 3 }, "dealer": { "$ref": "#/components/schemas/lib_DealerInfo" }, "location": { "title": "location", "type": "string", "description": "Location code for the physical/logical store being commissioned." }, "salesRepresentative": { "title": "salesRepresentative", "type": "string", "description": "Sales Representative ID", "maxLength": 9 }, "affiliateSalesRepCode": { "title": "affiliateSalesRepCode", "type": "string", "description": "The Affiliate sales repersentative code", "maxLength": 15 } } } ], "title": "DealerCommissionInfo" }, "lib_GeographicSubAddress": { "type": "object", "title": "GeographicSubAddress", "properties": { "id": { "type": "string", "title": "id", "description": "Unique Identifier of the subAddress" }, "href": { "type": "string", "title": "href", "description": "Link to the subAddress" }, "name": { "type": "string", "title": "name", "description": "Name of the subAddress to identify it with a meaningful identification" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "levelType": { "type": "string", "title": "levelType", "description": "describes level types within a building" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "levelNumber": { "type": "string", "title": "levelNumber", "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" }, "subUnitType": { "type": "string", "title": "subUnitType", "description": "the type of subunit\n\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF\n" }, "buildingName": { "type": "string", "title": "buildingName", "description": "allows for buildings that have well-known names" }, "subUnitNumber": { "type": "string", "title": "subUnitNumber", "description": "the discriminator used for the subunit\n\noften just a simple number e.g. FLAT 5, may also be a range\n" }, "subAddressType": { "type": "string", "title": "subAddressType", "description": "Type of subAddress : it can be a subunit or a private street" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "privateStreetName": { "type": "string", "title": "privateStreetName", "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." }, "privateStreetNumber": { "type": "string", "title": "privateStreetNumber", "description": "private streets numbers internal to a private street" } } }, "lib_GroupReferenceChoice": { "type": "object", "title": "GroupReferenceChoice", "properties": { "dataGroupId": { "type": "string", "title": "dataGroupId", "description": "shared Data Group Id" }, "subscriberNumber": { "type": "string", "title": "subscriberNumber", "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))", "minLength": 10, "maxLength": 10, "description": "When the group id is not known, you may refer to the group by a subscriber that already exists in the group." } } }, "lib_OfferMinutesUsageInfo": { "type": "object", "title": "OfferMinutesUsageInfo", "required": [ "usageCategory", "allottedMinutes", "usedMinutes", "remainingMinutes" ], "properties": { "usedMinutes": { "type": "number", "title": "usedMinutes", "format": "double", "description": "The unbilled used minutes" }, "usageCategory": { "type": "string", "title": "usageCategory", "description": "The usage type category" }, "actualMinutes": { "type": "number", "title": "actualMinutes", "format": "double", "description": "This actual voice minutes alloted. 999999 indicates unlimited usage" }, "OverageMinutes": { "type": "number", "title": "OverageMinutes", "format": "double", "description": "The overage minutes. Sent when overages are indicated for the given category (i.e. PTT)" }, "allottedMinutes": { "type": "number", "title": "allottedMinutes", "format": "double", "description": "Total voice minutes allotted. 999999 indicates unlimited usage." }, "roamingIndicator": { "type": "string", "enum": [ "H", "R", "I", "B", "D", "U", "L", "A" ], "title": "roamingIndicator", "description": "The home or roaming indicator\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n" }, "remainingMinutes": { "type": "number", "title": "remainingMinutes", "format": "double", "description": "allottedMinutes - used Minutes = remainingMinutes. 999999 indicates unlimited usage." } } }, "lib_MobileSessionDataInfo": { "type": "object", "title": "MobileSessionDataInfo", "properties": { "sessionId": { "type": "string", "title": "sessionId", "description": "Session Identifier" }, "sessionDates": { "oneOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "sessionDates", "description": "Generic structure for start and end date for specified event." }, "sessionStatus": { "type": "string", "title": "sessionStatus", "description": "Only 1 SOC will show Active at a time. Possible values: R = Requested; S = Stacked; A = Active; F = Finished; C = Cancelled" }, "sessionStatusReasonCode": { "type": "string", "title": "sessionStatusReasonCode", "description": "Session Status Reason Code Possible Values: NOTIF = Session stacked after Payment notification; FINTM = session is fully used due to time; FINAW = session is fully used due to allowance; TSCAN = Session cancelled due to removal of session; CHGBCK = Session cancelled due to ChargeBack; VOID = Session cancelled due to Void; REFUND = Session cancelled due to Refund; PREPOST = Session cancelled at source due to Move activity; CHGCTN = Session cancelled at source due to Change CTN; SUBCAN = Session cancelled due to Cancel Subscriber; PENBCK = Session cancelled due to Cancel Subscriber(Prepaid) – Awaiting backout from CAPM." }, "sessionStatusReasonDescription": { "type": "string", "title": "sessionStatusReasonDescription", "description": "Session Status Reason Description" } } }, "lib_OrderItemRelationship": { "type": "object", "title": "OrderItemRelationship", "properties": { "id": { "type": "string", "title": "id" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "title": "relationshipType", "description": "The type of order item relationship" } } }, "lib_ManifestUrlParameters": { "type": "object", "title": "ManifestUrlParameters", "required": [ "manifestUrl" ], "properties": { "manifestUrl": { "type": "string", "title": "manifestUrl", "maxLength": 128 } } }, "lib_SubscriberUsageDetail": { "type": "object", "title": "SubscriberUsageDetail", "required": [ "usedUnits", "usageCategory" ], "properties": { "usedUnits": { "type": "number", "title": "usedUnits", "format": "double", "description": "The data unit" }, "offerType": { "type": "string", "title": "offerType", "description": "Valid values: H, SH. This will identify if usage for offer is for Tethering or combined. H - Tethering, SH - SDG and Tethering combined." }, "overageUnits": { "type": "number", "title": "overageUnits", "format": "double" }, "usageCategory": { "type": "string", "title": "usageCategory", "description": "The usage type category" }, "unitOfMeasure": { "type": "string", "enum": [ "BY", "KB", "MB", "GB", "TB", "MI", "$", "CAD" ], "title": "unitOfMeasure", "description": "The data unit of measurement\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n" }, "roamingIndicator": { "type": "string", "enum": [ "H", "R", "I", "B", "D", "U", "L", "A" ], "title": "roamingIndicator", "description": "The home or roaming indicator\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n" } } }, "lib_VQosSpecialParameters": { "type": "object", "title": "VQosSpecialParameters", "required": [ "url", "enterpriseId", "label" ], "properties": { "url": { "type": "string", "title": "url", "maxLength": 255, "description": "Manifest URL" }, "label": { "type": "string", "title": "label", "maxLength": 100, "description": "Manifest Label" }, "enterpriseId": { "type": "string", "title": "enterpriseId", "maxLength": 50, "description": "Manifest EID" } } }, "lib_AddressRuralRouteInfo": { "type": "object", "title": "AddressRuralRouteInfo", "required": [ "ruralRouteBoxNumber", "ruralRouteCenterNumber" ], "properties": { "ruralRouteBoxNumber": { "type": "string", "title": "ruralRouteBoxNumber", "maxLength": 10 }, "ruralRouteCenterNumber": { "type": "string", "title": "ruralRouteCenterNumber", "maxLength": 6 } } }, "lib_ResellerMobileLineItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/lib_ResellerMobileLineProduct" }, "portingLocator": { "$ref": "#/components/schemas/lib_PortingLocatorInfo" }, "response": { "description": "The object which holds the response code and description", "oneOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "title": "response" } }, "required": [ "product" ] } ], "title": "ResellerMobileLineItem" }, "lib_RolloverExpirationInfo": { "type": "object", "title": "RolloverExpirationInfo", "required": [ "expiringRolloverMinutesBalance", "expiringRolloverMinutesDate" ], "properties": { "expiringRolloverMinutesDate": { "type": "string", "title": "expiringRolloverMinutesDate" }, "expiringRolloverMinutesBalance": { "type": "number", "title": "expiringRolloverMinutesBalance", "format": "double" } } }, "lib_EffectiveDateTimesInfo": { "type": "object", "title": "EffectiveDateTimesInfo", "required": [ "effectiveDateTime" ], "properties": { "effectiveDateTime": { "type": "string", "title": "effectiveDateTime", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "expirationDateTime": { "type": "string", "title": "expirationDateTime", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" } } }, "lib_ImeiDeviceFirmwareInfo": { "type": "object", "title": "ImeiDeviceFirmwareInfo", "properties": { "osType": { "type": "string", "title": "osType", "description": "IMEI Operating System Type" }, "osVersion": { "type": "string", "title": "osVersion", "description": "Operating System Version with Build Number. For ex: 7.0.2" }, "softwareVersionNumber": { "type": "string", "title": "softwareVersionNumber", "description": "IMEI Software Version Number. Digits only" }, "networkActivityDateTime": { "type": "string", "title": "networkActivityDateTime", "description": "The time stamp received from the network ." } } }, "lib_EventSubscriptionInput": { "type": "object", "title": "EventSubscriptionInput", "required": [ "callback" ], "properties": { "query": { "type": "string", "title": "query", "description": "additional data to be passed" }, "callback": { "type": "string", "title": "callback", "description": "The callback being registered." } } }, "lib_PricePlanPriceOnlyInfo": { "type": "object", "title": "PricePlanPriceOnlyInfo", "properties": { "cbDiscount": { "type": "integer", "title": "cbDiscount", "description": "Returns true if any of the subscribers under the account has the CB/WRD discount" }, "commission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "actionCode": { "type": "string", "title": "actionCode" }, "description": { "type": "string", "title": "description", "description": "Price plan description." }, "promotionCode": { "type": "string", "title": "promotionCode", "maxLength": 9, "description": "Discounts are ongoing discounts, like combined billing, what differentiates them from promotions is that promotions are tied to the plan. Discounts adjust the price and promotions do not directly adjust the price, the price is lowered through the fact that the price plan with the particular promotion is used." }, "effectiveDates": { "oneOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "effectiveDates", "description": "Generic structure for start and end date for specified event." }, "technologyType": { "type": "string", "enum": [ "BOTH", "GSM", "TDMA" ], "title": "technologyType" }, "commitmentTerm": { "type": "string", "title": "commitmentTerm", "description": "This attribute holds the commitment term (duration) of the price plan. Mandarofy for certain priceplans during new Activation flow for GetAgreementAndEquipmentConflicts API" }, "recurringCharge": { "type": "string", "title": "recurringCharge" }, "parkPpIndicator": { "type": "string", "title": "parkPpIndicator", "description": "Indicates whether to park a new price plan. Set it True if you want to park PP on a subscriber along with current parking (subscriber should have a device parked)." }, "cbBundeledDiscount": { "type": "integer", "title": "cbBundeledDiscount", "description": "Returns true if any of the subscribers under the account has the bundle discount. It was applicable to CARE but now TLG after Migration" }, "pricePlanAttributes": { "type": "array", "items": {}, "title": "pricePlanAttributes" }, "originalRatePlanMRC": { "type": "string", "title": "originalRatePlanMRC", "description": "This will be return during Change rate plan transactions from PDC" }, "offeringNetworkType": { "type": "string", "title": "offeringNetworkType", "description": "Indicates the network where the rate plan/price plan can be used, B - Applicable to Blue Network, D - Applicable to Dobson (Red) Network, O - Applicable to Orange Network, M - Applicable to both Orange and Blue Network, A- Extended calling plan (Pluto rate plan)" }, "restrictedSubMarkets": { "type": "array", "items": {}, "title": "restrictedSubMarkets" }, "originalRatePlanCode": { "type": "string", "title": "originalRatePlanCode", "description": "This will be return during Change rate plan transactions from PDC" }, "groupPlanOrSingleUserChoice": { "$ref": "#/components/schemas/lib_GroupPlanOrSingleUserChoice" } } }, "lib_AnyCharacteristicValue": { "type": "object", "title": "AnyCharacteristicValue", "properties": { "id": { "type": "string", "title": "id" }, "@type": { "type": "string", "title": "@type" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedPlaceRefOrValue": { "type": "object", "title": "RelatedPlaceRefOrValue", "required": [ "role" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the place" }, "href": { "type": "string", "title": "href", "description": "Unique reference of the place" }, "name": { "type": "string", "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string", "title": "role" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ProductOfferingPriceRef": { "type": "object", "title": "ProductOfferingPriceRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ValueAddedParameterInfo": { "type": "object", "title": "ValueAddedParameterInfo", "properties": { "pdpParameters": { "$ref": "#/components/schemas/lib_PdpParameterInfo" }, "m2xParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_M2xParameters" } ], "title": "m2xParameters", "description": "The landline telephone number used in conjunction with the M2H (MobileToHome) feature." }, "switchDetails": { "$ref": "#/components/schemas/lib_SwitchDetailInfo" }, "vvpnParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_VvpnParameters" } ], "title": "vvpnParameters", "description": "The vvpn additional parameters." }, "wwifParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_WwifParameters" } ], "title": "wwifParameters", "description": "WWIF parameters" }, "emailParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_EmailParameters" } ], "title": "emailParameters", "description": "The email box additional parameters." }, "productAttributes": { "type": "array", "items": {}, "title": "productAttributes" }, "dispatchParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_DispatchParameters" } ], "title": "dispatchParameters", "description": "A subscriber who has a voice dispatch price plan has to set an outgoing number" }, "voiceMailParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_VoiceMailParameters" } ], "title": "voiceMailParameters", "description": "The voice mail additional parameters." }, "macAddressParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_MacAddressParameters" } ], "title": "macAddressParameters", "description": "The mac address parameters" }, "mappingCtnParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_MappingCtnParameters" } ], "title": "mappingCtnParameters", "description": "Mapping CTN parameters. Store the value of its corresponding Enterprise Psuedo CTN" }, "manifestUrlParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_ManifestUrlParameters" } ], "title": "manifestUrlParameters", "description": "Manifest URL parameters. Populated for the Toggle Corporate VPN SOC." }, "vQosSpecialParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_VQosSpecialParameters" } ], "title": "vQosSpecialParameters", "description": "Accept/Return the vQoS manifest attributes for FAN vQoS offer that require dynamic parameters" }, "unifiedMessagingParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_UnifiedMessagingParameters" } ], "title": "unifiedMessagingParameters", "description": "The unified Messaging additional parameters.One or more elements are required for updating CIO (Call In One) feature" }, "auxilliaryServiceParameters": { "oneOf": [ { "$ref": "#/components/schemas/lib_AuxilliaryServiceParameters" } ], "title": "auxilliaryServiceParameters", "description": "The auxiliary service additional parameters." }, "voiceActivatedDialingParameters": { "$ref": "#/components/schemas/lib_VoiceActivatedDialingParametersInfo" }, "priorityAccessServiceParameters": { "$ref": "#/components/schemas/lib_PriorityAccessServiceParameters" } } }, "lib_ProductSpecificationRef": { "type": "object", "title": "ProductSpecificationRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "version": { "type": "string", "title": "version", "description": "Version of the product specification" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "targetProductSchema": { "oneOf": [ { "$ref": "#/components/schemas/lib_TargetProductSchema" } ], "title": "targetProductSchema", "description": "The reference object to the schema and type of target product which is described by product specification" } } }, "lib_RelatedProductOrderItem": { "type": "object", "title": "RelatedProductOrderItem", "required": [ "orderItemId", "productOrderId" ], "properties": { "role": { "type": "string", "title": "role", "description": "role of the product order item for this product" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "orderItemId": { "type": "string", "title": "orderItemId", "description": "Identifier of the order item where the product was managed" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "productOrderId": { "type": "string", "title": "productOrderId", "description": "Unique identifier of a related entity." }, "orderItemAction": { "type": "string", "title": "orderItemAction", "description": "Action of the order item for this product" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOrderHref": { "type": "string", "title": "productOrderHref", "description": "Reference of the related entity." } } }, "lib_AdditionalOfferingsInfo": { "type": "object", "title": "AdditionalOfferingsInfo", "required": [ "action", "offeringCode" ], "properties": { "appId": { "type": "array", "items": { "type": "string" }, "title": "appId" }, "action": { "type": "string", "title": "action" }, "socMode": { "type": "string", "title": "socMode", "description": "Soc Mode. G - Sharing/ Group SOC, S - Secondary SOC." }, "category": { "type": "string", "title": "category", "description": "Idicates the offering category/generic attributes." }, "offerType": { "type": "string", "title": "offerType", "description": "Type of offering. The valid values are A - Additional Offering; B - Bundle Offering" }, "commission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "socOrderId": { "type": "string", "title": "socOrderId", "description": "unique, persistent identifier to be associated with any Active or expired SOC to allow tracking those SOC instances against the Mobile order." }, "switchCode": { "type": "string", "title": "switchCode", "description": "Switch Code of the SOC/feature." }, "macAddress": { "type": "string", "title": "macAddress", "maxLength": 12, "description": "Hex value (as String) of the Media Access Control address of the Wireless Access Point." }, "serviceType": { "type": "string", "title": "serviceType", "description": "Indicates the offering service type such as regular or promotion" }, "offeringCode": { "type": "string", "title": "offeringCode" }, "offeringType": { "type": "string", "title": "offeringType", "description": "The feature code type to identify the Shared Data group services. Valid values: G – SDG SOC; P – SDP SOC" }, "usagePooling": { "$ref": "#/components/schemas/lib_UsagePoolingInfo" }, "referenceSoc": { "type": "string", "title": "referenceSoc", "description": "Returns the related SOC code (Parent Soc Code)." }, "oneTimeCharge": { "type": "string", "title": "oneTimeCharge", "description": "One time charge for this offering, or monthly recurring charges (MRC ) for the SOC" }, "offeringLevel": { "type": "string", "title": "offeringLevel", "description": "Indicates the offering level of the rate plan/price plan or feature/SOC. A = Account, S = Subscriber, G = Group" }, "parkIndicator": { "type": "string", "title": "parkIndicator", "description": "This field is returned in order to indicate a SOC that is involved in a swap/park equipment process." }, "effectiveDates": { "oneOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "effectiveDates", "description": "Generic structure for start and end date for specified event." }, "splitLiability": { "$ref": "#/components/schemas/lib_SplitLiabilityInfo" }, "sequenceNumber": { "type": "string", "title": "sequenceNumber", "description": "The sequence number of the offering." }, "sharedDataGroup": { "$ref": "#/components/schemas/lib_SharedDataGroupInfo" }, "socSalesExpDate": { "type": "string", "title": "socSalesExpDate", "description": "Soc Sales expiration date." }, "offeringFeatures": { "type": "array", "items": {}, "title": "offeringFeatures" }, "switchParameters": { "$ref": "#/components/schemas/lib_SwitchParametersInfo" }, "promotionEndDate": { "type": "string", "title": "promotionEndDate", "format": "date-time", "description": "If the offering is a promotion, then this will have promotion end date." }, "parkSocIndicator": { "type": "boolean", "title": "parkSocIndicator", "description": "Indicates whether to park a new SOC. Set it True if you want to park SOC on a subscriber along with current parking (subscriber should have a device parked)." }, "mobileSessionData": { "$ref": "#/components/schemas/lib_MobileSessionDataInfo" }, "autoRenewIndicator": { "type": "string", "title": "autoRenewIndicator", "description": "false – non auto-renewed; true – it is auto renewed." }, "offeringDescription": { "type": "string", "title": "offeringDescription" }, "valueAddedParameters": { "$ref": "#/components/schemas/lib_ValueAddedParameterInfo" }, "crossMarketIndicator": { "type": "boolean", "title": "crossMarketIndicator", "description": "The NCI eligibility indicator of the soc. True means it's a cross market soc" }, "hasIntegratedMessaging": { "type": "boolean", "title": "hasIntegratedMessaging", "description": "Specifies whether this offer has Integrated Messaging." }, "transferFeatureIndicator": { "type": "boolean", "title": "transferFeatureIndicator", "description": "Non Switch Sensitive Indicator for Voice Mail Call Transfer" }, "turboSessionPaymentMethod": { "type": "string", "title": "turboSessionPaymentMethod", "description": "The turbo session payment method for turbo session on postpaid account. CC=Indicates if already paid for by Credit Card; BILL=Indicates if a Turbo Session is to be added to the bill, ‘GMF’ – GM funded, ‘ATTF’ – ATT funded, ‘Trial’ – Trial, Empty –For zero rate without the special gen attribute on the SOC. For UpdateSubscriberProfile: Used only to indicate when a session is paid via credit card, rather than billed on the monthly bill. i.e. only the value of 'CC' should be sent." }, "integrationFeatureIndicator": { "type": "boolean", "title": "integrationFeatureIndicator", "description": "Switch Sensitive Feature indicator for Wireless Wireline Integration" }, "primarySharedDataPlanIndicator": { "type": "boolean", "title": "primarySharedDataPlanIndicator", "description": "Indicates the offering is a Primary Shared Data Plan." } } }, "lib_SubscriberDataUsageInfo": { "type": "object", "title": "SubscriberDataUsageInfo", "required": [ "offerCode", "offerEffectiveDate", "eventsThrough", "RoamingIndicator", "UsageDetail" ], "properties": { "offerCode": { "type": "string", "title": "offerCode", "maxLength": 9, "description": "Cingular Billing System Code for an offering (Telegence SOC or CARE Feature)." }, "sessionID": { "type": "string", "title": "sessionID", "maxLength": 30, "description": "Turbo Session Id for Prepaid Mobile Subscribers" }, "socOrderId": { "type": "string", "title": "socOrderId", "maxLength": 25, "description": "unique, persistent identifier to be associated with any Active or expired SOC to allow tracking those SOC instances against the Mobile order." }, "UsageDetail": { "type": "array", "items": {}, "title": "UsageDetail" }, "offeringCode": { "type": "string", "title": "offeringCode", "maxLength": 9, "description": "Cingular Billing System Code for an offering (Telegence SOC or CARE Feature)." }, "chargeAmount": { "type": "number", "title": "chargeAmount", "format": "double", "description": "A monetary currency value" }, "OverageUnits": { "type": "number", "title": "OverageUnits", "format": "double" }, "eventsThrough": { "type": "string", "title": "eventsThrough" }, "UnitOfMeasure": { "type": "string", "enum": [ "BY", "KB", "MB", "GB", "TB", "MI", "$", "CAD" ], "title": "UnitOfMeasure", "description": "The data unit of measurement\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n\nBY=Bytes, KB=Kilobytes, MB=Megabytes, GB=Gigabyes, TB=Terabytes, MI=Minutes\n" }, "classOfService": { "type": "string", "title": "classOfService", "maxLength": 8, "description": "Class of Service" }, "offerDescription": { "type": "string", "title": "offerDescription", "maxLength": 160, "description": "The offering Description. Returned on inquiries; not usually expected on input." }, "RoamingIndicator": { "type": "string", "enum": [ "H", "R", "I", "B", "D", "U", "L", "A" ], "title": "RoamingIndicator", "description": "The home or roaming indicator\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n\nH - Home, R - Roaming (Domestic), I - Roaming (International), B - Both Domestic on Net and Domestic Roaming, D - DSL, U - U-verse, L - Long Distance, A - IPUB\n" }, "offerEffectiveDate": { "type": "string", "title": "offerEffectiveDate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "throttlingIndicator": { "type": "boolean", "title": "throttlingIndicator", "description": "True when the subscriber is throttled in the current bill cycle." }, "offerExpirationDate": { "type": "string", "title": "offerExpirationDate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "SDGGroupOfferingCode": { "type": "string", "title": "SDGGroupOfferingCode", "description": "Indicator which group offer id the line level offer is associated with" }, "classOfServiceDescription": { "type": "string", "title": "classOfServiceDescription", "maxLength": 32, "description": "Class of Service Description" } } }, "lib_ProductOrderCreateEvent": { "type": "object", "title": "ProductOrderCreateEvent", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the Process flow" }, "href": { "type": "string", "title": "href", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderCreateEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_LongDistanceCarrierInfo": { "type": "object", "title": "LongDistanceCarrierInfo", "required": [ "longDistanceCarrierCode" ], "properties": { "commission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "effectiveDate": { "type": "string", "title": "effectiveDate", "format": "date-time" }, "longDistanceCarrierCode": { "type": "string", "title": "longDistanceCarrierCode" } } }, "lib_ProductOrderDeleteEvent": { "type": "object", "title": "ProductOrderDeleteEvent", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the Process flow" }, "href": { "type": "string", "title": "href", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderDeleteEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_ResellerMobileLineCreate": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrder_Create" }, { "type": "object", "properties": { "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" } }, "required": [ "marketServiceInfo", "productOrderItem" ] } ], "title": "ResellerMobileLineCreate" }, "lib_InternationalAddressInfo": { "type": "object", "title": "InternationalAddressInfo", "properties": { "zone": { "type": "string", "title": "zone", "maxLength": 50 }, "city": { "type": "string", "title": "city", "maxLength": 40, "description": "The City of this address.Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'." }, "region": { "type": "string", "title": "region", "maxLength": 50, "description": "Typically value for state but different for other countries. For Canada: province." }, "country": { "type": "string", "title": "country", "maxLength": 50, "description": "iso2, iso3, or country name" }, "placeName": { "type": "string", "title": "placeName", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "subregion": { "type": "string", "title": "subregion", "maxLength": 50, "description": "For USA = county" }, "postalCode": { "type": "string", "title": "postalCode", "maxLength": 12, "description": "International postal code" }, "neighborhood": { "type": "string", "title": "neighborhood", "maxLength": 50, "description": "For example, in Mexico: colonia." }, "singleLineAddress": { "type": "string", "title": "singleLineAddress", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "streetAddressLine2": { "type": "string", "title": "streetAddressLine2", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "streetAddressLine1": { "type": "string", "title": "streetAddressLine1", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "postalCodeExtension": { "type": "string", "title": "postalCodeExtension", "maxLength": 12 } } }, "lib_CancelProductOrder_Create": { "type": "object", "title": "CancelProductOrder_Create", "required": [ "productOrder" ], "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderRef" } ], "title": "productOrder", "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the order is cancelled." }, "requestedCancellationDate": { "type": "string", "title": "requestedCancellationDate", "format": "date-time", "description": "Date when the submitter wants the order to be cancelled" } } }, "lib_ResellerMobileLineProduct": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductRefOrValue" }, { "type": "object", "properties": { "subscriberNumber": { "title": "subscriberNumber", "type": "string", "description": "Mobile Telephone Number associated with this serial number.", "minLength": 10, "maxLength": 10, "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))" }, "baseConfiguration": { "type": "array", "items": {}, "title": "baseConfiguration" }, "additionalConfiguration": { "type": "array", "items": {}, "title": "additionalConfiguration" }, "line": { "$ref": "#/components/schemas/lib_DeviceInfo" }, "agreement": { "type": "array", "items": {}, "title": "agreement" }, "productPrice": { "type": "array", "items": {}, "title": "productPrice" }, "productTerm": { "type": "array", "items": {}, "title": "productTerm" }, "relatedParty": { "type": "array", "items": {}, "title": "relatedParty" }, "subscriberStatus": { "title": "subscriberStatus", "type": "string" } }, "required": [ "line", "agreement", "productPrice" ] } ], "title": "ResellerMobileLineProduct" }, "lib_GroupSubscriberUsageDetail": { "type": "object", "title": "GroupSubscriberUsageDetail", "required": [ "SubscriberUsageDetail", "subscriberNumber" ], "properties": { "subscriberNumber": { "type": "string", "title": "subscriberNumber", "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))", "minLength": 10, "maxLength": 10, "description": "Mobile Telephone Number associated with this serial number." }, "SubscriberUsageDetail": { "type": "array", "items": {}, "title": "SubscriberUsageDetail" } } }, "lib_UnifiedMessagingParameters": { "type": "object", "title": "UnifiedMessagingParameters", "properties": { "mailBoxNumber": { "type": "string", "title": "mailBoxNumber", "maxLength": 10, "description": "The UM subscriber landline telephone number" }, "callForwardNumber": { "type": "string", "title": "callForwardNumber", "maxLength": 10, "description": "The call forward number." }, "voiceMailAccessNumber": { "type": "string", "title": "voiceMailAccessNumber", "maxLength": 10, "description": "The voice mail access number." } } }, "lib_ResellerMobileLineResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" }, { "type": "object", "properties": { "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "productOrderItem": { "type": "array", "items": {}, "title": "productOrderItem" } }, "required": [ "marketServiceInfo", "productOrderItem" ] } ], "title": "ResellerMobileLineResponse" }, "lib_GroupPlanOrSingleUserChoice": { "type": "object", "title": "GroupPlanOrSingleUserChoice", "properties": { "singleUserCode": { "type": "string", "title": "singleUserCode", "maxLength": 9, "description": "Price plan code for a single user recurring monthly charges. singleUserCode is required for MVNO. Resellers do not support group plans" }, "groupPlanDetails": { "$ref": "#/components/schemas/lib_GroupPlanDetailsInfo" } } }, "lib_AuxilliaryServiceParameters": { "type": "object", "title": "AuxilliaryServiceParameters", "required": [ "associatedSubscriberNumber", "service" ], "properties": { "ldc": { "type": "string", "title": "ldc", "maxLength": 5, "description": "The long distance carrier." }, "service": { "type": "string", "title": "service", "description": "The unique code for the service." }, "serviceArea": { "type": "string", "title": "serviceArea", "maxLength": 12, "description": "The service area/rate center where the associatedSubscriberNumber residesRequired - When the associateSubscriberNumber was retrieved from the available number poolOptional - When the associateSubscriberNumber is currently reserved to the acccount" }, "associatedSubscriberNumber": { "type": "string", "title": "associatedSubscriberNumber", "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))", "minLength": 10, "maxLength": 10, "description": "The subscriber number associated with the service. For services that require a new subscriber number, this will differ from the primary subscriber number." } } }, "lib_SharedDataGroupUsageSummary": { "type": "object", "title": "SharedDataGroupUsageSummary", "properties": { "groupId": { "type": "string", "title": "groupId", "description": "Shared Data GroupId" }, "primarySubscriber": { "type": "string", "title": "primarySubscriber", "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))", "minLength": 10, "maxLength": 10, "description": "Mobile Telephone Number associated with this serial number." } } }, "lib_RestrictedIdentificationInfo": { "type": "object", "title": "RestrictedIdentificationInfo", "required": [ "expirationDate", "idType", "idNumber", "issuingAuthority" ], "properties": { "idType": { "type": "string", "enum": [ "DL" ], "title": "idType", "description": "Identification Type DriversLicense = DL" }, "idNumber": { "type": "string", "title": "idNumber", "description": "Encrypted or Plain Text Personal Ids. Characters must be UPPER CASE. Ex:Drivers License Number and other personal Ids. Dashes are pass through characters. EFPE Format used to encrypt or decrypt this value: DRIVER_LIC_NUM" }, "expirationDate": { "type": "string", "title": "expirationDate", "pattern": ".+Z", "description": "Designates a date in UTC format. The following formats is accepted: YYYY-MM-DDZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - Z is a fixed character, indicating UTC time zone" }, "issuingAuthority": { "type": "string", "title": "issuingAuthority", "maxLength": 2, "description": "Identification Issuing Authority i.e. state code for Drivers Licenses" } } }, "lib_ProductOrderStateChangeEvent": { "type": "object", "title": "ProductOrderStateChangeEvent", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the Process flow" }, "href": { "type": "string", "title": "href", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderStateChangeEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_CancelProductOrderCreateEvent": { "type": "object", "title": "CancelProductOrderCreateEvent", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the Process flow" }, "href": { "type": "string", "title": "href", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrderCreateEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_ProductOrderDeleteEventPayload": { "type": "object", "title": "ProductOrderDeleteEventPayload", "properties": { "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" } ], "title": "productOrder", "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa," } } }, "lib_ResellerMobileLineItemResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/lib_ResellerMobileLineProductResponse" }, "response": { "description": "The object which holds the response code and description", "oneOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "title": "response" } } } ], "title": "ResellerMobileLineItemResponse" }, "lib_ProductOrderCreateEventPayload": { "type": "object", "title": "ProductOrderCreateEventPayload", "properties": { "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" } ], "title": "productOrder", "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa," } } }, "lib_ProductOfferingQualificationRef": { "type": "object", "title": "ProductOfferingQualificationRef", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PriorityAccessServiceParameters": { "type": "object", "title": "PriorityAccessServiceParameters", "required": [ "priorityLevel" ], "properties": { "priorityLevel": { "type": "string", "title": "priorityLevel" }, "specialHandling": { "type": "string", "title": "specialHandling", "description": "Value B indicates that the offering will handled as a bundled offering on Care side and additional offering on the Telegence side" } } }, "lib_InternationalOfferVoiceUsageInfo": { "type": "object", "title": "InternationalOfferVoiceUsageInfo", "required": [ "offerDescription", "includedMinutes", "offerCategory", "offerCode", "offerEffectiveDate", "offerExpirationDate" ], "properties": { "offerCode": { "type": "string", "title": "offerCode", "maxLength": 9, "description": "Cingular Billing System Code for an offering (Telegence SOC or CARE Feature)." }, "usedMinutes": { "type": "number", "title": "usedMinutes", "format": "double", "description": "The unbilled used minutes" }, "offerCategory": { "type": "string", "title": "offerCategory", "maxLength": 8 }, "overageMinutes": { "type": "number", "title": "overageMinutes", "format": "double", "description": "Overage minutes. The usage bucket’s Overage field will be returned when the subscriber’s Used minutes exceed the Included minutes. This will present the Pay-Per-Use Minutes." }, "includedMinutes": { "type": "number", "title": "includedMinutes", "format": "double", "description": "Included Minutes. 999999 indicates unlimited usage." }, "offerDescription": { "type": "string", "title": "offerDescription", "maxLength": 160, "description": "The offering Description. Returned on inquiries; not usually expected on input." }, "remainingMinutes": { "type": "number", "title": "remainingMinutes", "format": "double", "description": "allottedMinutes - used Minutes = remainingMinutes. 999999 indicates unlimited usage." }, "offerEffectiveDate": { "type": "string", "title": "offerEffectiveDate", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" }, "offerExpirationDate": { "type": "string", "title": "offerExpirationDate", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" } } }, "lib_EffectiveDatesWithoutTimeZoneInfo": { "type": "object", "title": "EffectiveDatesWithoutTimeZoneInfo", "required": [ "startDate" ], "properties": { "endDate": { "type": "string", "title": "endDate", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" }, "startDate": { "type": "string", "title": "startDate", "description": "Designates a date with no timezone information. The following formats is accepted: YYYY-MM-DD Where : - YYYY indicates the year - MM indicates the month - DD indicates the day" } } }, "lib_ResellerMobileLineProductResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductRefOrValue" }, { "type": "object", "properties": { "subscriberNumber": { "title": "subscriberNumber", "type": "string", "minLength": 10, "maxLength": 10, "pattern": "((\\d{10}|\\d{10})|((\\d{10}|\\d{10})|\\d{10}))" }, "subscriberStatus": { "title": "subscriberStatus", "type": "string" }, "line": { "$ref": "#/components/schemas/lib_DeviceInfo" } }, "required": [ "subscriberNumber", "subscriberStatus", "line" ] } ], "title": "ResellerMobileLineProductResponse" }, "lib_PortRequestLineCharacteristicValue": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_AnyCharacteristicValue" }, { "type": "object", "properties": { "portRequestLineId": { "title": "portRequestLineId", "type": "string" }, "npaNxx": { "title": "npaNxx", "type": "string" }, "fromLine": { "title": "fromLine", "type": "string" }, "toLine": { "title": "toLine", "type": "string" }, "equipmentType": { "title": "equipmentType", "type": "string" }, "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 }, "fulfillmentOrderId": { "title": "fulfillmentOrderId", "type": "string" } } } ], "title": "PortRequestLineCharacteristicValue" }, "lib_CancelProductOrderStateChangeEvent": { "type": "object", "title": "CancelProductOrderStateChangeEvent", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the Process flow" }, "href": { "type": "string", "title": "href", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrderStateChangeEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_ReferenceSubscriberOrGroupIdChoice": { "type": "object", "title": "ReferenceSubscriberOrGroupIdChoice", "properties": { "groupId": { "type": "string", "title": "groupId", "description": "The unique identifier of an existing group." }, "referenceSubscriber": { "type": "string", "title": "referenceSubscriber", "minLength": 10, "maxLength": 10, "description": "If present on requests, this is the subscriber number for one member of the group that this subscriber wants to join. If not present on requests, then a new group will be created for this subscriber and they will be made primary (regardless of the value for primarySubscriber). On responses this will be the group primary's subscriber number." } } }, "lib_InstallmentPlanDevicePaymentDetails": { "type": "object", "title": "InstallmentPlanDevicePaymentDetails", "properties": { "payUpAmount": { "type": "number", "title": "payUpAmount", "format": "double", "description": "Amount required to expedite the NEXT upgrade Trade-In eligibility. MRE will perform this calculation based on customers Upgrade Term, MSRP, and Total Outstanding Payments" }, "payOffAmount": { "type": "number", "title": "payOffAmount", "format": "double", "description": "Amount required to pay off the NEXT contract. MRE will perform this calculation based on customers MSRP, and the Total Amount Paid." }, "installmentTerms": { "type": "number", "title": "installmentTerms", "format": "int32", "description": "Total number of installments under the contract." }, "downPaymentAmount": { "type": "number", "title": "downPaymentAmount", "format": "double", "description": "Down payment amount" }, "totalAmountFinanced": { "type": "number", "title": "totalAmountFinanced", "format": "double", "description": "Total amount to be paid after downpayment. i.e, Total Financed (Device Price - Down Payment)." }, "installmentStartDate": { "type": "string", "title": "installmentStartDate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "remainingInstallments": { "type": "number", "title": "remainingInstallments", "format": "int32", "description": "Number of installment payments remaining for a NEXT customer to Pay-Up or Pay-Off their contract and become fully eligible or eligible to trade-in their device" }, "installmentSequenceNumber": { "type": "string", "title": "installmentSequenceNumber", "description": "lastInstallmentNumberBilled. Unique ID of Installment Plan." }, "installmentAmountPerMonth": { "type": "number", "title": "installmentAmountPerMonth", "format": "double", "description": "The installment amount per month" } } }, "lib_ProductOrderStateChangeEventPayload": { "type": "object", "title": "ProductOrderStateChangeEventPayload", "properties": { "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" } ], "title": "productOrder", "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa," } } }, "lib_VoiceActivatedDialingParametersInfo": { "type": "object", "title": "VoiceActivatedDialingParametersInfo", "required": [ "language" ], "properties": { "language": { "type": "string", "title": "language", "description": "The language preference. Default is English." }, "sequence": { "$ref": "#/components/schemas/lib_Sequence1" }, "numberExists": { "type": "string", "title": "numberExists", "description": "Indicates whether the number exists or not." } } }, "lib_ProductOfferingQualificationItemRef": { "type": "object", "title": "ProductOfferingQualificationItemRef", "required": [ "id", "productOfferingQualificationId" ], "properties": { "id": { "type": "string", "title": "id", "description": "Id of an item of a product offering qualification" }, "href": { "type": "string", "title": "href", "description": "Reference of the related entity." }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOfferingQualificationId": { "type": "string", "title": "productOfferingQualificationId", "description": "Unique identifier of a related entity." }, "productOfferingQualificationHref": { "type": "string", "title": "productOfferingQualificationHref", "description": "Reference of the related entity." }, "productOfferingQualificationName": { "type": "string", "title": "productOfferingQualificationName", "description": "Name of the related entity." } } }, "lib_ProductOrderInformationRequiredEvent": { "type": "object", "title": "ProductOrderInformationRequiredEvent", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderInformationRequiredEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "fieldPath": { "type": "string", "title": "fieldPath", "description": "The path identifying the object field concerned by this notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_CancelProductOrderCreateEventPayload": { "type": "object", "title": "CancelProductOrderCreateEventPayload", "properties": { "cancelProductOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } } }, "lib_ProductOrderAttributeValueChangeEvent": { "type": "object", "title": "ProductOrderAttributeValueChangeEvent", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrderAttributeValueChangeEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "fieldPath": { "type": "string", "title": "fieldPath", "description": "The path identifying the object field concerned by this notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_CancelProductOrderStateChangeEventPayload": { "type": "object", "title": "CancelProductOrderStateChangeEventPayload", "properties": { "cancelProductOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } } }, "lib_CancelProductOrderInformationRequiredEvent": { "type": "object", "title": "CancelProductOrderInformationRequiredEvent", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrderInformationRequiredEventPayload" } ], "title": "event", "description": "The event data structure" }, "domain": { "type": "string", "title": "domain", "description": "The domain of the event." }, "eventId": { "type": "string", "title": "eventId", "description": "The identifier of the notification." }, "priority": { "type": "string", "title": "priority", "description": "A priority." }, "eventTime": { "type": "string", "title": "eventTime", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "title": "eventType", "description": "The type of the notification." }, "fieldPath": { "type": "string", "title": "fieldPath", "description": "The path identifying the object field concerned by this notification." }, "description": { "type": "string", "title": "description", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "title": "timeOcurred", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "title": "correlationId", "description": "The correlation id for this event." } } }, "lib_ProductOrderInformationRequiredEventPayload": { "type": "object", "title": "ProductOrderInformationRequiredEventPayload", "properties": { "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" } ], "title": "productOrder", "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa," } } }, "lib_ProductOrderAttributeValueChangeEventPayload": { "type": "object", "title": "ProductOrderAttributeValueChangeEventPayload", "properties": { "productOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" } ], "title": "productOrder", "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa," } } }, "lib_CancelProductOrderInformationRequiredEventPayload": { "type": "object", "title": "CancelProductOrderInformationRequiredEventPayload", "properties": { "cancelProductOrder": { "oneOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } } } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF622", "message": "JWT Token is required" } } }, "description": "JWT Token is required." }, "trait_jwt_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF622", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF622", "message": "Internal Server Error" } } }, "description": "Error communicating with JWKS server." }, "trait_error-responses_400": { "content": { "application/json": { "example": { "code": "400", "reason": "Required header 'X-ATT-ConversationId' not specified", "status": "400-BAD_REQUEST-TMF622", "message": "Required header 'X-ATT-ConversationId' not specified" } } }, "description": "Bad request to the server." }, "trait_error-responses_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Unauthorized", "status": "401-UNAUTHORIZED-TMF622", "message": "Unauthorized" } } }, "description": "Invalid credentials." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF622", "message": "Forbidden" } } }, "description": "Issue with the credentials." }, "trait_error-responses_404": { "content": { "application/json": { "example": { "code": "404", "reason": "/productOrder1/", "status": "404-NOT_FOUND-TMF622", "message": "/productOrder1/" } } }, "description": "Requested resource no found." }, "trait_error-responses_405": { "content": { "application/json": { "example": { "code": "405", "reason": "HTTP Method get not allowed for : /productOrder/", "status": "405-METHOD_NOT_ALLOWED-TMF622", "message": "HTTP Method get not allowed for : /productOrder/" } } }, "description": "Requested method not supported." }, "trait_error-responses_406": { "content": { "application/json": { "example": { "code": "406", "error": "Not Acceptable", "reason": "Not Acceptable", "status": "405-UNACCEPTABLE-TMF622" } } }, "description": "Unacceptable request body." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported mediaType", "status": "415-UNSUPPORTED_MEDIA_TYPE-TMF622", "message": "Unsupported mediaType" } } }, "description": "Bad Content-Type header. Unsupported media type." }, "trait_error-responses_500": { "content": { "application/json": { "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF622", "message": "Internal Server Error" } } }, "description": "Processing error for the request." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token_type", "expires_in", "ext_expires_in", "access_token" ], "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "number", "format": "int", "example": 3599 }, "access_token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "ext_expires_in": { "type": "number", "format": "int", "example": 3599 } } } } }, "description": "No description provided" }, "securityScheme_ATT_Azure_AD_JWT_Token_400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "error_description", "error_codes", "timestamp", "trace_id", "correlation_id", "error_uri" ], "properties": { "error": { "type": "string", "example": "unauthorized_client" }, "trace_id": { "type": "string", "example": "b82bea2f-5ee3-48a4-9774-4143176a6900" }, "timestamp": { "type": "string", "example": "2021-06-30 21:12:34Z" }, "error_uri": { "type": "string", "example": "https://login.microsoftonline.com/error?code=700016" }, "error_codes": { "type": "array", "items": { "type": "number", "format": "int", "example": 700016 } }, "correlation_id": { "type": "string", "example": "b57403ef-e775-49f6-b40f-009ba759c301" }, "error_description": { "type": "string", "example": "AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\\r\\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\\r\\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\\r\\nTimestamp: 2021-06-30 21:12:34Z" } } } } }, "description": "No description provided" } }, "callbacks": {}, "parameters": { "trait_headers_Accept": { "in": "header", "name": "Accept", "schema": { "type": "string", "default": "application/json" }, "required": true, "description": "Specifies the media type as \"application/json\"." }, "trait_headers_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "Valid JSON Web Token." }, "trait_headers_X-ATT-ClientId": { "in": "header", "name": "X-ATT-ClientId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 derived from the JSON Web Token which represents the ClientId of the API Consumer who initiated the call flow at the Mule Gateway. This is used by downstream APIs to log data about the entity which initiated the call flow." }, "trait_headers_X-ATT-CorrelationId": { "in": "header", "name": "X-ATT-CorrelationId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 provided by the client that typically serves as a reference ID used to correlate client activity with transactions processed by the server. It is generally paired with the X-ATT-ConversationId to help with tracing and observability." }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {} } }