{ "info": { "title": "ATT APIs based on TMF637(v4.0.0) - Product Inventory - ResellerMobileLine", "version": "4.0.0", "description": "The Product Inventory Management API provides standardized mechanism for product inventory management such as creation, update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle." }, "paths": { "/healthz": { "get": { "security": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Application up and running", "application_name": "tmf637-productInventory-ResellerMobileLine" } } }, "description": "Success" } }, "description": "Health Check" } }, "/product": { "get": { "summary": "listProduct", "responses": { "200": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Customer" } ], "title": "response" } } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "400", "reason": "Required header 'X-ATT-ConversationId' not specified", "status": "400-BAD_REQUEST-TMF637", "message": "Required header 'X-ATT-ConversationId' not specified" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "401", "reason": "Unauthorized", "status": "401-UNAUTHORIZED-TMF637", "message": "Unauthorized" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF637", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF637", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF637", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "queryString", "required": true, "in": "query", "schema": { "$ref": "#/components/schemas/qp_QueryParamsWithEquipIdSelector" } }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "description": "List or find Product objects. (TMF 637)", "x-page-slug": "list-product", "operationId": "listProduct" } }, "/product/{id}": { "get": { "summary": "Inquire subscriber profile", "responses": { "200": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineProduct" } ], "title": "response" } } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF637", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF637", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF637", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF637", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF637", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "queryString", "required": true, "in": "query", "schema": { "$ref": "#/components/schemas/qp_QueryParamsWithSubScriberNumber" } }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "description": "This operation retrieves subscriber profile using the subscriber number as ID. (TMF 637)", "x-page-slug": "subscriber-profile", "operationId": "retrieveSubscriberProfileBySubscriberNumber" }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "pattern": "^\\d{10}$" }, "description": "ID is the subscriberNumber to check the subscriber profile." } ] } }, "openapi": "3.0.3", "security": [ { "ATT-Azure-AD-JWT-Token": [] } ], "components": { "links": {}, "schemas": { "lib_Note": { "type": "object", "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" } }, "description": "Extra information about a given entity" }, "lib_Money": { "type": "object", "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" } }, "description": "A base / value business entity used to represent money" }, "lib_Error": { "type": "object", "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" } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "lib_Price": { "type": "object", "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": { "allOf": [ { "$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": { "allOf": [ { "$ref": "#/components/schemas/lib_Money" } ], "title": "taxIncludedAmount", "description": "A base / value business entity used to represent money" } }, "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration." }, "lib_Place": { "type": "object", "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" } }, "description": "Place reference. Place defines the places where the products are sold or delivered." }, "lib_Product": { "type": "object", "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": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "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": { "$ref": "#/components/schemas/lib_ProductRefOrValue" }, "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": { "$ref": "#/components/schemas/lib_AgreementItemRef" }, "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": { "$ref": "#/components/schemas/lib_ProductTerm" }, "title": "productTerm" }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ProductPrice" }, "title": "productPrice" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "billingAccount": { "allOf": [ { "$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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_RelatedProductOrderItem" }, "title": "productOrderItem" }, "realizingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRef" }, "title": "realizingService" }, "isCustomerVisible": { "type": "boolean", "title": "isCustomerVisible", "description": "If true, the product is visible by the customer." }, "realizingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" }, "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": { "$ref": "#/components/schemas/lib_ProductRelationship" }, "title": "productRelationship" }, "productSpecification": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_Characteristic" }, "title": "productCharacteristic" } }, "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s)." }, "lib_LteInfo": { "type": "object", "properties": { "imsCpmId": { "type": "string", "maxLength": 4, "description": "ID of network element for LTE provisioning to CPM" }, "imsHssId": { "type": "string", "maxLength": 4, "description": "ID of network element for LTE provisioning to HSS" }, "imsTASId": { "type": "string", "maxLength": 4, "description": "ID of network element for LTE provisioning to TAS" } } }, "lib_Quantity": { "type": "object", "properties": { "units": { "type": "string", "title": "units", "description": "Unit" }, "amount": { "type": "number", "title": "amount", "format": "double", "default": 1, "description": "Numeric value in a given unit" } }, "description": "An amount in a given unit" }, "lib_Sequence": { "type": "object", "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", "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" } }, "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered." }, "lib_NameInfo": { "type": "object", "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.)" }, "doingBusinessAs": { "type": "string", "description": "Doing Business As" } } }, "lib_QuoteRef": { "type": "object", "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" } }, "description": "It's a Quote that has been executed previously" }, "lib_Customer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "businessName": { "title": "businessName", "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.", "type": "string" }, "familyName": { "title": "familyName", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context", "type": "string" }, "generation": { "title": "generation", "description": "e.g.. Sr, Jr, III (the third),…", "type": "string" }, "givenName": { "title": "givenName", "description": "First name of the individual", "type": "string" }, "middleName": { "title": "middleName", "description": "Middles name or initial", "type": "string" }, "ContactInformation": { "allOf": [ { "$ref": "#/components/schemas/lib_ContactInformation" } ], "description": "Contact name and ppu address associated with the service area for the subscriber number(s).", "title": "ContactInformation" }, "title": { "title": "title", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ...", "type": "string" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name", "type": "string" } }, "description": "Customer represents a single human being. The individual can be a customer, or the contact for a business." } ], "title": "Customer" }, "lib_UnitInfo": { "type": "object", "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_PortInfo": { "type": "object", "required": [ "portNumber", "portType" ], "properties": { "portType": { "type": "string", "description": "type of the usage of port. Valid values: V-voice, usage, D-data" }, "portNumber": { "type": "integer", "description": "example values: 1, 2, 3, 4" } } }, "lib_EntityRef": { "type": "object", "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" } }, "description": "Entity reference schema to be use for all entityRef class." }, "lib_PhoneInfo": { "type": "object", "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", "required": [ "code" ], "properties": { "code": { "type": "string", "title": "code" }, "description": { "type": "string", "title": "description" } } }, "lib_OrderTerm": { "type": "object", "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": { "allOf": [ { "$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" } }, "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration" }, "lib_Sequence1": { "type": "object", "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", "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", "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_CopayInfo": { "type": "object", "required": [ "receivingBan", "allowanceId", "enrollDate" ], "properties": { "enrollDate": { "type": "string", "format": "date-time", "description": "The Date the Subscriber was enrolled in Copay" }, "allowanceId": { "type": "string", "maxLength": 30, "description": "The Allowance ID which indicates the Allowance Amount that will be paid" }, "receivingBan": { "type": "string", "description": "The BAN that will pay the Allowance Amount for the Subscriber" }, "deEnrollDate": { "type": "string", "format": "date-time", "description": "The Date the Subscriber was de-enrolled in Copay" }, "effectiveDate": { "type": "string", "format": "date-time", "description": "The Effective Date of the Alloance ID" }, "expirationDate": { "type": "string", "format": "date-time", "description": "The Date the enrollement to the Allowance ID and receiving Account Number expires." } } }, "lib_GroupInfo": { "type": "object", "properties": { "groupId": { "type": "string", "description": "group id of the group" }, "groupMemEffDate": { "type": "string", "description": "Group Member Effective Date ( YYYYMMDD)" }, "groupMemExpDate": { "type": "string", "description": "Group Member Expiration Date (YYYYMMDD)" } } }, "lib_TimePeriod": { "type": "object", "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" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "lib_ProductRef": { "type": "object", "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", "description": "Primary Dealer (/Agent/Comp) code", "type": "string", "maxLength": 6 }, "secondaryCode": { "title": "secondaryCode", "description": "Secondary Dealer (/Agent/Comp) code. Required in some Cingular markets. Contact Cingular business team for details.", "type": "string", "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" } }, "description": "A Party object representing the Commission object" } ], "title": "Commission" }, "lib_ServiceRef": { "type": "object", "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" } }, "description": "Service reference, for when Service is used by other entities" }, "lib_PaymentRef": { "type": "object", "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" } }, "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order." }, "lib_OrderPrice": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "A short descriptive name such as \"Subscription price\"." }, "price": { "allOf": [ { "$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": { "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "priceAlteration": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PriceAlteration" }, "title": "priceAlteration", "description": "a strucuture used to describe a price alteration" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "productOfferingPrice": { "allOf": [ { "$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..." } }, "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order" }, "lib_DeviceInfo": { "type": "object", "required": [ "equipmentType", "technologyType" ], "properties": { "sim": { "type": "string", "minLength": 18, "maxLength": 20 }, "esn": { "type": "string", "maxLength": 11 }, "min": { "type": "string", "maxLength": 10 }, "sku": { "type": "string", "minLength": 1, "maxLength": 25 }, "imsi": { "type": "string", "maxLength": 15 }, "imei": { "type": "string", "maxLength": 15, "description": "IMEI is a required field when performing Swap of the Cross Upgrade Equipment" }, "msid": { "type": "string", "maxLength": 15 }, "osType": { "type": "string", "maxLength": 20 }, "lteType": { "type": "string", "description": "Indicates the LTE type if LTE capable. Valid Values: 5 - LTE Data only, 6 - LTE Data and Voice w/CSFB only, 7 - LTE Data and Voice w/IMS/CSFB. If not populated; device is not lte capability" }, "esnType": { "type": "string", "description": "The assigned ElectronicSerialNumber Type. 'A' = analog, 'D' = digital" }, "imeiType": { "type": "string", "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." }, "uiccCode": { "type": "string", "enum": [ "A", "B" ], "description": "The UICC indicator which determines ISIM capable (UICC-B) or non-ISIM (UICC-A) capable sim cards. UICC-A - Indicates that the SIM is non-ISIM capable. UICC-B - Indicates that the SIM is ISIM capable" }, "dcapValue": { "type": "string", "maxLength": 2 }, "osVersion": { "type": "string", "maxLength": 50 }, "simStatus": { "type": "string", "maxLength": 1, "description": "possible values: A-active, E-expire" }, "manufacturer": { "$ref": "#/components/schemas/lib_ManufacturerInfo" }, "imsiPublicId": { "type": "string", "maxLength": 75, "description": "Additional IMSI-Based Public Id for UICC- G SIM" }, "equipmentType": { "type": "string", "enum": [ "C", "G" ], "description": "Equipment type (Cellular = C, GSM = G)" }, "imeiFrequency": { "type": "string", "description": "Device Frequency 850, 900, 1800, 1900" }, "nfcCapability": { "type": "string", "description": "NFC (Near Field Communication)Capability of the device" }, "uiccPublicKey": { "type": "string", "description": "UICC - A smart card for a 3G handset using UMTS" }, "effectiveDate": { "type": "string", "format": "date-time" }, "technologyType": { "type": "string", "enum": [ "GSM", "TDMA", "GSM-GAIT", "GAIT", "TDMA-GAIT", "GSM-UMTS", "UMTS", "LTE" ], "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", "description": "The UMTS Capability of the device" }, "uiccPrivateKey": { "type": "string", "description": "UICC - A smart card for a 3G handset using UMTS" }, "pcCardIndicator": { "type": "integer", "description": "The device is a PC Card that is used for data only, not voice." }, "eidDataIndicator": { "type": "string", "maxLength": 4, "description": "possible values: True" }, "imeiDeviceFirmware": { "$ref": "#/components/schemas/lib_ImeiDeviceFirmwareInfo" }, "imeiSofwareVersion": { "type": "string" }, "pinUnblockingCode1": { "type": "string", "description": "Pin Unblocking Code 1 (PUK1) Populated only for SIM which are not in parked state" }, "pinUnblockingCode2": { "type": "string", "description": "Pin Unblocking Code 2 (PUK2) Populated only for SIM which are not in parked state" }, "smsCapabilityIndicator": { "type": "string", "description": "The SMS Capability of the device" }, "deviceCertificationStatus": { "type": "string" } } }, "qp_SIMSelector": { "type": "object", "required": [ "line.sim" ], "properties": { "line": {} }, "additionalProperties": false }, "qp_emptyParams": { "type": "object", "additionalProperties": false }, "lib_AddressInfo": { "type": "object", "properties": { "Zip": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressZipInfo" } ], "title": "Zip" }, "Unit": { "allOf": [ { "$ref": "#/components/schemas/lib_UnitInfo" } ], "title": "Unit" }, "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": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressStreetInfo" } ], "title": "Street" }, "County": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressCountyInfo" } ], "title": "County" }, "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": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressRuralRouteInfo" } ], "title": "RuralRoute" }, "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'" } }, "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_PrePaidInfo": { "type": "object", "required": [ "prePaidPin" ], "properties": { "prePaidPin": { "type": "string", "title": "prePaidPin", "description": "PIN number for prepaid accounts." } } }, "lib_ProductTerm": { "type": "object", "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": { "allOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "title": "duration", "description": "An amount in a given unit" }, "validFor": { "allOf": [ { "$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" } }, "description": "Description of a productTerm linked to this product. This represent a commitment with a duration" }, "lib_CancelOrder": { "type": "object", "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" } }, "description": "A Order cancel is a type of task which can be used to place a request to cancel an order" }, "lib_ResourceRef": { "type": "object", "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" } } }, "qp_IMEISelector": { "type": "object", "required": [ "line.imei" ], "properties": { "line": {} }, "additionalProperties": false }, "lib_RelatedParty": { "type": "object", "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" } }, "description": "Related Entity reference. A related party defines party or party role linked to a specific entity." }, "lib_ProductOrder": { "type": "object", "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": { "$ref": "#/components/schemas/lib_Note" }, "title": "note" }, "quote": { "type": "array", "items": { "$ref": "#/components/schemas/lib_QuoteRef" }, "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": { "$ref": "#/components/schemas/lib_RelatedChannel" }, "title": "channel" }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PaymentRef" }, "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": { "$ref": "#/components/schemas/lib_AgreementRef" }, "title": "agreement", "description": "A reference to an agreement defined in the context of the product order" }, "@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": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "completionDate": { "type": "string", "title": "completionDate", "format": "date-time", "description": "Date when the order was completed" }, "billingAccount": { "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderPrice" }, "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": { "$ref": "#/components/schemas/lib_ProductOrderItem" }, "title": "productOrderItem", "minItems": 1, "uniqueItems": false }, "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": { "$ref": "#/components/schemas/lib_ProductOfferingQualificationRef" }, "title": "productOfferingQualification" } }, "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_ProductPrice": { "type": "object", "required": [ "priceType", "price" ], "properties": { "name": { "type": "string", "title": "name", "description": "A short descriptive name such as \"Subscription price\"." }, "price": { "allOf": [ { "$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": { "allOf": [ { "$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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_PriceAlteration" }, "title": "productPriceAlteration" } }, "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time." }, "lib_QuoteItemRef": { "type": "object", "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" } }, "description": "It's a Quote item that has been executed previously." }, "lib_ResponseCode": { "type": "object", "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" } }, "description": "The object which holds the response code and description" }, "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", "required": [ "offeringCode" ], "properties": { "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" }, "imsIndicator": { "type": "string" }, "offeringType": { "type": "string", "description": "Type of soc. A - Additional Offering, B - Bundle Offering" }, "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" }, "gprsIndicator": { "type": "boolean", "description": "indicator showing if the soc is GPRS compatible" }, "splitLiability": { "allOf": [ { "$ref": "#/components/schemas/lib_SplitLiabilityInfo" } ], "title": "splitLiability" }, "effectiveDates": { "allOf": [ { "$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" }, "sequenceNumber": { "type": "number" }, "offeringCharge": { "type": "number" }, "umtsCompatible": { "type": "string", "description": "Indicator showing if the soc is UMTS compatible. valid values include U, B, N, R" }, "sharedDataGroup": { "$ref": "#/components/schemas/lib_SharedDataGroupInfo" }, "offeringFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingFeatureInfo" }, "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.," }, "offeringUsagePool": { "$ref": "#/components/schemas/lib_UsagePoolingInfo" }, "mobileSessionData": { "$ref": "#/components/schemas/lib_MobileSessionDataInfo" }, "payPerUseIndicator": { "type": "string", "title": "payPerUseIndicator" }, "offeringCommission": { "$ref": "#/components/schemas/lib_DealerCommissionInfo" }, "offeringSwitchCode": { "type": "string", "description": "Switch Code of the SOC/feature. Applicable only on inquiry" }, "offeringDescription": { "type": "string", "title": "offeringDescription", "maxLength": 160 }, "productIMSIndicator": { "type": "string", "title": "productIMSIndicator" }, "offeringServiceType": { "type": "string" }, "offeringNetworkType": { "type": "string", "enum": [ "A", "B", "D", "O", "M" ], "description": "Indicates the network where the offering can be used valid values include A, B, D, O, M" }, "offeringEligible777": { "type": "string", "description": "Flag showing if the soc is 777 compatible" }, "valueAddedParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_ValueAddedParameterInfo" } ], "title": "valueAddedParameters" }, "buyOneGetOneOfferings": { "type": "string" }, "offeringAssociatedLDC": { "type": "string", "maxLength": 5 }, "productCategoryIndicator": { "type": "number", "title": "productCategoryIndicator" }, "offeringPromotionEndDate": { "type": "string", "format": "date-time" }, "offeringEffectiveBillDates": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "discountedFeaturePlanIndicator": { "type": "string", "title": "discountedFeaturePlanIndicator" }, "offeringIntegratedMsgIndicator": { "type": "boolean" }, "offeringMaintenanceRestriction": { "type": "string", "description": "restriction level of SOC" }, "offeringTransferFeatureIndicator": { "type": "boolean" }, "offeringBundledDiscountIndicator": { "type": "boolean", "description": "Indicates if this feature represents a combined bill discount. It is available only for Care subscribers." }, "offeringIntegrationFeatureIndicator": { "type": "boolean" }, "offeringPrimarySharedDataPlanIndicator": { "type": "boolean", "description": "Indicates the offering is a Primary Shared Data Plan." } } }, "lib_AgreementRef": { "type": "object", "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" } }, "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." }, "lib_ResponseInfo": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "type": "string" }, "description": { "type": "string" } }, "description": "The object which holds the response code and description" }, "lib_FirstNetInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "FirstNet Type. Valid values V1/V2/Null" }, "indicator": { "type": "string", "description": "Indicates if a subscriber is FN (FirstNet). Valid Values Y - FN Effective; P - FN Parked; Null - non-FN" } } }, "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", "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", "properties": { "cbDiscount": { "type": "string", "title": "cbDiscount", "description": "Returns true if any of the subscribers under the account has the CB/WRD discount" }, "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_OfferingInfo" }, "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": { "$ref": "#/components/schemas/lib_NameValuePair" }, "title": "pricePlanAttributes", "description": "An optional recurring structure that allows the passing of additional characteristics of a Price Plan.Usually passed as a Name and a Boolean of trueExamples include: Mobile Control, Real TIme Provisioning, etc." }, "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": { "$ref": "#/components/schemas/lib_SubMarketInfo" }, "title": "restrictedSubMarkets" }, "originalRatePlanCode": { "type": "string", "title": "originalRatePlanCode", "description": "This will be return during Change rate plan transactions from PDC" }, "groupPlanOrSingleUserChoice": { "allOf": [ { "$ref": "#/components/schemas/lib_GroupPlanOrSingleUserChoice" } ], "title": "groupPlanOrSingleUserChoice" } } }, "lib_M2xParameters": { "type": "object", "required": [ "telephoneNumber" ], "properties": { "telephoneNumber": { "type": "string", "title": "telephoneNumber", "maxLength": 10, "description": "The customer's landline telephone number." } }, "description": "The landline telephone number used in conjunction with the M2H (MobileToHome) feature." }, "lib_DataUsageInfo": { "type": "object", "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" } }, "description": "Unbilled Usage buckets information." }, "lib_ResellerParty": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "longDistanceCarrier": { "allOf": [ { "$ref": "#/components/schemas/lib_LongDistanceCarrierInfo" } ], "title": "longDistanceCarrier" } } } ], "title": "ResellerParty" }, "lib_NameValuePair": { "type": "object", "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": { "allOf": [ { "$ref": "#/components/schemas/lib_PricePlanPriceOnlyInfo" } ], "title": "pricePlan" } }, "required": [ "pricePlan" ] } ], "title": "ResellerPrice" }, "lib_DiscountsInfo": { "type": "object", "required": [ "action", "code" ], "properties": { "code": { "type": "string", "maxLength": 9 }, "action": { "type": "string", "maxLength": 1 }, "wrdFlag": { "type": "string", "description": "flag showing if SOC is wireless retail discount compatible" }, "billDates": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "instanceId": { "type": "integer", "description": "Unique id for specific instance of discount. Required when deleting an existing discount since it is possible for the same discount code to be associated multiple times with the same account/subscriber (i.e. different effective dates)." }, "description": { "type": "string", "maxLength": 30, "description": "The description for this discount code. Returned on inquiries. Not expected for add or remove actions." }, "imsIndicator": { "type": "string", "description": "The IMS feature indicator, Y - IMS Feature, A - IMS Auto-Attach Feature, N/Blank - Non IMS Feature" }, "blsIndicator": { "type": "string", "description": "flag showing if SOC is BLS compatible" }, "gprsIndicator": { "type": "string", "description": "Indicator showing if the discount is GPRS compatible" }, "fanMACDiscout": { "type": "string", "description": "indicates a fan MAC discount" }, "fanMSCDiscout": { "type": "string", "description": "indicates a fan MAC discount" }, "effectiveDates": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "discountAmount": { "$ref": "#/components/schemas/lib_DiscountAmountInfo" }, "offeringNetworkType": { "type": "string", "maxLength": 1, "description": "Indicates the network the discount can be used" }, "sbsDiscountIndicator": { "type": "boolean", "description": "This flag indicates that this discount is an SBS Bundle Discount." }, "umtsCompatibleIndicator": { "type": "string", "maxLength": 1, "description": "Indicator showing if the discount is UTMS compatible" } } }, "lib_AddressZipInfo": { "type": "object", "required": [ "zipCode" ], "properties": { "zipCode": { "type": "string", "title": "zipCode", "pattern": "^\\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}$", "minLength": 4, "maxLength": 4, "description": "Zip code extension used with Zip+4" } } }, "lib_MobileLineInfo": { "type": "object", "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": { "allOf": [ { "$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": { "allOf": [ { "$ref": "#/components/schemas/lib_ImeiDeviceFirmwareInfo" } ], "title": "imeiDeviceFirmware" }, "imeiSofwareVersion": { "type": "string", "title": "imeiSofwareVersion" }, "smsCapabilityIndicator": { "type": "string", "title": "smsCapabilityIndicator", "description": "The SMS Capability of the device" }, "deviceCertificationStatus": { "type": "string", "title": "deviceCertificationStatus" } } }, "lib_SubscriberInfo": { "type": "object", "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": { "allOf": [ { "$ref": "#/components/schemas/lib_ErrorInfo" } ], "title": "error" }, "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", "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" } }, "description": "Related channel to another entity. May be online web, mobile app, social ,etc." }, "lib_VvpnParameters": { "type": "object", "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." } }, "description": "The vvpn additional parameters." }, "lib_AppointmentRef": { "type": "object", "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" } }, "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit" }, "lib_Characteristic": { "type": "object", "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" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "lib_WwifParameters": { "type": "object", "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." } }, "description": "WWIF parameters" }, "lib_EmailParameters": { "type": "object", "required": [ "domain", "boxName" ], "properties": { "domain": { "type": "string", "title": "domain", "description": "The domain id." }, "boxName": { "type": "string", "title": "boxName", "description": "The email box name." } }, "description": "The email box additional parameters." }, "lib_PriceAlteration": { "type": "object", "required": [ "priceType", "price" ], "properties": { "name": { "type": "string", "title": "name", "description": "Name of the order item price alteration" }, "price": { "allOf": [ { "$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": "integer", "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": "integer", "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": { "allOf": [ { "$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..." } }, "description": "Is an amount, usually of money, that modifies the price charged for an order item." }, "lib_ProductOrderRef": { "type": "object", "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" } }, "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with." }, "lib_PlanDetailsInfo": { "type": "object", "properties": { "counterType": { "type": "string", "title": "counterType", "minLength": 0, "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": "integer", "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": "integer", "title": "referenceMaximumAllowedCountForPlan", "format": "int32", "description": "Reference max allowed numbers counter per plan type" } }, "description": "Details about different upgrade plans : e.g. IP (Installment plan) TT (Next + Installment) , EIP -> Equipment Installment Plan etc." }, "lib_SwitchParameter": { "type": "object", "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_PortDetailsInfo": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Indicates the status of the overall port request 001 – Confirmed, 002 - Delayed 003 - Resolution Required/Validation Failure 004 - Conflict 005 - Porting/Timer Expired 006 - Completed 007 - Canceled/Pending Cancel 101 - New/Submitted 901 - Resending 999 - Error" }, "actionId": { "type": "string", "description": "Action id possible values are SUP3, PR2, PRA" }, "actionStatus": { "type": "string", "description": "Action Status possible values are S = Success or F = Fail" } } }, "lib_CrossMarketInfo": { "type": "object", "properties": { "localMarket": { "type": "string", "minLength": 3, "maxLength": 3, "description": "All valid values of the market" }, "localSubMarket": { "type": "string", "minLength": 3, "maxLength": 3, "description": "The sub market for NCI cross market subscribers. All valid values of the submarket" }, "crossMarketIndicator": { "type": "boolean", "description": "True value means an indication of cross market subscriber." } } }, "lib_VanityNumberInfo": { "type": "object", "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", "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" } }, "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." }, "lib_PdpParameterInfo": { "type": "object", "required": [ "pdpName" ], "properties": { "snType": { "type": "string", "maxLength": 30, "description": "Actual values can be IPV4 or IPV6 or IPV4V6" }, "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": { "allOf": [ { "$ref": "#/components/schemas/lib_Sequence" } ], "title": "sequence" }, "defSNType": { "type": "string", "maxLength": 30, "description": "Actual values can be IPV4 or IPV6 or IPV4V6" }, "dnnDefName": { "type": "string", "maxLength": 30, "description": "Default DNN Name." }, "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" }, "dnnIndicator": { "type": "boolean", "description": "A Y/N Indicator; Y - DNN." }, "is5GIndicator": { "type": "string", "description": "A Y/N Indicator. Y - 5G" }, "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", "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", "required": [ "businessName", "contact" ], "properties": { "contact": { "allOf": [ { "$ref": "#/components/schemas/lib_NameInfo" } ], "title": "contact" }, "businessName": { "type": "string", "title": "businessName", "description": "Business Name" } } }, "lib_ManufacturerInfo": { "type": "object", "properties": { "make": { "type": "string", "title": "make" }, "model": { "type": "string", "title": "model" }, "marketingName": { "type": "string", "title": "marketingName", "description": "Device friendly name" } }, "description": "Manufacturer related identification information" }, "lib_ReasonDetailInfo": { "type": "object", "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", "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" } }, "description": "Unbilled Usage buckets information." }, "lib_ContractTermInfo": { "type": "object", "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" }, "reasonCode": { "type": "string", "enum": [ "DSC", "EQU", "EXC", "COR", "SMO", "APL", "APE", "PND", "ATM", "ATM1", "ATM2", "ATM3", "PPD", "RPC", "EEU", "COW", "DLU", "STC", "EMR", "EQD", "MAN" ], "title": "reasonCode", "maxLength": 4, "description": "This is the reason for the contract" }, "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "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", "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": { "$ref": "#/components/schemas/lib_PaymentRef" }, "title": "payment" }, "product": { "allOf": [ { "$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": "integer", "title": "quantity", "format": "int32", "description": "Quantity ordered" }, "itemTerm": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderTerm" }, "title": "itemTerm" }, "itemPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderPrice" }, "title": "itemPrice" }, "quoteItem": { "allOf": [ { "$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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_ProductOfferingQualificationRef" }, "title": "qualification" }, "billingAccount": { "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "itemTotalPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderPrice" }, "title": "itemTotalPrice" }, "productOffering": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_ProductOrderItem" }, "title": "productOrderItem" }, "productOrderItemRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderItemRelationship" }, "title": "productOrderItemRelationship" }, "productOfferingQualificationItem": { "allOf": [ { "$ref": "#/components/schemas/lib_ProductOfferingQualificationItemRef" } ], "title": "productOfferingQualificationItem", "description": "It's a productOfferingQualification item that has been executed previously." } }, "description": "An identified part of the order. A product order is decomposed into one or more order items." }, "lib_SwitchDetailInfo": { "type": "object", "required": [ "featureCode", "switchParameter" ], "properties": { "featureCode": { "type": "string", "title": "featureCode", "description": "The Feature Code." }, "switchParameter": { "type": "array", "items": { "$ref": "#/components/schemas/lib_SwitchParameter" }, "title": "switchParameter" } } }, "lib_NbiMigrationInfo": { "type": "object", "properties": { "migrationDate": { "type": "string", "format": "date-time", "description": "Date the migration has or will take place" }, "migrationStatus": { "type": "string", "description": "The account status" }, "marketMigratedTo": { "type": "string", "maxLength": 3, "description": "The market of the account will be or has been migrated to." }, "accountMigratedTo": { "type": "string", "description": "The NBI account number" }, "marketMigratedFrom": { "type": "string", "maxLength": 3, "description": "The local market" }, "accountMigratedFrom": { "type": "string", "description": "The local market account number" }, "subMarketMigratedFrom": { "type": "string", "maxLength": 3, "description": "The local subMarket" } } }, "lib_CareContractInfo": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "The CARE contract code" }, "sequenceNumber": { "type": "number", "description": "The contract sequence number for CARE. Only returned/applicable on inquiry request." } } }, "qp_CommonQueryParams": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ResellerMobileLine" ], "description": "To specify the type of the API out of potentially multiple tmf637 APIs." }, "dealer": { "type": "string", "example": "1234,1235:33,6799:9", "description": "a string concatenationg an array of [{dealer.code, dealer.secondaryCode}] where dealer.code is required and dealer.secondaryCode optional in each item with both values being strings of length of 6 or less. The delimitor for items is \",\" and the one to seperate dealer.code and dealer.secondaryCode is \":\"." }, "fields": { "type": "string", "description": "Comma-separated properties specified here will be provided in response. Not in effect." }, "spendUsageCapIndicator": { "type": "boolean", "description": "This will be used to get spend cap and usage cap related to ADTM. Valid for DU mask." }, "includePortDetailsIndicator": { "type": "boolean", "description": "true value will return port details from wireless ban." } }, "additionalProperties": false }, "qp_AccountIdentifier": { "type": "object", "required": [ "billingAccountNumber" ], "properties": { "accountId": {}, "equipmentType": { "type": "string", "enum": [ "C", "G" ], "minLength": 1 }, "billingAccountNumber": { "type": "string", "pattern": "^(\\d{8}|\\d{9}|\\d{12})$" } }, "additionalProperties": false }, "lib_ProductRefOrValue": { "type": "object", "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": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "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": { "$ref": "#/components/schemas/lib_AgreementItemRef" }, "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": { "$ref": "#/components/schemas/lib_ProductTerm" }, "title": "productTerm" }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ProductPrice" }, "title": "productPrice" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "billingAccount": { "allOf": [ { "$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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_RelatedProductOrderItem" }, "title": "productOrderItem" }, "realizingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRef" }, "title": "realizingService" }, "isCustomerVisible": { "type": "boolean", "title": "isCustomerVisible", "description": "If true, the product is visible by the customer." }, "realizingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" }, "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": { "$ref": "#/components/schemas/lib_ProductRelationship" }, "title": "productRelationship" }, "productSpecification": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_Characteristic" }, "title": "productCharacteristic" } }, "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" }, "lib_ResellerAgreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_AgreementItemRef" }, { "type": "object", "properties": { "contractTerm": { "allOf": [ { "$ref": "#/components/schemas/lib_ContractTermInfo" } ], "title": "contractTerm" }, "contractType": { "title": "contractType", "type": "string", "enum": [ "S", "E" ] }, "termsConditionsStatus": { "title": "termsConditionsStatus", "description": "this value can only be \"N\"", "type": "string", "maxLength": 1, "enum": [ "B", "C", "E", "I", "N", "P", "S", "T", "V", "W", "X", "Y" ] }, "waiveActivationFeeReasonCode": { "title": "waiveActivationFeeReasonCode", "description": "The reason for waiving the activation fee.", "type": "string" }, "suspendImmediately": { "title": "suspendImmediately", "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.", "type": "boolean" }, "reasonCode": { "description": "The reason code for the commitment declaration or modification. Upgrade DSC - Equipment Upgrade with Discount EQU - Standard Equipment Upgrade EXC - Exception Equipment Upgrade EEU - Early Equipment Upgrade Regular COR - Correction Change Commitment SMO - Special Marketing Offer APL - Apple only APE - Apple activation EMR - Emerald Equipment Offer Pending PND - Pending Upgrade Move ATM - Account Type Move (TLG) ATM1 - 1 Year (Care) ATM2 - 2 Year (Care) ATM3 - 3 Year (Care) Deprecated (Cannot use for new contracts) PPD - Standard Upgrade RPC - Rate Plan Change", "type": "string", "enum": [ "APE", "APL", "ATM", "ATM1", "ATM2", "ATM3", "COR", "DSC", "EEU", "EMR", "EQU", "EXC", "PND", "PPD", "RPC", "SMO" ] }, "commitmentReasonCode": { "description": "EMR indicates subscriber has associated Emerald contract", "type": "string" }, "contractEndDate": { "description": "IF the subscriber has a contract (active or expired), TLG will always return the contract end date as is. If the subscriber does not have a contract (e.g. PrePaid), then the contract end date will be empty.", "type": "string", "format": "date-time" }, "careContract": { "$ref": "#/components/schemas/lib_CareContractInfo" } }, "required": [ "contractTerm", "termsConditionsStatus", "suspendImmediately" ] } ], "title": "ResellerAgreement" }, "lib_AddressCountyInfo": { "type": "object", "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", "description": "Zip code used to evaluate billingMarket", "type": "string", "minLength": 5, "maxLength": 5, "pattern": "[0-9]{5}" }, "billingMarket": { "title": "billingMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "localMarket": { "title": "localMarket", "type": "string", "maxLength": 3 }, "billingSystemId": { "title": "billingSystemId", "type": "string", "maxLength": 9 }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "maxLength": 10 }, "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 } } } ], "title": "MarketServiceInfo" }, "lib_BillingAccountRef": { "type": "object", "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" } }, "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "lib_GeographicAddress": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "city": { "title": "city", "description": "City that the address is in", "type": "string" }, "country": { "title": "country", "description": "Country that the address is in", "type": "string" }, "locality": { "title": "locality", "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]", "type": "string" }, "postcode": { "title": "postcode", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)", "type": "string" }, "stateOrProvince": { "title": "stateOrProvince", "description": "the State or Province that the address is in", "type": "string" }, "streetName": { "title": "streetName", "description": "Name of the street or other street type", "type": "string" }, "streetNr": { "title": "streetNr", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses", "type": "string" }, "streetNrLast": { "title": "streetNrLast", "description": "Last number in a range of street numbers allocated to a property", "type": "string" }, "streetNrLastSuffix": { "title": "streetNrLastSuffix", "description": "Last street number suffix for a ranged address", "type": "string" }, "streetNrSuffix": { "title": "streetNrSuffix", "description": "the first street number suffix", "type": "string" }, "streetSuffix": { "title": "streetSuffix", "description": "A modifier denoting a relative direction", "type": "string" }, "streetType": { "title": "streetType", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf", "type": "string" }, "geographicSubAddress": { "allOf": [ { "$ref": "#/components/schemas/lib_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.", "title": "geographicSubAddress" } }, "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\n\nNote : Address corresponds to SID UrbanPropertyAddress\n" } ], "title": "GeographicAddress" }, "lib_EventSubscription": { "type": "object", "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." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "lib_AddressStreetInfo": { "type": "object", "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_SpendingLimitInfo": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "The spending limit status " }, "amount": { "type": "string", "description": "The spending limit amount" } } }, "lib_DepositReturnInfo": { "type": "object", "required": [ "amount", "dateReturned" ], "properties": { "amount": { "type": "number", "description": "The deposit amount returned to the subscriber" }, "dateReturned": { "type": "string", "format": "date-time", "description": "The date in which the deposit was return to the subscriber" } } }, "lib_IdentificationInfo": { "type": "object", "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", "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" } }, "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "lib_EffectiveDatesInfo": { "type": "object", "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" } }, "description": "Generic structure for start and end date for specified event." }, "lib_PortingLocatorInfo": { "type": "object", "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", "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": { "allOf": [ { "$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" } }, "description": "Request for cancellation an existing product order" }, "lib_DispatchParameters": { "type": "object", "required": [ "telephoneNumber" ], "properties": { "telephoneNumber": { "type": "string", "title": "telephoneNumber", "maxLength": 10, "description": "Ougoing telephone number" } }, "description": "A subscriber who has a voice dispatch price plan has to set an outgoing number" }, "lib_SplitLiabilityInfo": { "type": "object", "required": [ "targetAccountNumber" ], "properties": { "targetAccountNumber": { "type": "string", "title": "targetAccountNumber", "description": "The account number to which the split charges will be billed." } } }, "lib_GroupDetailsChoice": { "type": "object", "properties": { "groupReferenceChoice": { "allOf": [ { "$ref": "#/components/schemas/lib_GroupReferenceChoice" } ], "title": "groupReferenceChoice" }, "createDataGroupIndicator": { "type": "string", "title": "createDataGroupIndicator", "description": "Indicates whether to create a new shared data group." } }, "description": "This information is required when adding/updating a SDG Soc." }, "lib_GroupDataUsageInfo": { "type": "object", "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": { "$ref": "#/components/schemas/lib_DataUsageInfo" }, "title": "usageDetail", "minItems": 1, "uniqueItems": false }, "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": { "$ref": "#/components/schemas/lib_GroupSubscriberUsageDetail" }, "title": "GroupSubscriberUsageDetail", "minItems": 0, "uniqueItems": false }, "SharedDataGroupUsageSummary": { "allOf": [ { "$ref": "#/components/schemas/lib_SharedDataGroupUsageSummary" } ], "title": "SharedDataGroupUsageSummary" } }, "description": "Lists data usage details" }, "lib_DualCommisionsInfo": { "type": "object", "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_ContactInformation": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/lib_NameInfo" }, "email": { "$ref": "#/components/schemas/lib_EmailInfo" }, "ppuAddress": { "$ref": "#/components/schemas/lib_AddressInfo" } } }, "lib_DiscountAmountInfo": { "type": "object", "properties": { "dollarAmount": { "type": "number", "description": "This discount is a flat dollar amount. This value holds the amount in dollars." }, "percentageAmount": { "type": "number", "description": "This discount is a percentage amount. This value holds the percentage value." } } }, "lib_OfferingFeatureInfo": { "type": "object", "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", "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" } }, "description": "The reference object to the schema and type of target product which is described by product specification" }, "lib_ProductOrder_Create": { "type": "object", "properties": { "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" }, "title": "note" }, "quote": { "type": "array", "items": { "$ref": "#/components/schemas/lib_QuoteRef" }, "title": "quote" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name" }, "channel": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedChannel" }, "title": "channel" }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PaymentRef" }, "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": { "$ref": "#/components/schemas/lib_AgreementRef" }, "title": "agreement", "description": "A reference to an agreement defined in the context of the product order" }, "@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": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "billingAccount": { "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderPrice" }, "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": { "$ref": "#/components/schemas/lib_ProductOrderItem" }, "title": "productOrderItem", "minItems": 0, "uniqueItems": false }, "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": { "$ref": "#/components/schemas/lib_ProductOfferingQualificationRef" }, "title": "productOfferingQualification" } }, "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,\n\nSkipped properties: id,href,completionDate,orderDate,state,expectedCompletionDate,productOrderItem.state\n" }, "lib_ProductRelationship": { "type": "object", "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" } }, "description": "Linked products to the one instantiate, 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", "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." } }, "description": "The voice mail additional parameters." }, "lib_SharedDataGroupInfo": { "type": "object", "properties": { "groupDetailsChoice": { "allOf": [ { "$ref": "#/components/schemas/lib_GroupDetailsChoice" } ], "title": "groupDetailsChoice", "description": "This information is required when adding/updating a SDG Soc." } } }, "lib_ProductOrder_Update": { "type": "object", "required": [ "productOrderItem" ], "properties": { "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" }, "title": "note" }, "quote": { "type": "array", "items": { "$ref": "#/components/schemas/lib_QuoteRef" }, "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": { "$ref": "#/components/schemas/lib_RelatedChannel" }, "title": "channel" }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PaymentRef" }, "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": { "$ref": "#/components/schemas/lib_AgreementRef" }, "title": "agreement", "description": "A reference to an agreement defined in the context of the product order" }, "@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": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "completionDate": { "type": "string", "title": "completionDate", "format": "date-time", "description": "Date when the order was completed" }, "billingAccount": { "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" } ], "title": "billingAccount", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure." }, "orderTotalPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OrderPrice" }, "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": { "$ref": "#/components/schemas/lib_ProductOrderItem" }, "title": "productOrderItem", "minItems": 1, "uniqueItems": false }, "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": { "$ref": "#/components/schemas/lib_ProductOfferingQualificationRef" }, "title": "productOfferingQualification" } }, "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,\n\nSkipped properties: id,href,orderDate\n" }, "lib_ChildSocDetailsInfo": { "type": "object", "required": [ "action", "offeringCode" ], "properties": { "action": { "type": "string", "maxLength": 1 }, "offeringCode": { "type": "string", "maxLength": 9 }, "offeringType": { "type": "string", "description": "The feature code type to identify the Shared Data group services." }, "genAttribute": { "type": "string", "description": "type of Bolt-on/tracking SOCSs for that subscriber. - FBF_MSGPROMO (Mobile Share Data Promo) - EXP_ON_CYC_CL (Expire on Cycle Close Date)" }, "retiringGroupPricePlanId": { "type": "string", "maxLength": 9, "description": "ID of the price plan / SOC retiring group" } } }, "qp_BillingMarketDetails": { "type": "object", "required": [ "billingMarket", "billingSubMarket" ], "properties": { "localMarket": { "type": "string", "pattern": "^[A-Za-z]{3}$", "minLength": 3, "maxLength": 3, "description": "Contains the Market from which the NBI Customer was migrated." }, "billingMarket": { "type": "string", "pattern": "^[A-Za-z]{3}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "type": "string", "pattern": "^(([A-Za-z]{2,3})|([0-9]{2,3}))$", "minLength": 2, "maxLength": 3 } }, "additionalProperties": false }, "lib_MacAddressParameters": { "type": "object", "properties": { "macAddress": { "type": "string", "title": "macAddress" } }, "description": "The mac address parameters" }, "lib_MappingCtnParameters": { "type": "object", "required": [ "mappingCtn" ], "properties": { "mappingCtn": { "type": "string", "title": "mappingCtn", "maxLength": 10 } }, "description": "Mapping CTN parameters. Store the value of its corresponding Enterprise Psuedo CTN" }, "lib_SwitchParametersInfo": { "type": "object", "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", "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": { "allOf": [ { "$ref": "#/components/schemas/lib_ReferenceSubscriberOrGroupIdChoice" } ], "title": "referenceSubscriberOrGroupIdChoice" } } }, "lib_DealerCommissionInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "DualCommission": { "allOf": [ { "$ref": "#/components/schemas/lib_DualCommisionsInfo" } ], "title": "DualCommission" }, "billingTelephoneNumber": { "title": "billingTelephoneNumber", "description": "Billing Telephone Number", "type": "string", "maxLength": 10 }, "customerCode": { "title": "customerCode", "description": "The customer code.", "type": "string", "maxLength": 3 }, "dealer": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerInfo" } ], "title": "dealer" }, "location": { "title": "location", "description": "Location code for the physical/logical store being commissioned.", "type": "string" }, "salesRepresentative": { "title": "salesRepresentative", "description": "Sales Representative ID", "type": "string", "maxLength": 9 }, "affiliateSalesRepCode": { "title": "affiliateSalesRepCode", "description": "The Affiliate sales repersentative code", "type": "string", "maxLength": 15 } } } ], "title": "DealerCommissionInfo" }, "lib_GeographicSubAddress": { "type": "object", "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" } }, "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." }, "lib_GroupReferenceChoice": { "type": "object", "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_SubscriberStatusInfo": { "type": "object", "required": [ "subscriberStatus" ], "properties": { "statusDate": { "type": "string", "format": "date-time", "description": "The date when the status was changed." }, "subscriberStatus": { "type": "string", "enum": [ "A", "C", "L", "R", "S" ], "description": "RESERVED - R, ACTIVE - A, CANCELLED - C, SUSPENDED - S" }, "statusReasonCode": { "type": "string", "description": "The reason code given for the status change." }, "isSuspensionVoluntary": { "type": "string", "description": "This field is only provided if the subscriber is suspended: true - suspension is voluntary, false - suspension is not voluntary. This field is not available in all public interfaces." } } }, "lib_OfferMinutesUsageInfo": { "type": "object", "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." } }, "description": "Unbilled Usage buckets information." }, "lib_MobileSessionDataInfo": { "type": "object", "properties": { "sessionId": { "type": "string", "title": "sessionId", "description": "Session Identifier" }, "sessionDates": { "allOf": [ { "$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" }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number (SOC Order Id) for the Session ID. Used for the purpose of the renewing the Turbo Session and not when adding it as a new soc. Only sent to TLG when updating the agreement (updateSubscriber, Swap)." }, "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", "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_OfferingInfoOperation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_OfferingInfo" }, { "type": "object", "properties": { "operation": { "title": "operation", "type": "string", "maxLength": 1, "enum": [ "A", "Q", "R", "U" ] } }, "description": "Operation to be performed on OPffering Info", "required": [ "operation" ] } ], "title": "OfferingInfoOperation" }, "lib_ManifestUrlParameters": { "type": "object", "required": [ "manifestUrl" ], "properties": { "manifestUrl": { "type": "string", "title": "manifestUrl", "maxLength": 128 } }, "description": "Manifest URL parameters. Populated for the Toggle Corporate VPN SOC." }, "lib_SubscriberUsageDetail": { "type": "object", "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", "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" } }, "description": "Accept/Return the vQoS manifest attributes for FAN vQoS offer that require dynamic parameters" }, "lib_AddressRuralRouteInfo": { "type": "object", "required": [ "ruralRouteBoxNumber", "ruralRouteCenterNumber" ], "properties": { "ruralRouteBoxNumber": { "type": "string", "title": "ruralRouteBoxNumber", "maxLength": 10 }, "ruralRouteCenterNumber": { "type": "string", "title": "ruralRouteCenterNumber", "maxLength": 6 } } }, "lib_MobileToAnyNumberInfo": { "type": "object", "required": [ "isEffective" ], "properties": { "isEffective": { "type": "integer", "description": "Indicates if there is an effective Mobile to Any Number offering" }, "callListCount": { "type": "integer", "description": "The number of all effective and pending lines in the Call List." }, "isHistoryAvailable": { "type": "integer", "description": "Indicates if there is history call list" }, "maxNumberOfCallList": { "type": "integer", "description": "The maximum number of call list allowed" }, "minPricePlanRecurringCharge": { "type": "number", "description": "The minimum price plan MRC that is required in order to add mobile to any number offering" } } }, "lib_SubscriberDepositInfo": { "type": "object", "required": [ "subscriberDepositAmount" ], "properties": { "depositReturn": { "$ref": "#/components/schemas/lib_DepositReturnInfo" }, "subscriberDepositDate": { "type": "string", "format": "date-time", "description": "The date in which the deposit was received/applied" }, "subscriberDepositAmount": { "type": "string" } } }, "qp_ServiceZipCodeSelector": { "type": "object", "required": [ "serviceZipCode" ], "properties": { "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber - sets the service market/submarket." } }, "additionalProperties": false }, "lib_ResellerBillingAccount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_BillingAccountRef" }, { "type": "object", "properties": { "accountType": { "title": "accountType", "description": "Account Type for Reseller Billing Account", "type": "string" }, "accountSubType": { "title": "accountSubType", "description": "Account Sub Type for Reseller Billing Account.", "type": "string" } }, "description": "ResellerBillingAccount extending from BillingAccount reference. Although not recommended, its acceptable" } ], "title": "ResellerBillingAccount" }, "lib_RolloverExpirationInfo": { "type": "object", "required": [ "expiringRolloverMinutesBalance", "expiringRolloverMinutesDate" ], "properties": { "expiringRolloverMinutesDate": { "type": "string", "title": "expiringRolloverMinutesDate" }, "expiringRolloverMinutesBalance": { "type": "number", "title": "expiringRolloverMinutesBalance", "format": "double" } }, "description": "Details on balance and date a given number of rollover minutes will expire." }, "lib_EffectiveDateTimesInfo": { "type": "object", "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" } }, "description": "Generic structure for start and end date+time for specified event." }, "lib_ImeiDeviceFirmwareInfo": { "type": "object", "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", "required": [ "callback" ], "properties": { "query": { "type": "string", "title": "query", "description": "additional data to be passed" }, "callback": { "type": "string", "title": "callback", "description": "The callback being registered." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "lib_PricePlanPriceOnlyInfo": { "type": "object", "properties": { "cbDiscount": { "type": "integer", "title": "cbDiscount", "description": "Returns true if any of the subscribers under the account has the CB/WRD discount" }, "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "actionCode": { "type": "string" }, "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": { "allOf": [ { "$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": { "$ref": "#/components/schemas/lib_NameValuePair" }, "title": "pricePlanAttributes", "description": "An optional recurring structure that allows the passing of additional characteristics of a Price Plan.Usually passed as a Name and a Boolean of trueExamples include: Mobile Control, Real TIme Provisioning, etc." }, "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": { "$ref": "#/components/schemas/lib_SubMarketInfo" }, "title": "restrictedSubMarkets" }, "originalRatePlanCode": { "type": "string", "title": "originalRatePlanCode", "description": "This will be return during Change rate plan transactions from PDC" }, "promotionDescription": { "type": "string" }, "rollOverCapitalValue": { "type": "number" }, "ratePlanGenAttribute": { "type": "string", "maxLength": 500, "description": "holds the SOC general attributes of the price plan/rate plan" }, "offeringEffectiveBillDates": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "groupPlanOrSingleUserChoice": { "allOf": [ { "$ref": "#/components/schemas/lib_GroupPlanOrSingleUserChoice" } ], "title": "groupPlanOrSingleUserChoice" } } }, "lib_ResellerPriceOperation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResellerPrice" }, { "type": "object", "properties": { "operation": { "title": "operation", "type": "string", "maxLength": 1, "enum": [ "A", "Q", "R", "U" ] } }, "required": [ "operation" ] } ], "title": "ResellerPrice" }, "lib_AnyCharacteristicValue": { "type": "object", "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" } }, "description": "An Any object that gets subclassed into specific Characteristic objects" }, "lib_RelatedPlaceRefOrValue": { "type": "object", "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" } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "lib_AccountByEquipmentInfo": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "The subscriber status. The Valid values are: A - ACTIVE; C - CANCELLED; R - RESERVED; S - SUSPENDED" }, "statusDate": { "type": "string", "description": "The subscriber status date and date format as YYYYMMDD" }, "technologyType": { "type": "string", "description": "The technology type of the subscriber. The Valid values are: C - CELLULAR; CG - CELLULAR GATE; - GSM; GG - GSM GATE; GU - UMTS; GL - LTE" }, "statusReasonCode": { "type": "string", "description": "The subscriber status reason code. maximum length - 4; minimum length - 0" } } }, "lib_DeviceGroupDetailsInfo": { "type": "object", "required": [ "groupId" ], "properties": { "MSN": { "type": "string", "description": "manufacturer serial number" }, "groupId": { "type": "string", "maxLength": 20, "description": "GroupId of the device." }, "portInfo": { "$ref": "#/components/schemas/lib_PortInfo" }, "effectiveDates": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "contractIndicator": { "type": "string", "description": "indicates that this subscriber holds the contract for the group." } } }, "lib_ProductOfferingPriceRef": { "type": "object", "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" } }, "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased" }, "lib_ValueAddedParameterInfo": { "type": "object", "properties": { "pdpParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_PdpParameterInfo" } ], "title": "pdpParameters" }, "m2xParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_M2xParameters" } ], "title": "m2xParameters", "description": "The landline telephone number used in conjunction with the M2H (MobileToHome) feature." }, "switchDetails": { "allOf": [ { "$ref": "#/components/schemas/lib_SwitchDetailInfo" } ], "title": "switchDetails" }, "vvpnParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_VvpnParameters" } ], "title": "vvpnParameters", "description": "The vvpn additional parameters." }, "emailParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_EmailParameters" } ], "title": "emailParameters", "description": "The email box additional parameters." }, "productAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/lib_NameValuePair" }, "title": "productAttributes" }, "dispatchParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_DispatchParameters" } ], "title": "dispatchParameters", "description": "A subscriber who has a voice dispatch price plan has to set an outgoing number" }, "macAddressParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_MacAddressParameters" } ], "title": "macAddressParameters", "description": "The mac address parameters" }, "mappingCtnParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_MappingCtnParameters" } ], "title": "mappingCtnParameters", "description": "Mapping CTN parameters. Store the value of its corresponding Enterprise Psuedo CTN" }, "manifestUrlParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_ManifestUrlParameters" } ], "title": "manifestUrlParameters", "description": "Manifest URL parameters. Populated for the Toggle Corporate VPN SOC." }, "vQosSpecialParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_VQosSpecialParameters" } ], "title": "vQosSpecialParameters", "description": "Accept/Return the vQoS manifest attributes for FAN vQoS offer that require dynamic parameters" }, "unifiedMessagingParameters": { "allOf": [ { "$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": { "allOf": [ { "$ref": "#/components/schemas/lib_AuxilliaryServiceParameters" } ], "title": "auxilliaryServiceParameters", "description": "The auxiliary service additional parameters." }, "voiceActivatedDialingParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_VoiceActivatedDialingParametersInfo" } ], "title": "voiceActivatedDialingParameters" }, "priorityAccessServiceParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_PriorityAccessServiceParameters" } ], "title": "priorityAccessServiceParameters" } } }, "lib_ProductSpecificationRef": { "type": "object", "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": { "allOf": [ { "$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" } }, "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." }, "lib_RelatedProductOrderItem": { "type": "object", "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." } }, "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination." }, "lib_AdditionalOfferingsInfo": { "type": "object", "required": [ "offeringCode" ], "properties": { "appId": { "type": "array", "items": { "type": "string" }, "title": "appId", "description": "contains APP ID for LBS features" }, "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." }, "billDate": { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" }, "offerType": { "type": "string", "title": "offerType", "description": "Type of offering. The valid values are A - Additional Offering; B - Bundle Offering" }, "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "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": { "allOf": [ { "$ref": "#/components/schemas/lib_UsagePoolingInfo" } ], "title": "usagePooling" }, "referenceSoc": { "type": "string", "title": "referenceSoc", "description": "Returns the related SOC code (Parent Soc Code)." }, "imsIndicator": { "type": "string" }, "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." }, "gprsIndicator": { "type": "boolean", "description": "indicator showing if the soc is GPRS compatible" }, "effectiveDates": { "allOf": [ { "$ref": "#/components/schemas/lib_EffectiveDatesInfo" } ], "title": "effectiveDates", "description": "Generic structure for start and end date for specified event." }, "splitLiability": { "allOf": [ { "$ref": "#/components/schemas/lib_SplitLiabilityInfo" } ], "title": "splitLiability" }, "sequenceNumber": { "type": "string", "title": "sequenceNumber", "description": "The sequence number of the offering." }, "sharedDataGroup": { "allOf": [ { "$ref": "#/components/schemas/lib_SharedDataGroupInfo" } ], "title": "sharedDataGroup" }, "socSalesExpDate": { "type": "string", "title": "socSalesExpDate", "description": "Soc Sales expiration date." }, "repricedSdfFlag": { "type": "string", "description": "Indicates if SOC is Current or Virtual Re-Priced SDF C - Current SDF on the Subscriber; R - Virtual Re-Priced SDF" }, "offeringFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingFeatureInfo" }, "title": "offeringFeatures" }, "switchParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_SwitchParametersInfo" } ], "title": "switchParameters" }, "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": { "allOf": [ { "$ref": "#/components/schemas/lib_MobileSessionDataInfo" } ], "title": "mobileSessionData" }, "autoRenewIndicator": { "type": "string", "title": "autoRenewIndicator", "description": "false – non auto-renewed; true – it is auto renewed." }, "offeringDescription": { "type": "string", "title": "offeringDescription" }, "offeringNetworkType": { "type": "string", "description": "Indicates the network where the offering can be used" }, "offeringEligible777": { "type": "string", "description": "Flag showing if the soc is 777 compatible" }, "valueAddedParameters": { "allOf": [ { "$ref": "#/components/schemas/lib_ValueAddedParameterInfo" } ], "title": "valueAddedParameters" }, "crossMarketIndicator": { "type": "boolean", "title": "crossMarketIndicator", "description": "The NCI eligibility indicator of the soc. True means it's a cross market soc" }, "offeringBuyOneGetOne": { "type": "string" }, "offeringAssociatedLDC": { "type": "string", "maxLength": 5 }, "hasIntegratedMessaging": { "type": "boolean", "title": "hasIntegratedMessaging", "description": "Specifies whether this offer has Integrated Messaging." }, "umtsCompatibleIndicator": { "type": "string", "description": "Indicator showing if the soc is UMTS compatible" }, "transferFeatureIndicator": { "type": "boolean", "title": "transferFeatureIndicator", "description": "Non Switch Sensitive Indicator for Voice Mail Call Transfer" }, "retiringGroupPricePlanId": { "type": "string", "maxLength": 9, "description": "ID of the price plan / SOC retiring group" }, "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" }, "crossMarkeEligibiltyIndicator": { "type": "boolean" }, "primarySharedDataPlanIndicator": { "type": "boolean", "title": "primarySharedDataPlanIndicator", "description": "Indicates the offering is a Primary Shared Data Plan." }, "offeringMaintenanceRestriction": { "type": "string", "description": "restriction level of SOC" }, "offeringBundledDiscountIndicator": { "type": "boolean", "description": "Indicates if this feature represents a combined bill discount. It is available only for Care subscribers." } } }, "lib_SubscriberDataUsageInfo": { "type": "object", "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": { "$ref": "#/components/schemas/lib_DataUsageInfo" }, "title": "UsageDetail", "minItems": 1, "uniqueItems": false }, "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", "minLength": 0, "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", "minLength": 0, "maxLength": 32, "description": "Class of Service Description" } }, "description": "Lists data usage details" }, "lib_ProductOrderCreateEvent": { "type": "object", "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": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_LongDistanceCarrierInfo": { "type": "object", "required": [ "longDistanceCarrierCode" ], "properties": { "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "effectiveDate": { "type": "string", "title": "effectiveDate", "format": "date-time" }, "longDistanceCarrierCode": { "type": "string", "title": "longDistanceCarrierCode" } } }, "lib_ProductOrderDeleteEvent": { "type": "object", "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": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_InternationalAddressInfo": { "type": "object", "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 } }, "description": "Facilitates Worldwide Address Validation (US, Canada, Mexico, and more)" }, "lib_SubscriberIndicatorsInfo": { "type": "object", "required": [ "pttFeature" ], "properties": { "churn": { "type": "integer", "description": "Indicates the churn probability of the subscriber. This field contains the subscriber's risk of voluntary churn (5 indicating the highest risk of churn)." }, "rollOver": { "type": "string", "description": "Rollover Flag. R = Rollover (grandfather) plan; E = Expiration Rollover Plan" }, "pttFeature": { "type": "boolean", "description": "Indicates if the subscriber currently has PTT feature" }, "cseRatePlan": { "type": "boolean", "description": "Indicates if the subscriber is on a CSE rate plan." }, "profitability": { "type": "integer", "description": "Indicates if the profitability/life time value of the subscriber. This field measures the subscriber's profitability or life time value. Value of 5 will have the highest profitability." }, "vmPlatformType": { "type": "string", "enum": [ "A", "B" ] }, "splitLiability": { "type": "boolean", "description": "Indicates if the subscriber currently has a feature or offering that is enrolled in SLB (Split Liability Billing)" }, "gprsOnlyIndicator": { "type": "boolean", "description": "Indicates if the subscriber currently has a GPRS only subscriber" }, "subscriptionClass": { "type": "string", "minLength": 1, "maxLength": 2, "description": "Describes the class or category of subscriber. Possible values S => Mobile subscriber" }, "primaryServiceType": { "type": "string", "description": "Indicates whether the subscriber primarily uses voice services, data services, or both." }, "routingDesignation": { "type": "string", "description": "Indicates how calls are routed to the various call centers." }, "smsFeatureIndicator": { "type": "boolean", "description": "Indicates if the subscriber currently has an SMS Feature." }, "pendingTransactions": { "type": "string", "description": "Indicates if there are pending transaction while billing is in progress" }, "gaitFeatureIndicator": { "type": "boolean", "description": "Indicates if the subscriber contains the gait feature." }, "portabilityIndicator": { "type": "boolean", "description": "Indicates if the subscriber number is portable." }, "cbDiscountMRCThreshold": { "type": "number", "description": "Rate plan MRC threshold associated to the combined bill discount." }, "pendingEquipmentUpgrade": { "type": "boolean", "description": "Indicates if the subscriber currently has a pending equipment upgrade" }, "upgradeCommitmentIndicator": { "type": "boolean", "description": "Indicates if the subscriber is still under the minimum recurring charges (MRC) commitmment accepted during an upgrade. false means the customer has completed the commitment. true means he is still under commitment. If true, and the customer wants a rate plan /feature/equipment change, client should call verifyEquipmentUpgradeQualification to see if the change meets minimum MRC commitment" } } }, "lib_CancelProductOrder_Create": { "type": "object", "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": { "allOf": [ { "$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" } }, "description": "Request for cancellation an existing product order\n\nSkipped properties: id,href,state,effectiveCancellationDate\n" }, "lib_ResellerMobileLineProduct": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductRefOrValue" }, { "type": "object", "properties": { "subscriberNumber": { "title": "subscriberNumber", "description": "Mobile Telephone Number associated with this serial number.", "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^\\d{10}$" }, "baseConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingInfo" }, "title": "baseConfiguration" }, "additionalConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AdditionalOfferingsInfo" }, "title": "additionalConfiguration" }, "line": { "allOf": [ { "$ref": "#/components/schemas/lib_DeviceInfo" } ], "title": "line" }, "agreement": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerAgreement" }, "title": "agreement" }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerPrice" }, "title": "productPrice" }, "productTerm": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerTerm" }, "title": "productTerm" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "product": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ProductRefOrValue" }, "title": "product" }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "portingLocator": { "allOf": [ { "$ref": "#/components/schemas/lib_PortingLocatorInfo" } ], "title": "portingLocator" }, "commission": { "allOf": [ { "$ref": "#/components/schemas/lib_DealerCommissionInfo" } ], "title": "commission" }, "customer": { "$ref": "#/components/schemas/lib_Customer" }, "lte": { "$ref": "#/components/schemas/lib_LteInfo" }, "mobileToAnyNumberDetails": { "$ref": "#/components/schemas/lib_MobileToAnyNumberInfo" }, "nbiMigration": { "$ref": "#/components/schemas/lib_NbiMigrationInfo" }, "spendingLimit": { "$ref": "#/components/schemas/lib_SpendingLimitInfo" }, "subscriberIndicators": { "$ref": "#/components/schemas/lib_SubscriberIndicatorsInfo" }, "subscriberStatus": { "$ref": "#/components/schemas/lib_SubscriberStatusInfo" }, "crossUpgradeIndicator": { "description": "returns True when current contract is associated with a cross upgrade", "type": "string", "enum": [ "FALSE", "TRUE" ] }, "defaultApn": { "description": "This will be received from CAM and indicate the default APN for he subscriber. The example values are: BROADBAND PHONE, PTA, 02, IMS, NXTGENPHONE.", "type": "string", "maxLength": 16 }, "epcHssId": { "description": "Indicates the HSS ID", "type": "string", "maxLength": 4 }, "hlrId": { "description": "Home Location Register Identification", "type": "string", "maxLength": 30 }, "productType": { "description": "Indicates if the customer is using TDMA or GSM handset.", "type": "string", "enum": [ "C", "G" ] }, "sharedDataGroupIndicator": { "description": "SDG group status: P – for primary; S – for secondary; Empty/Not populated - not SDG Group Member", "type": "string", "enum": [ "P", "S" ] }, "subscriptionID": { "description": "Subscription ID associated to the subscriber number", "type": "string", "maxLength": 120 }, "voiceMailId": { "description": "The voice mail id of the subscriber. If the subscriber does not have a voicemail feature in billing, this will not be returned", "type": "string" }, "response": { "$ref": "#/components/schemas/lib_ResponseInfo" }, "portDetails": { "$ref": "#/components/schemas/lib_PortDetailsInfo" }, "billingAccountNumber": { "description": "Billing Account Number of the Subscriber", "type": "string" }, "depositAmount": { "description": "The requested deposit amount for this subscriber.", "type": "number" }, "longDistanceCarrier": { "description": "The long distance carrier.", "type": "string", "maxLength": 5 }, "deposit": { "$ref": "#/components/schemas/lib_SubscriberDepositInfo" }, "dataUsageMonitorIndicator": { "description": "Indicates if the Subscriber's realtime data usage is monitored in BalanceManager", "type": "boolean" }, "lastUpgradeContractDetails": { "$ref": "#/components/schemas/lib_LastUpgradeContractDetailsInfo" }, "hlrDescription": { "description": "subscriber level HLR", "type": "string" }, "copay": { "$ref": "#/components/schemas/lib_CopayInfo" }, "titanSubscriberDetailsInfo": { "$ref": "#/components/schemas/lib_TitanSubscriberDetailsInfo" }, "crossMarket": { "$ref": "#/components/schemas/lib_CrossMarketInfo" }, "originalSalesChannel": { "description": "The original sales channel of activation", "type": "string" }, "enablerDataUsageMonitorIndicator": { "description": "True indicates the Subscriber's realtime data usage is monitored in Enabler.", "type": "boolean" }, "deviceGroupDetails": { "$ref": "#/components/schemas/lib_DeviceGroupDetailsInfo" }, "vipIndicator": { "description": "true value indicates lines identified as personal/business lines of C-level executives.", "type": "boolean" }, "connectedVehicleDetails": { "$ref": "#/components/schemas/lib_ConnectedVehicleDetailsInfo" }, "subscriptionClass": { "description": "subscription class", "type": "string", "minLength": 1, "maxLength": 2 }, "firstNet": { "$ref": "#/components/schemas/lib_FirstNetInfo" }, "deviceName": { "description": "Device Friendly Name", "type": "string" } } } ], "title": "ResellerMobileLineProduct" }, "qp_ResultSelectionQueryParams": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Requested number of resources to be provided in response. Not in effect." }, "offset": { "type": "integer", "description": "Requested index for start of resources to be provided in response. Not in effect." } }, "additionalProperties": false }, "qp_BillingMarketAndSystemInfo": { "type": "object", "required": [ "billingMarket", "billingSubMarket" ], "properties": { "localMarket": { "type": "string", "pattern": "^[A-Za-z]{3}$", "minLength": 3, "maxLength": 3, "description": "Contains the Market from which the NBI Customer was migrated." }, "billingMarket": { "type": "string", "pattern": "^[A-Za-z]{3}$", "minLength": 3, "maxLength": 3 }, "billingSystemId": { "type": "string", "maxLength": 9 }, "billingSubMarket": { "type": "string", "pattern": "^(([A-Za-z]{2,3})|([0-9]{2,3}))$", "minLength": 2, "maxLength": 3 } }, "additionalProperties": false }, "lib_GroupSubscriberUsageDetail": { "type": "object", "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": { "$ref": "#/components/schemas/lib_SubscriberUsageDetail" }, "title": "SubscriberUsageDetail", "minItems": 1, "uniqueItems": false } } }, "lib_UnifiedMessagingParameters": { "type": "object", "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." } }, "description": "The unified Messaging additional parameters.One or more elements are required for updating CIO (Call In One) feature" }, "lib_SolicitationIndicatorsInfo": { "type": "object", "required": [ "solicitationMedium", "enabled" ], "properties": { "enabled": { "type": "boolean" }, "solicitationMedium": { "type": "string", "maxLength": 5 } } }, "lib_TitanSubscriberDetailsInfo": { "type": "object", "properties": { "anchorIndicator": { "type": "string", "description": "Indicates whether the subscriberNumber represents the Anchor subscriberNumber." }, "billingAccountNumber": { "type": "string", "description": "Titan Ban" } } }, "lib_GroupPlanOrSingleUserChoice": { "type": "object", "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": { "allOf": [ { "$ref": "#/components/schemas/lib_GroupPlanDetailsInfo" } ], "title": "groupPlanDetails" } } }, "lib_AuxilliaryServiceParameters": { "type": "object", "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." } }, "description": "The auxiliary service additional parameters." }, "lib_SharedDataGroupUsageSummary": { "type": "object", "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_ConnectedVehicleDetailsInfo": { "type": "object", "properties": { "make": { "type": "string", "maxLength": 40, "description": "Vehicle's manufacturer, example: Chevrolet" }, "year": { "type": "string", "description": "Vehicle's manufacture year" }, "trim": { "type": "string", "maxLength": 30, "description": "Version of model ( e.g. LE, XLE, limited)" }, "model": { "type": "string", "maxLength": 40, "description": "Vehicle's model, example: Camaro" }, "vehicleIdentificationNumber": { "type": "string", "maxLength": 17, "description": "Vehicle identification number - a unique alphanumeric code" } } }, "lib_RestrictedIdentificationInfo": { "type": "object", "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", "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": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_ResellerMobileLineOrderCreate": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrder_Create" }, { "type": "object", "properties": { "marketServiceInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo" } ], "title": "marketServiceInfo" }, "productOrderItem": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineActivateOrderItem" }, { "$ref": "#/components/schemas/lib_ResellerMobileLineUpdateOrderItem" }, { "$ref": "#/components/schemas/lib_ResellerMobileLineContractUpdateOrderItem" } ] }, "title": "productOrderItem", "minItems": 1, "uniqueItems": false } }, "required": [ "marketServiceInfo", "productOrderItem" ] } ], "title": "ResellerMobileLineOrderCreate" }, "lib_CancelProductOrderCreateEvent": { "type": "object", "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": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "qp_QueryParamsWithEquipIdSelector": { "allOf": [ { "$ref": "#/components/schemas/qp_CommonQueryParams" }, { "$ref": "#/components/schemas/qp_ResultSelectionQueryParams" }, { "oneOf": [ { "$ref": "#/components/schemas/qp_ServiceZipCodeSelector" }, { "$ref": "#/components/schemas/qp_BillingMarketAndSystemInfo" } ] }, { "oneOf": [ { "$ref": "#/components/schemas/qp_SIMSelector" }, { "$ref": "#/components/schemas/qp_IMEISelector" } ] } ], "additionalProperties": false }, "lib_ProductOrderDeleteEventPayload": { "type": "object", "properties": { "productOrder": { "allOf": [ { "$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," } }, "description": "The event data structure" }, "lib_ProductOrderCreateEventPayload": { "type": "object", "properties": { "productOrder": { "allOf": [ { "$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," } }, "description": "The event data structure" }, "lib_LastUpgradeContractDetailsInfo": { "type": "object", "properties": { "agentCode": { "type": "string", "description": "Agent code that provisioned the last upgrade contract" }, "dealerCode": { "type": "string", "description": "Dealer code that provisioned the last upgrade contract" }, "reasonCode": { "type": "string", "description": "Contract reason code of last upgrade contract" }, "contractTerm": { "type": "number", "description": "Last upgrade Contract length in terms of number of months" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and Timestamp associated to the provisioning of the last upgrade contract converted to GMT." }, "agentLocation": { "type": "string", "description": "Agent location for the agent that provisioned the last upgrade contract" }, "commitStartDate": { "type": "string", "format": "date-time", "description": "Last upgrade Contract effective start date (Contract start date)" }, "originalQualificationLevel": { "type": "string", "description": "The upgrade qualification level as determined by several subscriber elements. QLC code tied to last upgrade contract (if present on an Upgrade contract)" } } }, "qp_QueryParamsWithSubScriberNumber": { "allOf": [ { "$ref": "#/components/schemas/qp_CommonQueryParams" }, { "oneOf": [ { "$ref": "#/components/schemas/qp_emptyParams" }, { "$ref": "#/components/schemas/qp_BillingMarketDetails" }, { "$ref": "#/components/schemas/qp_AccountIdentifier" }, { "$ref": "#/components/schemas/qp_MarketDetailsAndAccountIdentifierCombined" } ] } ], "additionalProperties": false }, "lib_ResellerMobileLineOrderResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrder" }, { "type": "object", "properties": { "marketServiceInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo" } ], "title": "marketServiceInfo" }, "productOrderItem": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineActivateOrderItem" }, { "$ref": "#/components/schemas/lib_ResellerMobileLineUpdateOrderItem" }, { "$ref": "#/components/schemas/lib_ResellerMobileLineContractUpdateOrderItem" } ] }, "title": "productOrderItem" } }, "required": [ "marketServiceInfo", "productOrderItem" ] } ], "title": "ResellerMobileLineOrderResponse" }, "lib_ProductOfferingQualificationRef": { "type": "object", "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" } }, "description": "It's a productOfferingQualification that has been executed previously" }, "lib_PriorityAccessServiceParameters": { "type": "object", "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_AdditionalOfferingsInfoOperation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_AdditionalOfferingsInfo" }, { "type": "object", "properties": { "operation": { "title": "operation", "type": "string", "maxLength": 1, "enum": [ "A", "Q", "R", "U" ] } }, "required": [ "operation" ] } ], "title": "AdditionalOfferingsInfo" }, "lib_InternationalOfferVoiceUsageInfo": { "type": "object", "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" } }, "description": "Lists international offer usage details" }, "lib_ResellerMobileLineUpdateOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "baseConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingInfoOperation" }, "title": "baseConfiguration" }, "additionalConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AdditionalOfferingsInfoOperation" }, "title": "additionalConfigurationProductUpdateOperations" }, "priceProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerPriceOperation" }, "title": "priceProductUpdateOperations" }, "product": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineProduct" } ], "title": "product" }, "portingLocator": { "allOf": [ { "$ref": "#/components/schemas/lib_PortingLocatorInfo" } ], "title": "portingLocator" }, "response": { "allOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "description": "The object which holds the response code and description", "title": "response" } }, "required": [ "product" ] } ], "title": "ResellerMobileLineUpdateOrderItem" }, "lib_EffectiveDatesWithoutTimeZoneInfo": { "type": "object", "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_ResellerMobileLineProduct" }, { "type": "object", "properties": { "subscriberNumber": { "title": "subscriberNumber", "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^\\d{10}$" }, "subscriberStatus": { "title": "subscriberStatus", "type": "string" }, "line": { "allOf": [ { "$ref": "#/components/schemas/lib_MobileLineInfo" } ], "title": "line" } }, "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" } }, "description": "An AnyCharacteristic object that represents the port request line object" } ], "title": "PortRequestLineCharacteristicValue" }, "lib_CancelProductOrderStateChangeEvent": { "type": "object", "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": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_ReferenceSubscriberOrGroupIdChoice": { "type": "object", "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_ResellerMobileLineActivateOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "baseConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingInfoOperation" }, "title": "baseConfiguration" }, "additionalConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AdditionalOfferingsInfoOperation" }, "title": "additionalConfigurationProductUpdateOperations" }, "priceProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerPriceOperation" }, "title": "priceProductUpdateOperations" }, "product": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineProduct" } ], "title": "product" }, "portingLocator": { "allOf": [ { "$ref": "#/components/schemas/lib_PortingLocatorInfo" } ], "title": "portingLocator" }, "response": { "allOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "description": "The object which holds the response code and description", "title": "response" } }, "required": [ "product" ] } ], "title": "ResellerMobileLineActivateOrderItem" }, "lib_InstallmentPlanDevicePaymentDetails": { "type": "object", "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": "integer", "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": "integer", "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" } }, "description": "DevicePayment information to expedite upgrade" }, "lib_ProductOrderStateChangeEventPayload": { "type": "object", "properties": { "productOrder": { "allOf": [ { "$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," } }, "description": "The event data structure" }, "lib_VoiceActivatedDialingParametersInfo": { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "title": "language", "description": "The language preference. Default is English." }, "sequence": { "allOf": [ { "$ref": "#/components/schemas/lib_Sequence1" } ], "title": "sequence" }, "numberExists": { "type": "string", "title": "numberExists", "description": "Indicates whether the number exists or not." } } }, "lib_ProductOfferingQualificationItemRef": { "type": "object", "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." } }, "description": "It's a productOfferingQualification item that has been executed previously." }, "lib_ProductOrderInformationRequiredEvent": { "type": "object", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_CancelProductOrderCreateEventPayload": { "type": "object", "properties": { "cancelProductOrder": { "allOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } }, "description": "The event data structure" }, "lib_ProductOrderAttributeValueChangeEvent": { "type": "object", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "qp_MarketDetailsAndAccountIdentifierCombined": { "allOf": [ { "$ref": "#/components/schemas/qp_BillingMarketDetails" }, { "$ref": "#/components/schemas/qp_AccountIdentifier" } ], "additionalProperties": false }, "lib_ResellerMobileLineContractUpdateOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "baseConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_OfferingInfoOperation" }, "title": "baseConfiguration" }, "additionalConfigurationProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AdditionalOfferingsInfoOperation" }, "title": "additionalConfigurationProductUpdateOperations" }, "priceProductUpdateOperations": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerPriceOperation" }, "title": "priceProductUpdateOperations" }, "product": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineProduct" } ], "title": "product" }, "addressValidation": { "title": "addressValidation", "type": "boolean" }, "reasonCode": { "title": "reasonCode", "type": "string" }, "billingAccount": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerBillingAccount" } ], "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", "title": "billingAccount" }, "response": { "allOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "description": "The object which holds the response code and description", "title": "response" } }, "required": [ "product" ] } ], "title": "ResellerMobileLineContractUpdateOrderItem" }, "lib_CancelProductOrderStateChangeEventPayload": { "type": "object", "properties": { "cancelProductOrder": { "allOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } }, "description": "The event data structure" }, "lib_CancelProductOrderInformationRequiredEvent": { "type": "object", "properties": { "title": { "type": "string", "title": "title", "description": "The title of the event." }, "event": { "allOf": [ { "$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." } }, "description": "The notification data structure" }, "lib_ProductOrderInformationRequiredEventPayload": { "type": "object", "properties": { "productOrder": { "allOf": [ { "$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," } }, "description": "The event data structure" }, "lib_ResellerMobileLineActivateOrderItemResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ProductOrderItem" }, { "type": "object", "properties": { "product": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineProductResponse" } ], "title": "product" }, "response": { "allOf": [ { "$ref": "#/components/schemas/lib_ResponseCode" } ], "description": "The object which holds the response code and description", "title": "response" } } } ], "title": "ResellerMobileLineActivateOrderItemResponse" }, "lib_ProductOrderAttributeValueChangeEventPayload": { "type": "object", "properties": { "productOrder": { "allOf": [ { "$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," } }, "description": "The event data structure" }, "lib_CancelProductOrderInformationRequiredEventPayload": { "type": "object", "properties": { "cancelProductOrder": { "allOf": [ { "$ref": "#/components/schemas/lib_CancelProductOrder" } ], "title": "cancelProductOrder", "description": "Request for cancellation an existing product order" } }, "description": "The event data structure" } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF637", "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-TMF637", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF637", "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-TMF637", "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-TMF637", "message": "Unauthorized" } } }, "description": "Invalid credentials." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF637", "message": "Forbidden" } } }, "description": "Issue with the credentials." }, "trait_error-responses_404": { "content": { "application/json": { "example": { "code": "404", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF637", "message": "Requested resource no found." } } }, "description": "Requested resource no found." }, "trait_error-responses_405": { "content": { "application/json": { "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF637", "message": "HTTP Method get not allowed" } } }, "description": "Requested method not supported." }, "trait_error-responses_406": { "content": { "application/json": { "example": { "code": "406", "error": "Not Acceptable", "reason": "Not Acceptable", "status": "406-UNACCEPTABLE-TMF637" } } }, "description": "Unacceptable request body." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported mediaType", "status": "415-UNSUPPORTED_MEDIA_TYPE-TMF637", "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-TMF637", "message": "Internal Server Error" } } }, "description": "Processing error for the request." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "integer", "format": "int32", "example": 3599 }, "access_token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxxxxxxxxxxxxxxxxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } }, "description": "Dummy token below. Real token is much longer with more relevant info" } } }, "description": "No description provided" }, "securityScheme_ATT_Azure_AD_JWT_Token_400": { "content": { "application/json": { "schema": { "type": "object", "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": "integer", "format": "int32", "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": "Only an example of 400 Error body" } } }, "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_jwt_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "JWT Bearer Token. Token URL: https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n\ncurl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=Aswi39iZZIlGtV66yM1qCANKExLGAQAAAOqRbtgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=6bb2748d-d916-4534-5148-ee8f598e1e00' \r\n --data-urlencode 'client_secret=k_43YrZE2S2v9o6__e.KOKc_V4h__csa3M' \r\n\r\n Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on" }, "trait_headers_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "Valid JSON Web Token." }, "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.eyJzdWIiOiIxMjM0NTY3ODkwIxxxxxxxxxxxxxxxxaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "https://login.microsoftonline.com/e741d71c-c6b6-xxxxxxx-0f3b32b07556/oauth2/v2.0/token", "authorizationUrl": "" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }