AT&T MVNX API

Cancel Port

Version 4.0.0
download iconDownload spec
View Use Cases

Endpoint

POST
https://lgw.att.com/cancelPortabilityOrder

This operation creates a CancelPortabilityOrder entity. (TMF 689)

arrowRequest

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
        curl --request POST \
     --url https://lgw.att.com/cancelPortabilityOrder \
     --header 'accept: string' \
     --header 'authorization: string' \
     --header 'content-type: application/json' \
     --data '
{
  "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"
}
'

        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
80
        {
  "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"
}