AT&T DevEx

Omni APIs Central | Wireless Solutions | Add a Line | Digital PoS

Version 1.0.0 (latest)

Terms consent updates on the order

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://partner-omni-apis.att.com/omni-svcs/v1/order/{orderid}/terms

Update terms consent for an order

arrowRequest

Terms request body

Path Parameters

    Body Parameters

    Responses

    Terms response

    arrowBody

    application/json

    REQUEST

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
    curl --request POST \
     --url https://partner-omni-apis.att.com/omni-svcs/v1/order/string/terms \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "agreements": [
    {
      "name": "string",
      "extensions": [
        {
          "name": "string",
          "value": "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
    {
  "validation": {
    "status": "string",
    "readyToSubmit": false,
    "validationMessage": [
      {
        "text": "string",
        "type": "string",
        "parameter": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configuration": [
      {
        "type": "string",
        "status": "string",
        "required": false,
        "postOrderConfigurable": false
      }
    ]
  },
  "error": {
    "errorCode": "<400-INVALID-REQUEST>",
    "errorDescription": "Validation Failure",
    "errorList": [
      {
        "action": "terms",
        "errorCode": "TERMS-XXX",
        "errorDescription": "TERMS xxx",
        "errorDetails": [
          {
            "system": "DTAP",
            "errorCode": "DTAPXXX",
            "errorDescription": "DTAPXXX"
          }
        ]
      }
    ]
  }
}