Inquire Port By ID
Version 4.0.0
Endpoint
GET
https://lgw.att.com/portabilityOrder/{id}
Copy
This operation retrieves a PortabilityOrder request status using the portRequestNumber as ID. (TMF 689)
Query Parameters
- queryStringRequiredqueryString can be ONE OF the following schemas:
- schema#0object
- schema#1object
- schema#2object
- schema#3object
Header Parameters
- AuthorizationstringRequiredJWT Bearer Token. Token URL: https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token See example below. curl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Cookie: fpc=example-fpc-cookie; stsservicecookie=example-estsfd; x-ms-gateway-slice=example-estsfd' --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' --data-urlencode 'grant_type=client_credentials' --data-urlencode 'client_id=example-client-id' --data-urlencode 'client_secret=example-client-secret' Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on
- AcceptstringRequiredSpecifies the media type as "application/json".
- X-ATT-CorrelationIdstringRecommended format is 32 hexadecimal characters GUID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX).
Body Parameters
Responses
Success
Body
application/json
- objectRequired
- idstringID created on repository side.
- hrefstringHyperlink to access the order.
- notearray of objects
- statestringEnum: [acknowledged, pending, sent, delayed, rejected, held, confirmed, inProgress, cancelled, completed, failed, partial, CF, CN, CO, CT, DN, ER, OP]
- @typestringWhen sub-classing, this defines the sub-class Extensible name.
- disputeboolean
- prioritystringEnum: [regular, expedite]
- orderDatestringDate at which the PortabilityOrder has been created.
- orderItemarray of objects
- @baseTypestringWhen sub-classing, this defines the super-class.
- externalIdstringID given by the consumer and only understandable by him (to facilitate his searches afterwards).
- descriptionstringDescription of the product order.
- stateReasonstringState reason short code.
- relatedPartyarray of objects(This will store customer data for port-in requests; not needed for port-out requests.)
- completionDatestringDate when the order was completed
- serviceProviderarray of objects
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships.
- authorizationDatestringDate at which the PortabilityOrder has been authorized by the customer.
- portRequestNumberstringIndustry-standard PON identifier associated to this Portability request.
- orderRelationshiparray of objects
- groupRequestNumberstring
- requestedStartDatestringOrder 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.
- portabilitySubjectobject
- lastModificationDatestringDate when the order was last modified.
- expectedCompletionDatestringExpected delivery date amended by the provider.
- stateReasonDescriptionstringState reason description
- requestedCompletionDatestringDate at which the requestor wishes the portability to take place.
- portRequestNumberVersionstringCurrent version of the industry-standard request.
- marketServiceInfomarketServiceInfo can be ONE OF the following schemas:
- telportRecordIdstring
- commissionobject
- serviceProviderInfoobject
- portDirectionportDirection can be ONE OF the following schemas:
- termsConditionStatustermsConditionStatus can be ONE OF the following schemas:
- desiredDueDatestringThe desired due date. If not provided, the current date will be used
- immediateActimmediateAct can be ONE OF the following schemas:
- initiatorIdstringClients are required to pass this value in the request. This value is optional in the responseLength: 16
- totalNumberOfSubscriberNumbersint
- requestRemarksstringLength: 160
- contractobject
- desiredDueTimestring
- portCreationDatestring
- portPathstring
- portCancellationReasonCodestring
- actionIdstring
- delayCodestring
- errorTypestring
- messageCdstring
- oldResNamestring
- operationIdstring
- operatorIdstring
- portRequestStatusstring
- code