AT&T DevEx

MVNX API

  • Contact Us

    • Cancel Port

    Version 1.0.36
    download iconDownload spec

    Endpoint

    POST
    undefined/cancelPortabilityOrder

    This operation creates a CancelPortabilityOrder entity.

    arrowSecurity

    oauth2

    Get a JWT Token from AT&T's Azure AD
    x-amf-describedBy:
    headers:
    Authorization:
    responses:
    200:
    body:
    application/json:
    properties:
    token_type:
    default:Bearer
    example:Bearer
    expires_in:
    format:int
    ext_expires_in:
    format:int
    access_token:
    example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    400:
    body:
    application/json:
    properties:
    error:
    example:unauthorized_client
    error_description:
    example:AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\r\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\r\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\r\nTimestamp: 2021-06-30 21:12:34Z
    error_codes:
    items:
    format:int
    timestamp:
    example:2021-06-30 21:12:34Z
    trace_id:
    example:b82bea2f-5ee3-48a4-9774-4143176a6900
    correlation_id:
    example:b57403ef-e775-49f6-b40f-009ba759c301
    error_uri:
    example:https://login.microsoftonline.com/error?code=700016
    x-amf-settings:
    authorizationGrants:
    0:client_credentials
    clientCredentials:
    tokenUrl:https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token
    scopes:
    *:
    arrowRequest

    Query Parameters

      Header Parameters

            Body Parameters

            Responses

            Created

            arrowBody

            application/json

            REQUEST

            1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
            curl --request POST \
     --url 'https://example.com/cancelPortabilityOrder?@type=string' \
     --header 'Accept: string' \
     --header 'Authorization: string' \
     --header 'X-ATT-CorrelationId: string' \
     --header 'content-type: application/json' \
     --data '
{
  "href": "string",
  "cancellationReason": "string",
  "effectiveCancellationDate": "2023-09-20T17:54:40.939Z",
  "requestedCancellationDate": "2023-09-20T17:54:40.939Z",
  "reasonCode": "string",
  "initiatorId": "string",
  "subscriberNumber": "1234567890",
  "portabilityOrder": {
    "id": "string",
    "href": "string",
    "authorizationDate": "2023-09-20T17:54:40.939Z",
    "completionDate": "2023-09-20T17:54:40.939Z",
    "description": "string",
    "dispute": true,
    "expectedCompletionDate": "2023-09-20T17:54:40.939Z",
    "externalId": "string",
    "groupRequestNumber": "string",
    "lastModificationDate": "2023-09-20T17:54:40.939Z",
    "orderDate": "2023-09-20T17:54:40.939Z",
    "portRequestNumber": "string",
    "portRequestNumberVersion": "string",
    "requestedCompletionDate": "2023-09-20T17:54:40.939Z",
    "requestedStartDate": "2023-09-20T17:54:40.939Z",
    "stateReason": "string",
    "stateReasonDescription": "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"
      }
    ],
    "portabilitySubject": {
      "authorizationName": "string",
      "billingFirstName": "string",
      "billingLastName": "string",
      "billingMiddleInitial": "string",
      "billingAccountNumber": "123456789",
      "billingNamePrefix": "string",
      "billingNameSuffix": "string",
      "businessName": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string"
    },
    "marketServiceInfo": {
      "id": "string",
      "href": "string",
      "name": "string",
      "role": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string",
      "@referredType": "string",
      "serviceZipCode": "12345",
      "billingMarket": "string",
      "billingSubMarket": "string",
      "localMarket": "string",
      "billingSystemId": "string",
      "productType": "string"
    },
    "telportRecordId": "string",
    "state": "acknowledged",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string",
    "name": "string",
    "@referredType": "string"
  },
  "state": "accepted",
  "@baseType": "string",
  "@schemaLocation": "string",
  "@type": "string"
}
'

            RESPONSE

            1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
            {
  "href": "string",
  "cancellationReason": "string",
  "effectiveCancellationDate": "2023-09-20T17:54:40.939Z",
  "requestedCancellationDate": "2023-09-20T17:54:40.939Z",
  "reasonCode": "string",
  "initiatorId": "string",
  "subscriberNumber": "1234567890",
  "portabilityOrder": {
    "id": "string",
    "href": "string",
    "authorizationDate": "2023-09-20T17:54:40.939Z",
    "completionDate": "2023-09-20T17:54:40.939Z",
    "description": "string",
    "dispute": true,
    "expectedCompletionDate": "2023-09-20T17:54:40.939Z",
    "externalId": "string",
    "groupRequestNumber": "string",
    "lastModificationDate": "2023-09-20T17:54:40.939Z",
    "orderDate": "2023-09-20T17:54:40.939Z",
    "portRequestNumber": "string",
    "portRequestNumberVersion": "string",
    "requestedCompletionDate": "2023-09-20T17:54:40.939Z",
    "requestedStartDate": "2023-09-20T17:54:40.939Z",
    "stateReason": "string",
    "stateReasonDescription": "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"
      }
    ],
    "portabilitySubject": {
      "authorizationName": "string",
      "billingFirstName": "string",
      "billingLastName": "string",
      "billingMiddleInitial": "string",
      "billingAccountNumber": "123456789",
      "billingNamePrefix": "string",
      "billingNameSuffix": "string",
      "businessName": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string"
    },
    "marketServiceInfo": {
      "id": "string",
      "href": "string",
      "name": "string",
      "role": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string",
      "@referredType": "string",
      "serviceZipCode": "12345",
      "billingMarket": "string",
      "billingSubMarket": "string",
      "localMarket": "string",
      "billingSystemId": "string",
      "productType": "string"
    },
    "telportRecordId": "string",
    "state": "acknowledged",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string",
    "name": "string",
    "@referredType": "string"
  },
  "state": "accepted",
  "@baseType": "string",
  "@schemaLocation": "string",
  "@type": "string"
}