{ "info": { "title": "ATT API based on TMF689(v4.0.0) - Resource Portability - MSISDN", "version": "4.0.0", "description": "The ATT MSISDN Resource Portability API enables clients to initiate port in and port out requests of MSISDN resources, track the status of submitted requests, cancel a previously submitted request, or retrieve submitted port in/out requests. It is based on TMF689 - Resource Portability 4.0.0." }, "paths": { "/portabilityOrder": { "get": { "summary": "Inquire Port", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder" } }, "example": { "id": "", "href": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "state": "OP", "@type": "", "dispute": false, "contract": { "contractCode": "", "salesChannel": "", "contractLength": "" }, "priority": "regular", "orderItem": [ { "portRequestLineId": 0, "orderItemRelationship": [ { "id": "", "type": "" } ], "state": "acknowledged", "action": "disconnect", "@schemaLocation": "", "id": "", "resource": { "fromLine": "5500", "serviceArea": "", "electronicSerialNum": "", "npaNxx": "196235", "usageState": "idle", "simSerialNum": "", "href": "", "imei": "", "name": "", "@schemaLocation": "", "activationFeature": [ { "upgradeFeatureCode": "", "upgradeFeatureEffectiveDate": "", "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "equipmentType": "C", "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceVersion": "", "id": "", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "toLine": "9999", "value": "", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "administrativeState": "locked", "responseReasonListIndicator": "", "resourceStatus": "standby", "@type": "", "category": "", "productType": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "endOperatingDate": "2020-11-20T08:00:00Z", "startOperatingDate": "2020-11-20T08:00:00Z", "description": "", "resourceRelationship": [ { "relationshipType": "bundled", "resource": { "id": "", "href": "", "category": "", "description": "", "endOperatingDate": "2020-11-20T08:00:00Z", "name": "", "resourceVersion": "", "startOperatingDate": "2020-11-20T08:00:00Z", "activationFeature": [ { "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "operationalState": "enable", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceRelationship": [], "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "dueDateTime": "", "@baseType": "", "operationalState": "enable" }, "orderItem": [ { "id": "", "orderItem": [], "state": "acknowledged", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "portabilityActivationMode": "", "portRelated": "", "endUserName": "", "@type": "", "pendingHandsetUpgradeCode": "", "fulfillmentOrderId": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "message": [ { "messageCode": "", "messageDetail": "", "messageSummary": "", "@baseType": "", "@schemaLocation": "/uri", "@type": "" } ], "portabilityEffectiveDate": "2020-11-20T08:00:00Z", "@baseType": "" } ], "orderDate": "2020-11-20T08:00:00Z", "@baseType": "", "externalId": "", "commission": { "id": "", "href": "", "name": "", "role": "", "@type": "", "storeId": "", "location": "", "@baseType": "", "dealerCode": "", "customerCode": "", "secondaryCode": "", "@referredType": "", "@schemaLocation": "", "creditCheckAgent": "", "salesRepresentative": [ "" ], "affiliateSalesRepCode": "", "billingTelephoneNumber": "", "creditCheckAgentLocation": "" }, "stateReason": "", "description": "", "initiatorId": "", "immediateAct": "P", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "portDirection": "A", "requestRemarks": "", "desiredDueTime": "", "completionDate": "2020-11-20T08:00:00Z", "desiredDueDate": "2020-11-20T08:00:00Z", "@schemaLocation": "", "telportRecordId": "15427457", "serviceProvider": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "marketServiceInfo": { "id": "", "href": "", "name": "", "role": "", "@type": "", "@baseType": "", "localMarket": "", "productType": "", "billingMarket": "", "@referredType": "", "serviceZipCode": "99356", "@schemaLocation": "", "billingSystemId": "", "billingSubMarket": "" }, "orderRelationship": [ { "id": "", "href": "", "type": "", "@referredType": "" } ], "portRequestNumber": "6214023269770803", "authorizationDate": "2020-11-20T08:00:00Z", "requestedStartDate": "2020-11-20T08:00:00Z", "portabilitySubject": { "@type": "", "@baseType": "", "businessName": "example", "businessTaxId": "", "serviceAddress": { "id": "", "href": "", "name": "", "city": "", "@type": "", "country": "", "geoCode": "3456", "postcode": "12345", "locality": "", "streetNr": "632", "@baseType": "", "streetName": "Luna", "streetType": "PKWY", "addressLine1": "", "streetNrLast": "", "streetSuffix": "SW", "streetPrefix": "E", "addressLine2": "", "postOfficeBox": "", "streetNrSuffix": "", "fieldIndicator": false, "stateOrProvince": "", "@schemaLocation": "", "urbanizationCode": "", "postcodeExtension": "6798", "streetNrLastSuffix": "", "geographicLocation": { "id": "", "href": "", "name": "", "@type": "", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "ruralRouteBoxNumber": "", "geographicSubAddress": [ { "id": "", "href": "", "buildingName": "", "levelNumber": "", "levelType": "", "name": "", "privateStreetName": "", "privateStreetNumber": "", "subAddressType": "", "subUnitNumber": "18", "subUnitType": "APT", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "ruralRouteCenterNumber": "" }, "last4DigitsSSN": "", "billingLastName": "", "@schemaLocation": "", "additionalTitle": "", "billingFirstName": "", "last4DigitsTaxId": "", "authorizationName": "", "billingNameSuffix": "", "billingNamePrefix": "", "billingAccountNumber": "534198029058", "billingMiddleInitial": "", "socialSecurityNumber": "", "ospBillingAccountNumber": "99999888", "ospBillingAccountPassword": "" }, "groupRequestNumber": "", "serviceProviderInfo": { "localId": "sdff", "networkId": "stfd", "resellerName": "" }, "termsConditionStatus": "B", "lastModificationDate": "2020-11-20T08:00:00Z", "stateReasonDescription": "", "expectedCompletionDate": "2020-11-20T08:00:00Z", "requestedCompletionDate": "2020-11-20T08:00:00Z", "portRequestNumberVersion": "String", "totalNumberOfSubscriberNumbers": 0 } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF689", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "404", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF689", "message": "Requested resource no found." } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF689", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF689", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "queryString", "required": true, "in": "query", "explode": true, "style": "form", "schema": { "oneOf": [ { "$ref": "#/components/schemas/qp_ListByRequestAndZipCode" }, { "$ref": "#/components/schemas/qp_ListByRequestAndBillingMarket" }, { "$ref": "#/components/schemas/qp_ListBySNAndZipCode" }, { "$ref": "#/components/schemas/qp_ListBySNAndBillingMarket" }, { "$ref": "#/components/schemas/qp_ListByDateAndZipCode" }, { "$ref": "#/components/schemas/qp_ListByDateAndBillingMarket" } ] } }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "inquire-port", "description": "The GET /portabilityOrder interaction enables the client to list or find PortabilityOrder entities, i.e., all information related to a previously submitted POST /portabilityOrder request. With this interaction, the partner can obtain data necessary to analyze a current request in an attempt to resolve any issues and submit a subsequent PATCH portabilityOrder/{id} request. The client will send a request (following the request parameters outlined) and will get back a JSON object in the response (object structure shown in response section). If any exceptions occur, a HTTP error will be returned with a object describing the error in the body of the response. Only HTTPS protocol is allowed. (TMF 689)", "operationId": "listPortabilityOrder" }, "post": { "summary": "Add Port", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder" }, "example": { "id": "", "href": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "state": "OP", "@type": "", "dispute": false, "contract": { "contractCode": "", "salesChannel": "", "contractLength": "" }, "priority": "regular", "orderItem": [ { "portRequestLineId": 0, "orderItemRelationship": [ { "id": "", "type": "" } ], "state": "acknowledged", "action": "disconnect", "@schemaLocation": "", "id": "", "resource": { "fromLine": "5500", "serviceArea": "", "electronicSerialNum": "", "npaNxx": "196235", "usageState": "idle", "simSerialNum": "", "href": "", "imei": "", "name": "", "@schemaLocation": "", "activationFeature": [ { "upgradeFeatureCode": "", "upgradeFeatureEffectiveDate": "", "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "equipmentType": "C", "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceVersion": "", "id": "", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "toLine": "9999", "value": "", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "administrativeState": "locked", "responseReasonListIndicator": "", "resourceStatus": "standby", "@type": "", "category": "", "productType": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "endOperatingDate": "2020-11-20T08:00:00Z", "startOperatingDate": "2020-11-20T08:00:00Z", "description": "", "resourceRelationship": [ { "relationshipType": "bundled", "resource": { "id": "", "href": "", "category": "", "description": "", "endOperatingDate": "2020-11-20T08:00:00Z", "name": "", "resourceVersion": "", "startOperatingDate": "2020-11-20T08:00:00Z", "activationFeature": [ { "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "operationalState": "enable", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceRelationship": [], "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "dueDateTime": "", "@baseType": "", "operationalState": "enable" }, "orderItem": [ { "id": "", "orderItem": [], "state": "acknowledged", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "portabilityActivationMode": "", "portRelated": "", "endUserName": "", "@type": "", "pendingHandsetUpgradeCode": "", "fulfillmentOrderId": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "message": [ { "messageCode": "", "messageDetail": "", "messageSummary": "", "@baseType": "", "@schemaLocation": "/uri", "@type": "" } ], "portabilityEffectiveDate": "2020-11-20T08:00:00Z", "@baseType": "" } ], "orderDate": "2020-11-20T08:00:00Z", "@baseType": "", "externalId": "", "commission": { "id": "", "href": "", "name": "", "role": "", "@type": "", "storeId": "", "location": "", "@baseType": "", "dealerCode": "", "customerCode": "", "secondaryCode": "", "@referredType": "", "@schemaLocation": "", "creditCheckAgent": "", "salesRepresentative": [ "" ], "affiliateSalesRepCode": "", "billingTelephoneNumber": "", "creditCheckAgentLocation": "" }, "stateReason": "", "description": "", "initiatorId": "", "immediateAct": "P", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "portDirection": "A", "requestRemarks": "", "desiredDueTime": "", "completionDate": "2020-11-20T08:00:00Z", "desiredDueDate": "2020-11-20T08:00:00Z", "@schemaLocation": "", "telportRecordId": "15427457", "serviceProvider": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "marketServiceInfo": { "id": "", "href": "", "name": "", "role": "", "@type": "", "@baseType": "", "localMarket": "", "productType": "", "billingMarket": "", "@referredType": "", "serviceZipCode": "99356", "@schemaLocation": "", "billingSystemId": "", "billingSubMarket": "" }, "orderRelationship": [ { "id": "", "href": "", "type": "", "@referredType": "" } ], "portRequestNumber": "6214023269770803", "authorizationDate": "2020-11-20T08:00:00Z", "requestedStartDate": "2020-11-20T08:00:00Z", "portabilitySubject": { "@type": "", "@baseType": "", "businessName": "example", "businessTaxId": "", "serviceAddress": { "id": "", "href": "", "name": "", "city": "", "@type": "", "country": "", "geoCode": "3456", "postcode": "12345", "locality": "", "streetNr": "632", "@baseType": "", "streetName": "Luna", "streetType": "PKWY", "addressLine1": "", "streetNrLast": "", "streetSuffix": "SW", "streetPrefix": "E", "addressLine2": "", "postOfficeBox": "", "streetNrSuffix": "", "fieldIndicator": false, "stateOrProvince": "", "@schemaLocation": "", "urbanizationCode": "", "postcodeExtension": "6798", "streetNrLastSuffix": "", "geographicLocation": { "id": "", "href": "", "name": "", "@type": "", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "ruralRouteBoxNumber": "", "geographicSubAddress": [ { "id": "", "href": "", "buildingName": "", "levelNumber": "", "levelType": "", "name": "", "privateStreetName": "", "privateStreetNumber": "", "subAddressType": "", "subUnitNumber": "18", "subUnitType": "APT", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "ruralRouteCenterNumber": "" }, "last4DigitsSSN": "", "billingLastName": "", "@schemaLocation": "", "additionalTitle": "", "billingFirstName": "", "last4DigitsTaxId": "", "authorizationName": "", "billingNameSuffix": "", "billingNamePrefix": "", "billingAccountNumber": "534198029058", "billingMiddleInitial": "", "socialSecurityNumber": "", "ospBillingAccountNumber": "99999888", "ospBillingAccountPassword": "" }, "groupRequestNumber": "", "serviceProviderInfo": { "localId": "sdff", "networkId": "stfd", "resellerName": "" }, "termsConditionStatus": "B", "lastModificationDate": "2020-11-20T08:00:00Z", "stateReasonDescription": "", "expectedCompletionDate": "2020-11-20T08:00:00Z", "requestedCompletionDate": "2020-11-20T08:00:00Z", "portRequestNumberVersion": "String", "totalNumberOfSubscriberNumbers": 0 } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF689", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF689", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF689", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "add-port", "description": "This operation creates a PortabilityOrder entity. (TMF 689)", "operationId": "createPortabilityOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder_AddPort" }, "examples": { "input": { "value": { "id": "", "href": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "state": "acknowledged", "@type": "", "dispute": false, "contract": { "contractCode": "", "salesChannel": "", "contractLength": "" }, "priority": "regular", "orderItem": [ { "portRequestLineId": 0, "orderItemRelationship": [ { "id": "", "type": "" } ], "state": "acknowledged", "action": "disconnect", "@schemaLocation": "", "id": "", "resource": { "fromLine": "5500", "serviceArea": "", "electronicSerialNum": "", "npaNxx": "196235", "usageState": "idle", "simSerialNum": "", "href": "", "imei": "", "name": "", "@schemaLocation": "", "activationFeature": [ { "upgradeFeatureCode": "", "upgradeFeatureEffectiveDate": "", "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "equipmentType": "C", "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceVersion": "", "id": "", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "toLine": "9999", "value": "", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "administrativeState": "locked", "responseReasonListIndicator": "", "resourceStatus": "standby", "@type": "", "category": "", "productType": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "endOperatingDate": "2020-11-20T08:00:00Z", "startOperatingDate": "2020-11-20T08:00:00Z", "description": "", "resourceRelationship": [ { "relationshipType": "bundled", "resource": { "id": "", "href": "", "category": "", "description": "", "endOperatingDate": "2020-11-20T08:00:00Z", "name": "", "resourceVersion": "", "startOperatingDate": "2020-11-20T08:00:00Z", "activationFeature": [ { "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "operationalState": "enable", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceRelationship": [], "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "dueDateTime": "", "@baseType": "", "operationalState": "enable" }, "orderItem": [ { "id": "", "orderItem": [], "state": "acknowledged", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "portabilityActivationMode": "", "portRelated": "", "endUserName": "", "@type": "", "pendingHandsetUpgradeCode": "", "fulfillmentOrderId": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "message": [ { "messageCode": "", "messageDetail": "", "messageSummary": "", "@baseType": "", "@schemaLocation": "/uri", "@type": "" } ], "portabilityEffectiveDate": "2020-11-20T08:00:00Z", "@baseType": "" } ], "orderDate": "2020-11-20T08:00:00Z", "@baseType": "", "externalId": "", "commission": { "id": "", "href": "", "name": "", "role": "", "@type": "", "storeId": "", "location": "", "@baseType": "", "dealerCode": "", "customerCode": "", "secondaryCode": "", "@referredType": "", "@schemaLocation": "", "creditCheckAgent": "", "salesRepresentative": [ "" ], "affiliateSalesRepCode": "", "billingTelephoneNumber": "", "creditCheckAgentLocation": "" }, "stateReason": "", "description": "", "initiatorId": "", "immediateAct": "P", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "portDirection": "A", "requestRemarks": "", "desiredDueTime": "", "completionDate": "2020-11-20T08:00:00Z", "desiredDueDate": "2020-11-20T08:00:00Z", "@schemaLocation": "", "telportRecordId": "", "serviceProvider": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "marketServiceInfo": { "id": "", "href": "", "name": "", "role": "", "@type": "", "@baseType": "", "localMarket": "", "productType": "", "billingMarket": "", "@referredType": "", "serviceZipCode": "99356", "@schemaLocation": "", "billingSystemId": "", "billingSubMarket": "" }, "orderRelationship": [ { "id": "", "href": "", "type": "", "@referredType": "" } ], "portRequestNumber": "", "authorizationDate": "2020-11-20T08:00:00Z", "requestedStartDate": "2020-11-20T08:00:00Z", "portabilitySubject": { "@type": "", "@baseType": "", "businessName": "example", "businessTaxId": "", "serviceAddress": { "id": "", "href": "", "name": "", "city": "", "@type": "", "country": "", "geoCode": "3456", "postcode": "12345", "locality": "", "streetNr": "632", "@baseType": "", "streetName": "Luna", "streetType": "PKWY", "addressLine1": "", "streetNrLast": "", "streetSuffix": "SW", "streetPrefix": "E", "addressLine2": "", "postOfficeBox": "", "streetNrSuffix": "", "fieldIndicator": false, "stateOrProvince": "", "@schemaLocation": "", "urbanizationCode": "", "postcodeExtension": "6798", "streetNrLastSuffix": "", "geographicLocation": { "id": "", "href": "", "name": "", "@type": "", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "ruralRouteBoxNumber": "", "geographicSubAddress": [ { "id": "", "href": "", "buildingName": "", "levelNumber": "", "levelType": "", "name": "", "privateStreetName": "", "privateStreetNumber": "", "subAddressType": "", "subUnitNumber": "18", "subUnitType": "APT", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "ruralRouteCenterNumber": "" }, "last4DigitsSSN": "", "billingLastName": "", "@schemaLocation": "", "additionalTitle": "", "billingFirstName": "", "last4DigitsTaxId": "", "authorizationName": "", "billingNameSuffix": "", "billingNamePrefix": "", "billingAccountNumber": "123456789", "billingMiddleInitial": "", "socialSecurityNumber": "", "ospBillingAccountNumber": "99999888", "ospBillingAccountPassword": "" }, "groupRequestNumber": "", "serviceProviderInfo": { "localId": "sdff", "networkId": "stfd", "resellerName": "" }, "termsConditionStatus": "B", "lastModificationDate": "2020-11-20T08:00:00Z", "stateReasonDescription": "", "expectedCompletionDate": "2020-11-20T08:00:00Z", "requestedCompletionDate": "2020-11-20T08:00:00Z", "portRequestNumberVersion": "", "totalNumberOfSubscriberNumbers": 0 } } } } }, "required": true } } }, "/portabilityOrder/{id}": { "get": { "summary": "Inquire Port By ID", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF689", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "404", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF689", "message": "Requested resource no found." } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF689", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF689", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "queryString", "required": true, "in": "query", "explode": true, "style": "form", "schema": { "oneOf": [ { "$ref": "#/components/schemas/qp_PortStatusUsingZipCode" }, { "$ref": "#/components/schemas/qp_PortStatusUsingBillingMarket" }, { "$ref": "#/components/schemas/qp_StatusbySNUsingZipCode" }, { "$ref": "#/components/schemas/qp_StatusbySNUsingBillingMarket" } ] } }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "inquire-port-act-status", "description": "This operation retrieves a PortabilityOrder request status using the portRequestNumber as ID. (TMF 689)", "operationId": "retrievePortabilityActivationOrderById" }, "patch": { "summary": "Update Port By ID", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder" }, "example": { "id": "", "href": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "state": "OP", "@type": "", "dispute": false, "contract": { "contractCode": "", "salesChannel": "", "contractLength": "" }, "priority": "regular", "orderItem": [ { "portRequestLineId": 0, "orderItemRelationship": [ { "id": "", "type": "" } ], "state": "acknowledged", "action": "disconnect", "@schemaLocation": "", "id": "", "resource": { "fromLine": "5500", "serviceArea": "", "electronicSerialNum": "", "npaNxx": "196235", "usageState": "idle", "simSerialNum": "", "href": "", "imei": "", "name": "", "@schemaLocation": "", "activationFeature": [ { "upgradeFeatureCode": "", "upgradeFeatureEffectiveDate": "", "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "equipmentType": "C", "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceVersion": "", "id": "", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "toLine": "9999", "value": "", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "administrativeState": "locked", "responseReasonListIndicator": "", "resourceStatus": "standby", "@type": "", "category": "", "productType": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "endOperatingDate": "2020-11-20T08:00:00Z", "startOperatingDate": "2020-11-20T08:00:00Z", "description": "", "resourceRelationship": [ { "relationshipType": "bundled", "resource": { "id": "", "href": "", "category": "", "description": "", "endOperatingDate": "2020-11-20T08:00:00Z", "name": "", "resourceVersion": "", "startOperatingDate": "2020-11-20T08:00:00Z", "activationFeature": [ { "id": "", "href": "", "isBundle": false, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "featureRelationship": [ { "id": "", "href": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "", "description": "Photograph of the Product", "mimeType": "video/mp4", "name": "iPhone 14 video", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z" }, "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "operationalState": "enable", "place": { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "resourceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "href": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "resourceRelationship": [], "resourceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "dueDateTime": "", "@baseType": "", "operationalState": "enable" }, "orderItem": [ { "id": "", "orderItem": [], "state": "acknowledged", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "portabilityActivationMode": "", "portRelated": "", "endUserName": "", "@type": "", "pendingHandsetUpgradeCode": "", "fulfillmentOrderId": "", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "message": [ { "messageCode": "", "messageDetail": "", "messageSummary": "", "@baseType": "", "@schemaLocation": "/uri", "@type": "" } ], "portabilityEffectiveDate": "2020-11-20T08:00:00Z", "@baseType": "" } ], "orderDate": "2020-11-20T08:00:00Z", "@baseType": "", "externalId": "", "commission": { "id": "", "href": "", "name": "", "role": "", "@type": "", "storeId": "", "location": "", "@baseType": "", "dealerCode": "", "customerCode": "", "secondaryCode": "", "@referredType": "", "@schemaLocation": "", "creditCheckAgent": "", "salesRepresentative": [ "" ], "affiliateSalesRepCode": "", "billingTelephoneNumber": "", "creditCheckAgentLocation": "" }, "stateReason": "", "description": "", "initiatorId": "", "immediateAct": "P", "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "portDirection": "A", "requestRemarks": "", "desiredDueTime": "", "completionDate": "2020-11-20T08:00:00Z", "desiredDueDate": "2020-11-20T08:00:00Z", "@schemaLocation": "", "telportRecordId": "15427457", "serviceProvider": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "marketServiceInfo": { "id": "", "href": "", "name": "", "role": "", "@type": "", "@baseType": "", "localMarket": "", "productType": "", "billingMarket": "", "@referredType": "", "serviceZipCode": "99356", "@schemaLocation": "", "billingSystemId": "", "billingSubMarket": "" }, "orderRelationship": [ { "id": "", "href": "", "type": "", "@referredType": "" } ], "portRequestNumber": "6214023269770803", "authorizationDate": "2020-11-20T08:00:00Z", "requestedStartDate": "2020-11-20T08:00:00Z", "portabilitySubject": { "@type": "", "@baseType": "", "businessName": "example", "businessTaxId": "", "serviceAddress": { "id": "", "href": "", "name": "", "city": "", "@type": "", "country": "", "geoCode": "3456", "postcode": "12345", "locality": "", "streetNr": "632", "@baseType": "", "streetName": "Luna", "streetType": "PKWY", "addressLine1": "", "streetNrLast": "", "streetSuffix": "SW", "streetPrefix": "E", "addressLine2": "", "postOfficeBox": "", "streetNrSuffix": "", "fieldIndicator": false, "stateOrProvince": "", "@schemaLocation": "", "urbanizationCode": "", "postcodeExtension": "6798", "streetNrLastSuffix": "", "geographicLocation": { "id": "", "href": "", "name": "", "@type": "", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "ruralRouteBoxNumber": "", "geographicSubAddress": [ { "id": "", "href": "", "buildingName": "", "levelNumber": "", "levelType": "", "name": "", "privateStreetName": "", "privateStreetNumber": "", "subAddressType": "", "subUnitNumber": "18", "subUnitType": "APT", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "ruralRouteCenterNumber": "" }, "last4DigitsSSN": "", "billingLastName": "", "@schemaLocation": "", "additionalTitle": "", "billingFirstName": "", "last4DigitsTaxId": "", "authorizationName": "", "billingNameSuffix": "", "billingNamePrefix": "", "billingAccountNumber": "534198029058", "billingMiddleInitial": "", "socialSecurityNumber": "", "ospBillingAccountNumber": "99999888", "ospBillingAccountPassword": "" }, "groupRequestNumber": "", "serviceProviderInfo": { "localId": "sdff", "networkId": "stfd", "resellerName": "" }, "termsConditionStatus": "B", "lastModificationDate": "2020-11-20T08:00:00Z", "stateReasonDescription": "", "expectedCompletionDate": "2020-11-20T08:00:00Z", "requestedCompletionDate": "2020-11-20T08:00:00Z", "portRequestNumberVersion": "String", "totalNumberOfSubscriberNumbers": 0 } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF689", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "404", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF689", "message": "Requested resource no found." } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF689", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF689", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "idType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MSISDN" ] }, "description": "Set to MSISDN to qualify the type of id in the request." }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "update-port", "description": "This operation updates partially a PortabilityOrder entity. (TMF 689)", "operationId": "patchPortabilityOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrder_UpdatePort" } } }, "required": true } }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "maxLength": 16 }, "description": "ID is the portRequestNumber to check the porting status." } ] }, "/cancelPortabilityOrder": { "post": { "summary": "Cancel Port", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNCancelPortabilityOrder" }, "example": { "id": "string", "href": "string", "state": "accepted", "@type": "string", "@baseType": "string", "reasonCode": "string", "initiatorId": "string", "@schemaLocation": "string", "subscriberNumber": "1234567890", "portabilityOrder": { "id": "string", "href": "string", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "name": "string", "state": "acknowledged", "@type": "string", "dispute": true, "orderDate": "2023-09-20T17:54:40.939Z", "@baseType": "string", "externalId": "string", "description": "string", "stateReason": "string", "@referredType": "string", "completionDate": "2023-09-20T17:54:40.939Z", "telportRecordId": "string", "@schemaLocation": "string", "authorizationDate": "2023-09-20T17:54:40.939Z", "portRequestNumber": "string", "marketServiceInfo": { "id": "string", "href": "string", "name": "string", "role": "string", "@type": "string", "@baseType": "string", "localMarket": "string", "productType": "string", "@referredType": "string", "billingMarket": "string", "serviceZipCode": "12345", "@schemaLocation": "string", "billingSystemId": "string", "billingSubMarket": "string" }, "groupRequestNumber": "string", "requestedStartDate": "2023-09-20T17:54:40.939Z", "portabilitySubject": { "@type": "string", "@baseType": "string", "businessName": "string", "billingLastName": "string", "@schemaLocation": "string", "billingFirstName": "string", "authorizationName": "string", "billingNamePrefix": "string", "billingNameSuffix": "string", "billingMiddleInitial": "string", "billingAccountNumber": "123456789" }, "lastModificationDate": "2023-09-20T17:54:40.939Z", "expectedCompletionDate": "2023-09-20T17:54:40.939Z", "stateReasonDescription": "string", "requestedCompletionDate": "2023-09-20T17:54:40.939Z", "portRequestNumberVersion": "string" }, "cancellationReason": "string", "effectiveCancellationDate": "2023-09-20T17:54:40.939Z", "requestedCancellationDate": "2023-09-20T17:54:40.939Z" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF689", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF689", "message": "HTTP Method get not allowed" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF689", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "cancel-port", "description": "This operation creates a CancelPortabilityOrder entity. (TMF 689)", "operationId": "createCancelPortabilityOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_MSISDNCancelPortabilityOrder" }, "examples": { "input": { "value": { "href": "string", "state": "accepted", "@type": "string", "@baseType": "string", "reasonCode": "string", "initiatorId": "string", "@schemaLocation": "string", "subscriberNumber": "1234567890", "portabilityOrder": { "id": "string", "href": "string", "note": [ { "id": "afa9-3d90aaa8da0f", "author": "Mr. N. Bene", "date": "2020-11-20T08:00:00Z", "text": "This is important", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "name": "string", "state": "acknowledged", "@type": "string", "dispute": true, "orderDate": "2023-09-20T17:54:40.939Z", "@baseType": "string", "externalId": "string", "description": "string", "stateReason": "string", "@referredType": "string", "completionDate": "2023-09-20T17:54:40.939Z", "telportRecordId": "string", "@schemaLocation": "string", "authorizationDate": "2023-09-20T17:54:40.939Z", "portRequestNumber": "string", "marketServiceInfo": { "id": "string", "href": "string", "name": "string", "role": "string", "@type": "string", "@baseType": "string", "localMarket": "string", "productType": "string", "@referredType": "string", "billingMarket": "string", "serviceZipCode": "12345", "@schemaLocation": "string", "billingSystemId": "string", "billingSubMarket": "string" }, "groupRequestNumber": "string", "requestedStartDate": "2023-09-20T17:54:40.939Z", "portabilitySubject": { "@type": "string", "@baseType": "string", "businessName": "string", "billingLastName": "string", "@schemaLocation": "string", "billingFirstName": "string", "authorizationName": "string", "billingNamePrefix": "string", "billingNameSuffix": "string", "billingMiddleInitial": "string", "billingAccountNumber": "123456789" }, "lastModificationDate": "2023-09-20T17:54:40.939Z", "expectedCompletionDate": "2023-09-20T17:54:40.939Z", "stateReasonDescription": "string", "requestedCompletionDate": "2023-09-20T17:54:40.939Z", "portRequestNumberVersion": "string" }, "cancellationReason": "string", "effectiveCancellationDate": "2023-09-20T17:54:40.939Z", "requestedCancellationDate": "2023-09-20T17:54:40.939Z" } } } } }, "required": true } } } }, "servers": [ { "url": "https://lgw.att.com/" } ], "openapi": "3.0.3", "components": { "links": {}, "schemas": { "lib_Note": { "type": "object", "title": "Note", "properties": { "id": { "type": "string", "example": "afa9-3d90aaa8da0f", "description": "Identifier of the note within its containing entity." }, "date": { "type": "string", "format": "rfc3339", "example": "2020-11-20T08:00:00Z", "description": "Date of the note." }, "text": { "type": "string", "example": "This is important", "description": "Text of the note." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "author": { "type": "string", "example": "Mr. N. Bene", "description": "Author of the note." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_Error": { "type": "object", "title": "Error", "required": [ "code", "reason" ], "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "referenceError": { "type": "string", "description": "URI of documentation describing the error." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_MSISDN": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_LogicalResource" }, { "type": "object", "properties": { "npaNxx": { "description": "first 6 digits of subscriber number to be ported.", "oneOf": [ { "$ref": "#/components/schemas/lib_PhoneNpaNxxInfo" } ] }, "fromLine": { "description": "Last four digits of number range to be ported.", "oneOf": [ { "$ref": "#/components/schemas/lib_PhoneLastFourDigitsInfo" } ] }, "toLine": { "description": "Last four digits of number range to be ported.", "oneOf": [ { "$ref": "#/components/schemas/lib_PhoneLastFourDigitsInfo" } ] }, "serviceArea": { "description": "The service area associated with the port-in subscriber number(s).", "oneOf": [ { "$ref": "#/components/schemas/lib_ServiceAreaInfo" } ] }, "equipmentType": { "$ref": "#/components/schemas/lib_EquipmentTypeInfo" } }, "required": [ "npaNxx", "fromLine", "serviceArea", "equipmentType" ] } ], "title": "MSISDN" }, "lib_Feature": { "type": "object", "title": "Feature", "required": [ "name", "featureCharacteristic" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "This is the name for the feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "isEnabled": { "type": "boolean", "default": true, "description": "True if this feature is enabled. Default is true." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "constraint": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ConstraintRef" }, "description": "This is a list of feature constraints." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_FeatureRelationship" } }, "featureCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" }, "description": "This is a list of Characteristics for a particular feature." } } }, "lib_Quantity": { "type": "object", "title": "Quantity", "properties": { "units": { "type": "string", "description": "Unit" }, "amount": { "type": "number", "default": 1, "description": "Numeric value in a given unit" } } }, "lib_Contract": { "type": "object", "properties": { "contractCode": { "type": "string" }, "salesChannel": { "type": "string" }, "contractLength": { "type": "string" } } }, "lib_Commission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "dealerCode": { "type": "string" }, "secondaryCode": { "type": "string" }, "location": { "type": "string" }, "salesRepresentative": { "type": "array", "items": { "type": "string" } }, "creditCheckAgent": { "type": "string" }, "creditCheckAgentLocation": { "type": "string" }, "affiliateSalesRepCode": { "type": "string" }, "billingTelephoneNumber": { "type": "string" }, "customerCode": { "type": "string" }, "storeId": { "type": "string" } } } ], "title": "Commission" }, "lib_TimePeriod": { "type": "object", "title": "TimePeriod", "required": [ "endDateTime", "startDateTime" ], "properties": { "endDateTime": { "type": "string", "format": "rfc3339", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "format": "rfc3339", "example": "1985-04-12T23:20:50.52Z", "description": "Start of the time period, using IETC-RFC-3339 format" } } }, "lib_MarketInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo_base" }, { "type": "object", "properties": { "serviceZipCode": { "type": "string", "description": "Service area zip code for primary subscriber", "pattern": "^.{0}$" }, "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3 }, "billingSubMarket": { "type": "string", "maxLength": 3 }, "localMarket": { "type": "string" } }, "required": [ "billingMarket", "billingSubMarket" ] } ] }, "lib_PortOutInfo": { "type": "object", "required": [ "responseType" ], "properties": { "toDate": { "type": "string" }, "remark": { "type": "string", "maxLength": 160, "description": "Used to sign whether the MDN is under contract. (remark string for this port out - optional-" }, "dueDate": { "type": "string" }, "fromDate": { "type": "string" }, "delayCode": { "type": "string", "enum": [ "", "6G", "6H", "6J" ], "maxLength": 2, "description": "The delay code for response Type D - delay: 6G Port Complexity 6H System Outages 6J High Volume deplayCode is required if responseType is D." }, "responseType": { "type": "string", "minLength": 1, "maxLength": 1, "description": "The type of the possible response. C=Confirmed D=Delayed R=Resolution Required." }, "portOutMdnInfo": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortOutMdnInfo" } } } }, "lib_RelatedParty": { "type": "object", "title": "RelatedParty", "required": [ "id", "@referredType" ], "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_ConstraintRef": { "type": "object", "title": "ConstraintRef", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "version": { "type": "string", "description": "constraint version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_TaskStateType": { "type": "string", "enum": [ "accepted", "erminatedWithError", "inProgress", "done" ], "title": "TaskStateType", "description": "Possible values for the state of a task" }, "lib_Characteristic": { "type": "object", "title": "Characteristic", "required": [ "name", "value" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "value": { "description": "The value of the characteristic" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_CharacteristicRelationship" } } } }, "lib_PortOutMdnInfo": { "type": "object", "properties": { "mdn": { "oneOf": [ { "$ref": "#/components/schemas/lib_SubscriberNumberInfo" } ], "description": "Mobile Directory Number (known as CTN in Telegence system)." }, "reasonCode": { "type": "string", "maxLength": 20, "description": "Reason code used in PR2 (port out) transaction only." }, "rsnCdDetail": { "type": "string", "description": "The reason code description." } } }, "lib_LogicalResource": { "type": "object", "title": "LogicalResource", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "A string used to give a name to the resource." }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's." }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AttachmentRefOrValue" } }, "usageState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceUsageStateType" } ], "description": "Tracks the usage state of the resource, such as idle, active, busy and so on." }, "description": { "type": "string", "description": "free-text description of the resource." }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "resourceStatus": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceStatusType" } ], "description": "Tracks the resource status of the resource, such as standby, alarm, available, reserved, suspended and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "endOperatingDate": { "type": "string", "format": "rfc3339", "description": "A date time( DateTime). The date till the resource is operating." }, "operationalState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" } ], "description": "Tracks the operational state of the resource, such as enable, disable and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" }, "description": "Configuration features." }, "startOperatingDate": { "type": "string", "format": "rfc3339", "description": "A date time( DateTime). The date from which the resource is operating." }, "administrativeState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" } ], "description": "Tracks the administrative state of the resource, such as locked, unlocked, shutdown and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_PhoneNpaNxxInfo": { "type": "string", "title": "PhoneNpaNxxInfo", "pattern": "^\\d{6}$", "minLength": 6, "maxLength": 6 }, "lib_ServiceAreaInfo": { "type": "string", "title": "ServiceAreaInfo", "maxLength": 12 }, "lib_ImmediateActInfo": { "type": "string", "enum": [ "P", "U" ], "title": "ImmediateActInfo", "maxLength": 1, "description": "U=Send the ACT P=Hold the ACT" }, "lib_MSISDN_AUXILIARY": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDN" }, { "type": "object", "properties": { "dueDateTime": { "type": "string" }, "productType": { "type": "string" }, "responseReasonListIndicator": { "type": "string" }, "imei": { "type": "string" }, "simSerialNum": { "type": "string" }, "electronicSerialNum": { "type": "string" }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature_extended" } }, "statusReasonCode": { "type": "string" }, "statusReasonDescription": { "type": "string" }, "mobileStatus": { "type": "string" }, "replaceDeleteFromPortRequest": { "type": "string", "enum": [ "C", "D", "R" ] }, "cingularReplacementSubscriberNumber": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^\\d{10}$" } } } ] }, "lib_PortabilityOrder": { "type": "object", "title": "PortabilityOrder", "properties": { "id": { "type": "string", "description": "ID created on repository side." }, "href": { "type": "string", "description": "Hyperlink to access the order." }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "state": { "$ref": "#/components/schemas/lib_PortabilityOrderStateType" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "dispute": { "type": "boolean" }, "priority": { "$ref": "#/components/schemas/lib_PortabilityPriorityType" }, "orderDate": { "type": "string", "format": "date-time", "description": "Date at which the PortabilityOrder has been created." }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderItem" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "externalId": { "type": "string", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)." }, "description": { "type": "string", "description": "Description of the product order." }, "stateReason": { "type": "string", "description": "State reason short code." }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "completionDate": { "type": "string", "format": "rfc3339", "description": "Date when the order was completed" }, "serviceProvider": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityServiceProvider" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "authorizationDate": { "type": "string", "format": "rfc3339", "description": "Date at which the PortabilityOrder has been authorized by the customer." }, "portRequestNumber": { "type": "string", "description": "Industry-standard PON identifier associated to this Portability request." }, "orderRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderRelationship" } }, "groupRequestNumber": { "type": "string" }, "requestedStartDate": { "type": "string", "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." }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject" }, "lastModificationDate": { "type": "string", "format": "date-time", "description": "Date when the order was last modified." }, "expectedCompletionDate": { "type": "string", "format": "date-time", "description": "Expected delivery date amended by the provider." }, "stateReasonDescription": { "type": "string", "description": "State reason description" }, "requestedCompletionDate": { "type": "string", "format": "date-time", "description": "Date at which the requestor wishes the portability to take place." }, "portRequestNumberVersion": { "type": "string", "description": "Current version of the industry-standard request." } } }, "lib_Feature_extended": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Feature" }, { "type": "object", "properties": { "upgradeFeatureCode": { "type": "string" }, "upgradeFeatureEffectiveDate": { "type": "string" } }, "required": [ "upgradeFeatureCode" ] } ], "title": "Feature_extended" }, "lib_PortWorkListInfo": { "type": "object", "required": [ "actionId", "accountNumber", "creationDate", "desiredDueDate", "serviceProviderName", "portPath", "requestStatus" ], "properties": { "orderId": { "type": "string" }, "actionId": { "type": "string" }, "portPath": { "type": "string", "description": "port path information. I-PortIn, O-PortOut." }, "delayCode": { "type": "string" }, "errorType": { "type": "string" }, "messageCd": { "type": "string" }, "dealerCode": { "type": "string" }, "oldResName": { "type": "string" }, "operatorId": { "type": "string" }, "accountName": { "type": "string" }, "creationDate": { "type": "string" }, "resellerName": { "type": "string" }, "accountNumber": { "type": "string" }, "requestStatus": { "type": "string" }, "desiredDueDate": { "type": "string", "format": "date-time" }, "requestDirection": { "type": "string", "description": "RequestDirection has 3 possible values: A - Wireless to wireless. B - Wireline to wireless. C - wireless to wireline." }, "serviceProviderId": { "type": "string" }, "portRequestNumber": { "type": "string" }, "serviceProviderName": { "type": "string" } } }, "lib_EquipmentTypeInfo": { "type": "string", "enum": [ "C", "G" ], "title": "EquipmentTypeInfo", "minLength": 1, "description": "Equipment type (Cellular = C, GSM = G)" }, "lib_GeographicAddress": { "type": "object", "title": "GeographicAddress", "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "city": { "type": "string", "description": "City that the address is in." }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "country": { "type": "string", "description": "Country that the address is in." }, "locality": { "type": "string", "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]." }, "postcode": { "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)." }, "streetNr": { "type": "string", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "streetName": { "type": "string", "description": "Name of the street or other street type." }, "streetType": { "type": "string", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf." }, "streetNrLast": { "type": "string", "description": "Last number in a range of street numbers allocated to a property." }, "streetSuffix": { "type": "string", "description": "A modifier denoting a relative direction." }, "streetNrSuffix": { "type": "string", "description": "the first street number suffix." }, "stateOrProvince": { "type": "string", "description": "the State or Province that the address is in." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "streetNrLastSuffix": { "type": "string", "description": "Last street number suffix for a ranged address." }, "geographicLocation": { "$ref": "#/components/schemas/lib_GeographicLocationRefOrValue" }, "geographicSubAddress": { "type": "array", "items": { "$ref": "#/components/schemas/lib_GeographicSubAddress" } } } }, "lib_MarketServiceInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "serviceZipCode": { "type": "string", "description": "Service area zip code for primary subscriber", "minLength": 5, "maxLength": 5, "pattern": "^\\d{5}$" }, "billingMarket": { "type": "string" }, "billingSubMarket": { "type": "string" }, "localMarket": { "type": "string" }, "billingSystemId": { "type": "string" }, "productType": { "type": "string" } } } ], "title": "MarketServiceInfo" }, "lib_PortDirectionInfo": { "type": "string", "enum": [ "A", "B", "C", "D" ], "title": "PortDirectionInfo", "maxLength": 1, "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D" }, "qp_ListBySNAndZipCode": { "type": "object", "required": [ "subscriberNumber", "serviceZipCode" ], "properties": { "portPath": { "type": "string", "enum": [ "O", "I" ], "description": "This can be either 'O' -PortOut; 'I'-PortIn; if not populated it is considered PortIn 'I'. Must be 'O' for date range queries." }, "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber." }, "subscriberNumber": { "type": "string", "pattern": "^\\d{10}$", "minLength": 10, "maxLength": 10, "description": "Mobile Telephone Number associated with this serial number. This field is required if none of portRequestNumber or fromDate, toDate are provided." } } }, "lib_PortabilityMessage": { "type": "object", "title": "PortabilityMessage", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "messageCode": { "type": "string" }, "messageDetail": { "type": "string" }, "messageSummary": { "type": "string" }, "@schemaLocation": { "type": "string", "example": "/uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_PortabilitySubject": { "type": "object", "title": "PortabilitySubject", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "businessName": { "type": "string", "minLength": 1 }, "serviceAddress": { "$ref": "#/components/schemas/lib_GeographicAddress" }, "billingLastName": { "type": "string" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "billingFirstName": { "type": "string" }, "authorizationName": { "type": "string" }, "billingNamePrefix": { "type": "string" }, "billingNameSuffix": { "type": "string" }, "billingMiddleInitial": { "type": "string" } } }, "lib_ResourceRefOrValue": { "type": "object", "title": "ResourceRefOrValue", "required": [ "id", "href", "resourceVersion" ], "properties": { "id": { "type": "string", "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "href": { "type": "string", "description": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource." }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AttachmentRefOrValue" } }, "usageState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceUsageStateType" } ], "description": "Tracks the usage state of the resource, such as idle, active, busy and so on." }, "description": { "type": "string", "description": "free-text description of the resource." }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceStatusType" } ], "description": "Tracks the resource status of the resource, such as standby, alarm, available, reserved, suspended and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "rfc3339", "description": "A date time( DateTime). The date till the resource is operating." }, "operationalState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" } ], "description": "Tracks the operational state of the resource, such as enable, disable and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" }, "description": "Configuration features." }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating." }, "administrativeState": { "oneOf": [ { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" } ], "description": "Tracks the administrative state of the resource, such as locked, unlocked, shutdown and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_ResourceStatusType": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "title": "ResourceStatusType", "description": "ResourceStatusType enumerations" }, "lib_ServiceZipCodeInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo_base" }, { "type": "object", "properties": { "serviceZipCode": { "type": "string", "description": "Service area zip code for primary subscriber", "minLength": 5, "maxLength": 5, "pattern": "^\\d{5}$" } }, "required": [ "serviceZipCode" ] } ] }, "lib_Commission_AddPort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Commission" }, { "type": "object", "properties": { "dealerCode": { "type": "string" } }, "required": [ "dealerCode" ] } ] }, "lib_FeatureRelationship": { "type": "object", "title": "FeatureRelationship", "required": [ "name", "relationshipType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the target feature." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "validFor": { "oneOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "description": "The period for which this feature relationship is valid." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship." } } }, "lib_PortabilityOrderRef": { "type": "object", "title": "PortabilityOrderRef", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_PortInitiatorIdInfo": { "type": "string", "title": "PortInitiatorIdInfo", "maxLength": 16, "description": "Clients are required to pass this value in the request. This value is optional in the response" }, "lib_ServiceProviderInfo": { "type": "object", "required": [ "localId", "networkId", "resellerName?" ], "properties": { "localId": { "type": "string", "minLength": 4, "maxLength": 4, "description": "Local service provider id used for wlnp process." }, "networkId": { "type": "string", "minLength": 4, "maxLength": 4, "description": "Network service provider id used for wlnp process." }, "resellerName?": { "type": "string", "description": "Name of reseller that sold wireless service." } } }, "qp_ListByDateAndZipCode": { "type": "object", "required": [ "fromDate", "toDate", "portPath", "serviceZipCode" ], "properties": { "toDate": { "type": "string", "format": "date", "example": "2023-10-25", "description": "To Date." }, "fromDate": { "type": "string", "format": "date", "example": "2023-10-25", "description": "From date." }, "portPath": { "type": "string", "enum": [ "O" ], "description": "This must be 'O' for date range queries." }, "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber." } } }, "lib_AttachmentRefOrValue": { "type": "object", "title": "AttachmentRefOrValue", "properties": { "id": { "type": "string", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Remote reference to the content if web-addressable" }, "href": { "type": "string", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "example": "iPhone 14 video", "description": "The name of the attachment" }, "size": { "oneOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "description": "The size of the attachment" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "example": "video/mp4", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "oneOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "description": "The period of time for which the attachment is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "description": { "type": "string", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "attachmentType": { "type": "string", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_GeographicSubAddress": { "type": "object", "title": "GeographicSubAddress", "properties": { "id": { "type": "string", "description": "Unique Identifier of the subAddress." }, "href": { "type": "string", "description": "Link to the subAddress." }, "name": { "type": "string", "description": "Name of the subAddress to identify it with a meaningful identification." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "levelType": { "type": "string", "description": "describes level types within a building." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "levelNumber": { "type": "string", "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2." }, "subUnitType": { "type": "string", "description": "the type of subunit\\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF." }, "buildingName": { "type": "string", "description": "allows for buildings that have well-known names." }, "subUnitNumber": { "type": "string", "description": "the discriminator used for the subunit\\noften just a simple number e.g. FLAT 5, may also be a range." }, "subAddressType": { "type": "string", "description": "Type of subAddress : it can be a subunit or a private street." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "privateStreetName": { "type": "string", "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", "description": "private streets numbers internal to a private street." } } }, "lib_PortabilityOrderItem": { "type": "object", "title": "PortabilityOrderItem", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, \\u2026)." }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "state": { "$ref": "#/components/schemas/lib_PortabilityOrderItemStateType" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "action": { "$ref": "#/components/schemas/lib_PortabilityActionType" }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityMessage" } }, "resource": { "$ref": "#/components/schemas/lib_LogicalResource" }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_BasePortabilityOrderItem" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "endUserName": { "type": "string" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "orderItemRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderItemRelationship" } }, "portabilityEffectiveDate": { "type": "string", "format": "rfc3339", "description": "Effective date at which the action on the Portability Order Item has been done. (The billing at the donor provider must be terminated)." }, "portabilityActivationMode": { "type": "string", "description": "manual or automatic." } } }, "lib_ResourceRelationship": { "type": "object", "title": "ResourceRelationship", "required": [ "relationshipType", "resource" ], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "resource": { "$ref": "#/components/schemas/lib_ResourceRefOrValue" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "relationshipType": { "type": "string", "example": "bundled", "description": "Type of the resource relationship, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (eg an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" } } }, "lib_SubscriberNumberInfo": { "type": "string", "title": "SubscriberNumberInfo", "pattern": "^\\d{10}$", "minLength": 10, "maxLength": 10, "description": "Mobile Telephone Number associated with this serial number." }, "lib_MSISDNPortinOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" }, { "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/lib_MSISDN" }, "portDirection": { "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D.", "oneOf": [ { "$ref": "#/components/schemas/lib_PortDirectionInfo" } ] }, "authorizationName": { "type": "string", "description": "Authorization Name This is the end user who authorized the request to port the number.", "maxLength": 60 }, "termsConditionStatus": { "description": "\\\"W\\\" - WEB Accepted, \\\"S\\\" - Physical Signature, \\\"P\\\" - Pending (regular activations), \\\"Y\\\" - Required, but pending (WLNP only).", "oneOf": [ { "$ref": "#/components/schemas/lib_TermsConditionsStatusInfo" } ] }, "desiredDueDate": { "type": "string", "format": "date-time", "description": "The desired due date. If not provided, the current date will be used." }, "immediateAct": { "description": "U -Unpark the ACT P -Park the ACT. For port inquiry if the porting process is parked/suspended in the biller this field will override the portRequestStatus/portRequestLineStatus returned in the response.", "oneOf": [ { "$ref": "#/components/schemas/lib_ImmediateActInfo" } ] }, "ospBillingAccountNumber": { "type": "string", "description": "The old service provider account number", "maxLength": 20 }, "ospBillingAccountPassword": { "type": "string", "description": "The old service provider account password", "maxLength": 20 }, "initiatorId": { "$ref": "#/components/schemas/lib_PortInitiatorIdInfo" }, "totalNumberOfSubscriberNumbers": { "$ref": "#/components/schemas/lib_TotalNumberOfSubscriberNumbersInfo" }, "requestRemarks": { "type": "string", "maxLength": 160 } }, "required": [ "portDirection", "authorizationName", "ospBillingAccountNumber" ] } ], "title": "MSISDNPortinOrderItem" }, "lib_PortabilityActionType": { "type": "string", "enum": [ "disconnect", "port", "intraport", "out" ], "title": "PortabilityActionType" }, "qp_PortStatusUsingZipCode": { "type": "object", "required": [ "serviceZipCode" ], "properties": { "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber." }, "portRequestVersion": { "type": "string", "maxLength": 2, "description": "Input values used to query an existing port." }, "teleportPortRecordId": { "type": "string", "description": "Input values used to query an existing port." } } }, "qp_StatusbySNUsingZipCode": { "type": "object", "required": [ "idType", "serviceZipCode" ], "properties": { "idType": { "type": "string", "enum": [ "MSISDN" ], "description": "Set to MSISDN to qualify the type of id in the request." }, "accountNumber": { "type": "string", "minLength": 8, "maxLength": 13, "description": "Input values used to query an existing port." }, "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber." } } }, "lib_CancelPortabilityOrder": { "type": "object", "title": "CancelPortabilityOrder", "required": [ "portabilityOrder" ], "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "state": { "oneOf": [ { "$ref": "#/components/schemas/lib_TaskStateType" } ], "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "portabilityOrder": { "$ref": "#/components/schemas/lib_PortabilityOrderRef" }, "cancellationReason": { "type": "string", "description": "Reason why the order is cancelled." }, "effectiveCancellationDate": { "type": "string", "format": "date-time", "description": "Date when the order is cancelled." }, "requestedCancellationDate": { "type": "string", "format": "date-time", "description": "Date when the submitter wants the order to be cancelled." } } }, "lib_MSISDNPortabilityOrder": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrder" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem_extended" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo_Choice" }, "telportRecordId": { "type": "string" }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject_extended" }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "serviceProviderInfo": { "$ref": "#/components/schemas/lib_ServiceProviderInfo" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." }, "portDirection": { "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D.", "oneOf": [ { "$ref": "#/components/schemas/lib_PortDirectionInfo" } ] }, "termsConditionStatus": { "description": "\"W\" - WEB Accepted, \"S\" - Physical Signature, \"P\" - Pending (regular activations), \"Y\" - Required, but pending (WLNP only).", "oneOf": [ { "$ref": "#/components/schemas/lib_TermsConditionsStatusInfo" } ] }, "desiredDueDate": { "type": "string", "format": "date-time", "description": "The desired due date. If not provided, the current date will be used" }, "immediateAct": { "description": "U -Unpark the ACT P -Park the ACT. For port inquiry if the porting process is parked/suspended in the biller this field will override the portRequestStatus/portRequestLineStatus returned in the response.", "oneOf": [ { "$ref": "#/components/schemas/lib_ImmediateActInfo" } ] }, "initiatorId": { "$ref": "#/components/schemas/lib_PortInitiatorIdInfo" }, "totalNumberOfSubscriberNumbers": { "$ref": "#/components/schemas/lib_TotalNumberOfSubscriberNumbersInfo" }, "requestRemarks": { "type": "string", "maxLength": 160 }, "contract": { "$ref": "#/components/schemas/lib_Contract" }, "desiredDueTime": { "type": "string" }, "portCreationDate": { "type": "string" }, "portPath": { "type": "string" }, "portCancellationReasonCode": { "type": "string" }, "actionId": { "type": "string" }, "delayCode": { "type": "string" }, "errorType": { "type": "string" }, "messageCd": { "type": "string" }, "oldResName": { "type": "string" }, "operationId": { "type": "string" }, "operatorId": { "type": "string" }, "portRequestStatus": { "type": "string" }, "code": { "type": "number" } } } ], "title": "MSISDNPortabilityOrder" }, "lib_RelatedPlaceRefOrValue": { "type": "object", "title": "RelatedPlaceRefOrValue", "required": [ "role" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the place." }, "href": { "type": "string", "description": "Unique reference of the place." }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]." }, "role": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_ResourceUsageStateType": { "type": "string", "enum": [ "idle", "active", "busy" ], "title": "ResourceUsageStateType", "description": "ResourceUsageStateType enumerations" }, "lib_MSISDNPortoutOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" }, { "type": "object", "properties": { "delayCode": { "type": "string", "description": "The delay code for response Type D - delay: 6G Port Complexity 6H System Outages 6J High Volume deplayCode is required if responseType is D.", "maxLength": 2, "enum": [ "", "6G", "6H", "6J" ] }, "remark": { "type": "string", "description": "Used to sign whether the MDN is under contract. (remark string for this port out - optional-", "maxLength": 160 }, "responseType": { "type": "string", "description": "The type of the possible response. C=Confirmed D=Delayed R=Resolution Required.", "minLength": 1, "maxLength": 1 }, "resource": { "$ref": "#/components/schemas/lib_MSISDN" } }, "required": [ "responseType" ] } ], "title": "MSISDNPortoutOrderItem" }, "lib_MarketServiceInfo_base": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "billingSystemId": { "type": "string" }, "productType": { "type": "string" } } } ], "title": "MarketServiceInfo_base" }, "qp_ListByRequestAndZipCode": { "type": "object", "required": [ "portRequestNumber", "serviceZipCode" ], "properties": { "portPath": { "type": "string", "enum": [ "O", "I" ], "description": "This can be either 'O' -PortOut; 'I'-PortIn; if not populated it is considered PortIn 'I'. Must be 'O' for date range queries." }, "serviceZipCode": { "type": "string", "pattern": "^\\d{5}$", "minLength": 5, "maxLength": 5, "description": "Service area zip code for primary subscriber." }, "portRequestNumber": { "type": "string", "maxLength": 16, "description": "Port request number input value used to query an existing port." }, "portRequestVersion": { "type": "string", "maxLength": 2, "description": "Input values used to query an existing port." }, "teleportPortRecordId": { "type": "string", "description": "Input values used to query an existing port." } } }, "lib_PhoneLastFourDigitsInfo": { "type": "string", "title": "PhoneLastFourDigitsInfo", "pattern": "^\\d{4}$", "minLength": 4, "maxLength": 4 }, "lib_PortabilityOrder_Update": { "type": "object", "title": "PortabilityOrder", "required": [ "authorizationDate", "orderItem", "priority", "serviceProvider" ], "properties": { "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "state": { "$ref": "#/components/schemas/lib_PortabilityOrderStateType" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "dispute": { "type": "boolean" }, "priority": { "$ref": "#/components/schemas/lib_PortabilityPriorityType" }, "orderDate": { "type": "string", "format": "date-time", "description": "Date at which the PortabilityOrder has been created." }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderItem" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "externalId": { "type": "string", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)." }, "description": { "type": "string", "description": "Description of the product order." }, "stateReason": { "type": "string", "description": "State reason short code." }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "completionDate": { "type": "string", "format": "rfc3339", "description": "Date when the order was completed" }, "serviceProvider": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityServiceProvider" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "authorizationDate": { "type": "string", "format": "rfc3339", "description": "Date at which the PortabilityOrder has been authorized by the customer." }, "portRequestNumber": { "type": "string", "description": "Industry-standard PON identifier associated to this Portability request." }, "orderRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderRelationship" } }, "groupRequestNumber": { "type": "string" }, "requestedStartDate": { "type": "string", "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." }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject" }, "lastModificationDate": { "type": "string", "format": "date-time", "description": "Date when the order was last modified." }, "expectedCompletionDate": { "type": "string", "format": "date-time", "description": "Expected delivery date amended by the provider." }, "stateReasonDescription": { "type": "string", "description": "State reason description" }, "requestedCompletionDate": { "type": "string", "format": "date-time", "description": "Date at which the requestor wishes the portability to take place." }, "portRequestNumberVersion": { "type": "string", "description": "Current version of the industry-standard request." } } }, "lib_PortabilityPriorityType": { "type": "string", "enum": [ "regular", "expedite" ], "title": "PortabilityPriorityType" }, "qp_ListBySNAndBillingMarket": { "type": "object", "required": [ "subscriberNumber", "billingMarket" ], "properties": { "portPath": { "type": "string", "enum": [ "O", "I" ], "description": "This can be either 'O' -PortOut; 'I'-PortIn; if not populated it is considered PortIn 'I'. Must be 'O' for date range queries." }, "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3, "description": "Billing market." }, "subscriberNumber": { "type": "string", "pattern": "^\\d{10}$", "minLength": 10, "maxLength": 10, "description": "Mobile Telephone Number associated with this serial number. This field is required if none of portRequestNumber or fromDate, toDate are provided." }, "billingSubMarket": { "type": "string", "maxLength": 3, "description": "Billing submarket." } } }, "lib_BasePortabilityOrderItem": { "type": "object", "title": "BasePortabilityOrderItem", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, \\u2026)" }, "state": { "$ref": "#/components/schemas/lib_PortabilityOrderItemStateType" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_BasePortabilityOrderItem" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResourceSpecificationRef": { "type": "object", "title": "ResourceSpecificationRef", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "version": { "type": "string", "description": "Resource Specification version." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_MarketServiceInfo_Choice": { "oneOf": [ { "$ref": "#/components/schemas/lib_ServiceZipCodeInfo" }, { "$ref": "#/components/schemas/lib_MarketInfo" } ] }, "lib_MSISDNAddPortabilityOrder": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrder" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "telportRecordId": { "type": "string" }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject" }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." } }, "required": [ "orderItem" ] } ], "title": "MSISDNAddPortabilityOrder" }, "lib_PortabilityOrderStateType": { "type": "string", "enum": [ "acknowledged", "pending", "sent", "delayed", "rejected", "held", "confirmed", "inProgress", "cancelled", "completed", "failed", "partial", "CF", "CN", "CO", "CT", "DN", "ER", "OP" ], "title": "PortabilityOrderStateType" }, "lib_TermsConditionsStatusInfo": { "type": "string", "enum": [ "B", "C", "E", "I", "N", "P", "S", "T", "V", "W", "X", "Y" ], "title": "TermsConditionsStatusInfo", "description": "WEB Accepted - \\\"W\\\", Physical Signature - \\\"S\\\", Pending (regular activations) - \\\"P\\\", Required, but pending (WLNP only) - \\\"Y\\\", Prepaid/Reseller Status - \\\"N\\\", B2B Status - \\\"B\\\", IVR Status - \\\"I\\\", Verbal (for rate plan changes with a commitment of 11 months or less only) - \\\"V\\\", third party IVR accepted (applicable to rateplan changes only ) \\\"T\\\", CBO Accepted - \\\"C\\\", Affiliate accepted - \\\"E\\\", Signature Capture Device(for OPUS) - X" }, "qp_ListByDateAndBillingMarket": { "type": "object", "required": [ "fromDate", "toDate", "portPath", "billingMarket" ], "properties": { "toDate": { "type": "string", "format": "date", "example": "2023-10-25", "description": "To Date." }, "fromDate": { "type": "string", "format": "date", "example": "2023-10-25", "description": "From date." }, "portPath": { "type": "string", "enum": [ "O" ], "description": "This must be 'O' for date range queries." }, "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3, "description": "Billing market." }, "billingSubMarket": { "type": "string", "maxLength": 3, "description": "Billing submarket." } } }, "lib_CharacteristicRelationship": { "type": "object", "title": "CharacteristicRelationship", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "description": "The type of relationship" } } }, "lib_MSISDNPortabilityOrderBase": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrder" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "telportRecordId": { "type": "string" }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject_minorExtension" }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "serviceProviderInfo": { "$ref": "#/components/schemas/lib_ServiceProviderInfo" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." } } } ], "title": "MSISDNPortabilityOrderBase" }, "lib_MSISDNPortabilityOrderItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrderItem" }, { "type": "object", "properties": { "action": { "description": "used for portin portout etc; can be extended or updated directly", "oneOf": [ { "$ref": "#/components/schemas/lib_PortabilityActionType" } ] }, "resource": { "$ref": "#/components/schemas/lib_LogicalResource" } } } ], "title": "MSISDNPortabilityOrderItem" }, "lib_PortabilityServiceProvider": { "type": "object", "title": "PortabilityServiceProvider", "required": [ "@referredType" ], "properties": { "id": { "type": "string", "description": "unique identifier." }, "href": { "type": "string", "description": "Hyperlink reference." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_GeographicAddress_extended": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_GeographicAddress" }, { "type": "object", "properties": { "fieldIndicator": { "type": "boolean", "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. " }, "postOfficeBox": { "type": "string", "description": "." }, "ruralRouteCenterNumber": { "type": "string", "description": "." }, "ruralRouteBoxNumber": { "type": "string", "description": "." }, "urbanizationCode": { "type": "string", "description": "." }, "addressLine1": { "type": "string", "description": "." }, "addressLine2": { "type": "string", "description": "." }, "postcode": { "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode)", "minLength": 5, "maxLength": 5 }, "postcodeExtension": { "type": "string", "description": "also known as extension of zipcode", "minLength": 4, "maxLength": 4 }, "geoCode": { "type": "string", "description": "Address geographical zip code. This attribute is used for addresses on certain geographical maps." }, "geographicSubAddress": { "type": "array", "items": { "$ref": "#/components/schemas/lib_GeographicSubAddress_extended" } }, "streetPrefix": { "type": "string", "description": "A modifier denoting a relative direction at the beginning of the street name, like the S. in S. ABC BLVD.", "enum": [ "E", "S", "W", "NE", "NW", "SE", "SW" ] }, "streetSuffix": { "type": "string", "description": "A modifier denoting a relative direction.", "enum": [ "N", "E", "S", "W", "NE", "NW", "SE", "SW" ] }, "streetType": { "type": "string", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf.", "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", "MEWS", "MDW", "MDWS", "ML", "MLS", "MNR", "MNRS", "MSN", "MT", "MTN", "MTNS", "MTWY", "NCK", "ORCH", "OVAL", "OPAS", "PARK", "PASS", "PATH", "PIKE", "PKY", "PKWY", "PL", "PLN", "PLNS", "PLZ", "PNE", "PNES", "PR", "PRT", "PRTS", "PSGE", "PT", "PTS", "RADL", "RAMP", "RD", "RDS", "RDG", "RDGS", "RIV", "RNCH", "ROW", "RPD", "RPDS", "RST", "RTE", "RUE", "RUN", "SHL", "SHLS", "SHR", "SHRS", "SKWY", "SMT", "SPG", "SPGS", "SPUR", "SQ", "SQS", "ST", "STS", "STA", "STRA", "STRM", "TER", "THWY", "TPKE", "TRAK", "TRCE", "TRFY", "TRWY", "TRL", "TRLR", "TUNL", "UN", "UNS", "UPAS", "VIA", "VIS", "VL", "VLG", "VLGS", "VLY", "VLYS", "VW", "VWS", "WALK", "WALL", "WAY", "WAYS", "WL", "WLS", "XING", "XRD" ] } } } ] }, "lib_PortabilitySubject_AddPort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilitySubject_minorExtension" }, { "type": "object", "properties": { "authorizationName": { "type": "string", "description": "Authorization Name This is the end user who authorized the request to port the number.", "maxLength": 60 }, "billingFirstName": { "type": "string" }, "billingLastName": { "type": "string" }, "billingAccountNumber": { "type": "string", "description": ".", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "ospBillingAccountNumber": { "type": "string", "description": "The old service provider account number", "maxLength": 20 }, "ospBillingAccountPassword": { "type": "string", "description": "The old service provider account password", "maxLength": 20 }, "businessTaxId": { "type": "string", "description": ".", "pattern": "^([0-9]{9}|)$" }, "socialSecurityNumber": { "type": "string", "description": ".", "pattern": "^([0-9]{9}|)$" }, "serviceAddress": { "$ref": "#/components/schemas/lib_GeographicAddress_extended" }, "additionalTitle": { "type": "string", "description": "The name's additional title. A free text field that holds the additional title of the name. For example, Mr. George Washington Sr. President." } }, "required": [ "authorizationName", "billingFirstName", "billingLastName", "ospBillingAccountNumber" ] } ] }, "lib_PortabilitySubject_extended": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilitySubject" }, { "type": "object", "properties": { "authorizationName": { "type": "string", "description": "Authorization Name This is the end user who authorized the request to port the number.", "maxLength": 60 }, "billingAccountNumber": { "type": "string", "description": ".", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "ospBillingAccountNumber": { "type": "string", "description": "The old service provider account number", "maxLength": 20 }, "ospBillingAccountPassword": { "type": "string", "description": "The old service provider account password", "maxLength": 20 }, "businessTaxId": { "type": "string", "description": ".", "pattern": "^([0-9]{9}|)$" }, "socialSecurityNumber": { "type": "string", "description": ".", "pattern": "^([0-9]{9}|)$" }, "serviceAddress": { "$ref": "#/components/schemas/lib_GeographicAddress_extended" }, "additionalTitle": { "type": "string", "description": "The name's additional title. A free text field that holds the additional title of the name. For example, Mr. George Washington Sr. President." }, "last4DigitsSSN": { "type": "string" }, "last4DigitsTaxId": { "type": "string" } } } ] }, "qp_PortStatusUsingBillingMarket": { "type": "object", "required": [ "billingMarket" ], "properties": { "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3, "description": "Billing market." }, "billingSubMarket": { "type": "string", "maxLength": 3, "description": "Billing submarket." }, "portRequestVersion": { "type": "string", "maxLength": 2, "description": "Input values used to query an existing port." }, "teleportPortRecordId": { "type": "string", "description": "Input values used to query an existing port." } } }, "qp_StatusbySNUsingBillingMarket": { "type": "object", "required": [ "idType", "billingMarket" ], "properties": { "idType": { "type": "string", "enum": [ "MSISDN" ], "description": "Set to MSISDN to qualify the type of id in the request." }, "accountNumber": { "type": "string", "minLength": 8, "maxLength": 13, "description": "Input values used to query an existing port." }, "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3, "description": "Billing market." }, "billingSubMarket": { "type": "string", "maxLength": 3, "description": "Billing submarket." } } }, "lib_GeographicLocationRefOrValue": { "type": "object", "title": "GeographicLocationRefOrValue", "required": [ "@type" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the place." }, "href": { "type": "string", "description": "Unique reference of the place." }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." } } }, "lib_MSISDNCancelPortabilityOrder": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_CancelPortabilityOrder" }, { "type": "object", "properties": { "reasonCode": { "type": "string" }, "initiatorId": { "type": "string" }, "subscriberNumber": { "$ref": "#/components/schemas/lib_SubscriberNumberInfo" }, "portabilityOrder": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderBase" } }, "required": [ "reasonCode", "initiatorId", "portabilityOrder" ] } ], "title": "MSISDNCancelPortabilityOrder" }, "lib_MSISDNUpdatePortabilityOrder": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrder_Update" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "telportRecordId": { "type": "string" }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject" }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." } }, "required": [ "orderItem" ] } ], "title": "MSISDNUpdatePortabilityOrder" }, "lib_PortabilityOrderRelationship": { "type": "object", "title": "PortabilityOrderRelationship", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The id of the related order" }, "href": { "type": "string", "description": "A hyperlink to the related order." }, "type": { "type": "string", "description": "The type of related order, can be : \\u201cdependency\\u201d if the order needs to be \\u201cnot started\\u201d until another order item is complete (a service order in this case) or \\u201ccross-ref\\u201d to keep track of the source order (a productOrder)." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "lib_ResourceOperationalStateType": { "type": "string", "enum": [ "enable", "disable" ], "title": "ResourceOperationalStateType", "description": "ResourceOperationalStateType enumerations" }, "lib_GeographicAddress_UpdatePort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_GeographicAddress_extended" }, { "type": "object", "properties": { "city": { "type": "string", "description": "City that the address is in." }, "country": { "type": "string", "description": "Country that the address is in." }, "stateOrProvince": { "type": "string", "description": "the State or Province that the address is in." }, "postcode": { "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)." } }, "required": [ "city", "country", "stateOrProvince", "postcode" ] } ] }, "qp_ListByRequestAndBillingMarket": { "type": "object", "required": [ "portRequestNumber", "billingMarket" ], "properties": { "portPath": { "type": "string", "enum": [ "O", "I" ], "description": "This can be either 'O' -PortOut; 'I'-PortIn; if not populated it is considered PortIn 'I'. Must be 'O' for date range queries." }, "billingMarket": { "type": "string", "minLength": 2, "maxLength": 3, "description": "Billing market." }, "billingSubMarket": { "type": "string", "maxLength": 3, "description": "Billing submarket." }, "portRequestNumber": { "type": "string", "maxLength": 16, "description": "Port request number input value used to query an existing port." }, "portRequestVersion": { "type": "string", "maxLength": 2, "description": "Input values used to query an existing port." }, "teleportPortRecordId": { "type": "string", "description": "Input values used to query an existing port." } } }, "lib_GeographicSubAddress_extended": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_GeographicSubAddress" }, { "type": "object", "properties": { "subUnitType": { "type": "string", "description": "the type of subunit\\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.", "enum": [ "APT", "BSMT", "BLDG", "DEPT", "FL", "FRNT", "HNGR", "LBBY", "LOT", "LOWR", "OFC", "PH", "PIER", "REAR", "RM", "SIDE", "SLIP", "SPC", "STOP", "STE", "TRLR", "UNIT", "UPPR", "u0023" ] } } } ], "title": "GeographicSubAddress_extended" }, "lib_PortabilityOrderItemStateType": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "confirmed", "executed", "deleted", "cancelled" ], "title": "PortabilityOrderItemStateType" }, "lib_MSISDNPortinOrderItem_AddPort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" }, { "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/lib_MSISDN_AUXILIARY" }, "fulfillmentOrderId": { "type": "string" }, "portRelated": { "type": "string" }, "pendingHandsetUpgradeCode": { "type": "string" }, "portRequestLineId": { "type": "number" } }, "required": [ "resource", "portRequestLineId" ] } ], "title": "MSISDNPortinOrderItem_AddPort" }, "lib_PortabilitySubject_UpdatePort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilitySubject_AddPort" }, { "type": "object", "properties": { "serviceAddress": { "$ref": "#/components/schemas/lib_GeographicAddress_UpdatePort" } } } ] }, "lib_MSISDNPortabilityOrder_AddPort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderBase" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortinOrderItem_AddPort" } }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject_AddPort" }, "portDirection": { "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D.", "oneOf": [ { "$ref": "#/components/schemas/lib_PortDirectionInfo" } ] }, "termsConditionStatus": { "description": "\"W\" - WEB Accepted, \"S\" - Physical Signature, \"P\" - Pending (regular activations), \"Y\" - Required, but pending (WLNP only).", "oneOf": [ { "$ref": "#/components/schemas/lib_TermsConditionsStatusInfo" } ] }, "desiredDueDate": { "type": "string", "format": "date-time", "description": "The desired due date. If not provided, the current date will be used" }, "immediateAct": { "description": "U -Unpark the ACT P -Park the ACT. For port inquiry if the porting process is parked/suspended in the biller this field will override the portRequestStatus/portRequestLineStatus returned in the response.", "oneOf": [ { "$ref": "#/components/schemas/lib_ImmediateActInfo" } ] }, "initiatorId": { "$ref": "#/components/schemas/lib_PortInitiatorIdInfo" }, "totalNumberOfSubscriberNumbers": { "$ref": "#/components/schemas/lib_TotalNumberOfSubscriberNumbersInfo" }, "requestRemarks": { "type": "string", "maxLength": 160 }, "contract": { "$ref": "#/components/schemas/lib_Contract" }, "desiredDueTime": { "type": "string" }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo_Choice" }, "commission": { "$ref": "#/components/schemas/lib_Commission_AddPort" }, "portCreationDate": { "type": "string" }, "portPath": { "type": "string" }, "portCancellationReasonCode": { "type": "string" }, "actionId": { "type": "string" }, "delayCode": { "type": "string" }, "errorType": { "type": "string" }, "messageCd": { "type": "string" }, "oldResName": { "type": "string" }, "operationId": { "type": "string" }, "portRequestStatus": { "type": "string" } }, "required": [ "orderItem", "portabilitySubject", "portDirection", "marketServiceInfo", "commission" ] } ] }, "lib_ResourceAdministrativeStateType": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "title": "ResourceAdministrativeStateType", "description": "ResourceAdministrativeStateType enumerations" }, "lib_MSISDNPortabilityOrderRefOrValue": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrderRef" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "telportRecordId": { "type": "string" }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject" }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." } }, "required": [ "orderItem" ] } ], "title": "MSISDNPortabilityOrderRefOrValue" }, "lib_PortabilityOrderItemRelationship": { "type": "object", "title": "PortabilityOrderItemRelationship", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Unique identifier of an order item" }, "type": { "type": "string", "description": "The type of related order item, can be dependancy if the order item needs to be not started until another order item is complete" } } }, "lib_PortabilitySubject_minorExtension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilitySubject" }, { "type": "object", "properties": { "billingAccountNumber": { "type": "string", "description": ".", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" } } } ] }, "lib_MSISDNPortabilityOrder_UpdatePort": { "type": "object", "required": [ "portDirection", "marketServiceInfo" ], "properties": { "id": { "type": "string", "description": "ID created on repository side." }, "href": { "type": "string", "description": "Hyperlink to access the order." }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "state": { "$ref": "#/components/schemas/lib_PortabilityOrderStateType" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name." }, "dispute": { "type": "boolean" }, "priority": { "$ref": "#/components/schemas/lib_PortabilityPriorityType" }, "portPath": { "type": "string" }, "orderDate": { "type": "string", "format": "date-time", "description": "Date at which the PortabilityOrder has been created." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem_UpdatePort" } }, "externalId": { "type": "string", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)." }, "commission": { "$ref": "#/components/schemas/lib_Commission" }, "description": { "type": "string", "description": "Description of the product order." }, "stateReason": { "type": "string", "description": "State reason short code." }, "initiatorId": { "$ref": "#/components/schemas/lib_PortInitiatorIdInfo" }, "portOutInfo": { "$ref": "#/components/schemas/lib_PortOutInfo" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "description": "This will store customer data for port-in requests; not needed for port-out requests." }, "immediateAct": { "oneOf": [ { "$ref": "#/components/schemas/lib_ImmediateActInfo" } ], "description": "U -Unpark the ACT P -Park the ACT. For port inquiry if the porting process is parked/suspended in the biller this field will override the portRequestStatus/portRequestLineStatus returned in the response." }, "portDirection": { "oneOf": [ { "$ref": "#/components/schemas/lib_PortDirectionInfo" } ], "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D." }, "completionDate": { "type": "string", "format": "rfc3339", "description": "Date when the order was completed" }, "desiredDueDate": { "type": "string", "format": "date-time", "description": "The desired due date. If not provided, the current date will be used" }, "requestRemarks": { "type": "string", "maxLength": 160 }, "serviceProvider": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityServiceProvider" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships." }, "telportRecordId": { "type": "string" }, "authorizationDate": { "type": "string", "format": "rfc3339", "description": "Date at which the PortabilityOrder has been authorized by the customer." }, "orderRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortabilityOrderRelationship" } }, "marketServiceInfo": { "$ref": "#/components/schemas/lib_MarketServiceInfo_Choice" }, "groupRequestNumber": { "type": "string" }, "requestedStartDate": { "type": "string", "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." }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject_UpdatePort" }, "serviceProviderInfo": { "$ref": "#/components/schemas/lib_ServiceProviderInfo" }, "lastModificationDate": { "type": "string", "format": "date-time", "description": "Date when the order was last modified." }, "termsConditionStatus": { "oneOf": [ { "$ref": "#/components/schemas/lib_TermsConditionsStatusInfo" } ], "description": "\"W\" - WEB Accepted, \"S\" - Physical Signature, \"P\" - Pending (regular activations), \"Y\" - Required, but pending (WLNP only)." }, "teleportPortRecordId": { "type": "string" }, "expectedCompletionDate": { "type": "string", "format": "date-time", "description": "Expected delivery date amended by the provider." }, "stateReasonDescription": { "type": "string", "description": "State reason description" }, "requestedCompletionDate": { "type": "string", "format": "date-time", "description": "Date at which the requestor wishes the portability to take place." }, "totalNumberOfSubscriberNumbers": { "$ref": "#/components/schemas/lib_TotalNumberOfSubscriberNumbersInfo" } } }, "lib_TotalNumberOfSubscriberNumbersInfo": { "type": "integer", "title": "TotalNumberOfSubscriberNumbersInfo" }, "lib_MSISDNPortabilityOrder_InquirePort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderBase" }, { "type": "object", "properties": { "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_MSISDNPortinOrderItem_AddPort" } }, "portabilitySubject": { "$ref": "#/components/schemas/lib_PortabilitySubject_AddPort" }, "portDirection": { "description": "Wireline to Wireline = A, Wireless to Wireless = B, Wireless to Wireline = C, Wireline to Wireless = D.", "oneOf": [ { "$ref": "#/components/schemas/lib_PortDirectionInfo" } ] }, "termsConditionStatus": { "description": "\"W\" - WEB Accepted, \"S\" - Physical Signature, \"P\" - Pending (regular activations), \"Y\" - Required, but pending (WLNP only).", "oneOf": [ { "$ref": "#/components/schemas/lib_TermsConditionsStatusInfo" } ] }, "desiredDueDate": { "type": "string", "format": "date-time", "description": "The desired due date. If not provided, the current date will be used" }, "immediateAct": { "description": "U -Unpark the ACT P -Park the ACT. For port inquiry if the porting process is parked/suspended in the biller this field will override the portRequestStatus/portRequestLineStatus returned in the response.", "oneOf": [ { "$ref": "#/components/schemas/lib_ImmediateActInfo" } ] }, "initiatorId": { "$ref": "#/components/schemas/lib_PortInitiatorIdInfo" }, "totalNumberOfSubscriberNumbers": { "$ref": "#/components/schemas/lib_TotalNumberOfSubscriberNumbersInfo" }, "requestRemarks": { "type": "string", "maxLength": 160 }, "contract": { "$ref": "#/components/schemas/lib_Contract" }, "desiredDueTime": { "type": "string" }, "portCreationDate": { "type": "string" }, "portPath": { "type": "string" }, "portCancellationReasonCode": { "type": "string" }, "portWorkListInfo": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PortWorkListInfo" } } }, "required": [ "orderItem" ] } ] }, "lib_MSISDNPortabilityOrderItem_extended": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_PortabilityOrderItem" }, { "type": "object", "properties": { "action": { "description": "used for portin portout etc; can be extended or updated directly", "oneOf": [ { "$ref": "#/components/schemas/lib_PortabilityActionType" } ] }, "resource": { "$ref": "#/components/schemas/lib_MSISDN_AUXILIARY" }, "fulfillmentOrderId": { "type": "string" }, "portRelated": { "type": "string" }, "pendingHandsetUpgradeCode": { "type": "string" }, "portRequestLineId": { "type": "number" }, "portRequestLineStatus": { "type": "string" }, "portStatus": { "type": "string" } } } ], "title": "MSISDNPortabilityOrderItem_extended" }, "lib_MSISDNPortabilityOrderItem_UpdatePort": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNPortabilityOrderItem" }, { "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/lib_MSISDN_AUXILIARY" }, "fulfillmentOrderId": { "type": "string" }, "portRequestLineId": { "type": "number" } }, "required": [ "resource", "portRequestLineId" ] } ], "title": "MSISDNPortabilityOrderItem_UpdatePort" } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF689", "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-TMF689", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF689", "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-TMF689", "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-TMF689", "message": "Unauthorized" } } }, "description": "Invalid credentials." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF689", "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-TMF689", "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-TMF689", "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-TMF689" } } }, "description": "Unacceptable request body." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported mediaType", "status": "415-UNSUPPORTED_MEDIA_TYPE-TMF689", "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-TMF689", "message": "Internal Server Error" } } }, "description": "Processing error for the request." } }, "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 curl --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=example-fpc-cookie; stsservicecookie=example-estsfd; x-ms-gateway-slice=example-estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=example-client-id' \r\n --data-urlencode 'client_secret=example-client-secret' \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": "Recommended format is 32 hexadecimal characters GUID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)." } }, "requestBodies": {} } }