patchMSISDNReservation

Version 4.0.0
download iconDownload spec

Endpoint

PATCH
undefined/resourceReservation/{id}

This operation partially updates a MSISDNReservation entity. Releases a subscriber number. (TMF 716)

arrowSecurity

oauth2

Get a JWT Token from AT&T's Azure AD
authorizationCode:
scopes:
tokenUrl:https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token
authorizationUrl:https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token
arrowRequest

Query Parameters

    Body Parameters

    Responses

    Updated

    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
    curl --request PATCH \
     --url 'https://example.com/resourceReservation/id?@type=string' \
     --header 'accept: application/json;charset=utf-8' \
     --header 'content-type: application/json' \
     --data '
{
  "value": {
    "@type": "MSISDNReservation_Update",
    "operationType": "RELEASE",
    "reservationItem": [
      {
        "@type": "MSISDNReservationItem",
        "action": "delete",
        "resource": {
          "@type": "MSISDN",
          "value": "5466231488"
        }
      }
    ],
    "marketServiceInfo": {
      "billingMarket": "ABC",
      "billingSubMarket": "DEF"
    }
  },
  "description": "This service enables clients to release previously reserved subscriber number. All subscriber numbers must be in a pre-activation/reserved state, or else an error will be returned to the client",
  "displayName": "releaseRequest",
  "operationType": "RELEASE"
}
'

    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
    {
  "value": {
    "@type": "MSISDNReservation",
    "operationType": "RELEASE",
    "reservationItem": [
      {
        "@type": "MSISDNReservationItem",
        "isReleased": true,
        "resource": {
          "@type": "MSISDN",
          "equipmentType": "G",
          "serviceArea": "123456789012",
          "value": "5466231488"
        }
      }
    ],
    "marketServiceInfo": {
      "billingMarket": "ABC",
      "billingSubMarket": "DEF"
    },
    "billingAccountNumber": "123456789"
  },
  "description": "API response for above  \"releaseRequest\"",
  "displayName": "releaseResponse",
  "operationType": "RELEASE"
}