AT&T DevEx

PINV Capabilities

Version 1.0 (latest)

Saves, merges, and updates provided TMF637 product data

Version 1.0
download iconDownload spec

Endpoint

POST
https://pinv.dev.att.com/products

Saves the provided TMF637 data and retrieves existing TMF637 data associated with the incoming product. If data associated with this product does already exist, merge rules are applied to create a new merged TMF637 document that is stored in the database and returned to the client. This endpoint is able to process: - single TMF637 document, - package of TMF637 documents contained of ADI (AT&T Dedicated Internet), ACCESS and PORT parts, - package of TMF637 documents contained of ADI (AT&T Dedicated Internet), ACCESS, PORT and DD (Dynamic Defense) parts. Refer to the examples for more details on the payload structure. This endpoint is subject to authorization with the corresponding source.

arrowSecurity

http

scheme:bearer
bearerFormat:JWT
arrowRequest

Query Parameters

    Body Parameters

    Responses

    Merger of corresponding TMF637 data from various sources. The response contains either: 1. an array of single TMF637 document representing provided package part if no other related package parts were updated, 1. an array of multiple TMF637 documents containing provided updated package part and: - updated related package parts in case the product relationship id had to be updated in other package parts, - or other package parts if the query parameter `as-adi-package` was set to `true`.

    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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
    curl --request POST \
     --url 'https://pinv.dev.att.com/products?as-adi-package=' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "headers": {
    "datacontenttype": "application/json",
    "id": "41-1234567",
    "time": "2024-10-03 12:34:56.123Z",
    "type": "com.att.c360dataPrep.tmf637.post.v5",
    "source": "billing",
    "version": "5",
    "traceparent": "...",
    "tracestate": "..."
  },
  "value": {
    "@type": "AttProduct",
    "@baseType": "Product",
    "@schemaLocation": "/schema/AttProduct_tmf637.schema.json",
    "id": "41-1234567",
    "status": "active",
    "name": "AT&T Dedicated Internet (ADI)",
    "externalReference": [
      {
        "@type": "ExternalIdentifier",
        "id": ".BMEC.123456..ATI.",
        "externalIdentifierType": "CircuitID",
        "owner": "INSTAR"
      },
      {
        "@type": "ExternalIdentifier",
        "id": "192837465",
        "externalIdentifierType": "SiteID",
        "owner": "INSTAR"
      }
    ],
    "relatedParty": [
      {
        "@type": "RelatedPartyOrPartyRole",
        "role": "Customer",
        "partyOrPartyRole": {
          "@type": "Organization",
          "contactMedium": [
            {
              "@type": "GeographicAddressContactMedium",
              "@schemaLocation": "/location/schema/geographicAddressExtended.json",
              "contactType": "ServiceAddress",
              "postCode": "31793",
              "country": "US",
              "street1": "2360 RAINWATER RD BLDG FMO",
              "stateOrProvince": "GA",
              "city": "TIFTON"
            }
          ],
          "status": "validated",
          "organizationType": "company",
          "isLegalEntity": true,
          "externalReference": [
            {
              "@type": "ExternalIdentifier",
              "externalIdentifierType": "CustID",
              "id": "12349876",
              "owner": "Instar"
            }
          ],
          "tradingName": "PINV Ltd.",
          "name": "PINV Ltd."
        }
      },
      {
        "@type": "RelatedPartyOrPartyRole",
        "role": "User",
        "partyOrPartyRole": {
          "@type": "Organization",
          "contactMedium": [
            {
              "@type": "GeographicAddressContactMedium",
              "@schemaLocation": "",
              "contactType": "ServiceAddress",
              "postCode": "84105",
              "country": "US",
              "street1": "501 Progress Ave",
              "stateOrProvince": "HI",
              "city": "Honolulu"
            }
          ],
          "status": "deceased",
          "organizationType": "company",
          "isLegalEntity": true,
          "externalReference": [
            {
              "@type": "ExternalIdentifier",
              "externalIdentifierType": "CustID",
              "id": "22349876",
              "owner": "Instar"
            }
          ],
          "tradingName": "KIND DEVELOPERS",
          "name": "KIND DEVELOPERS"
        }
      }
    ],
    "place": [
      {
        "@type": "RelatedPlaceRefOrValue",
        "role": "ServiceAddress",
        "place": {
          "@type": "GeographicAddress",
          "geographicSubAddress": [
            {
              "@type": "geographicSubAddress",
              "levelNumber": "2",
              "levelType": "FL",
              "buildingName": "BLDG MAIN",
              "subUnit": [
                {
                  "@type": "GeographicSubAddressUnit",
                  "subUnitType": "UNIT",
                  "subUnitNumber": "200"
                }
              ]
            }
          ],
          "streetName": "156 GENEVA DR",
          "postcode": "32765-7203",
          "city": "OVIEDO",
          "stateOrProvince": "FL",
          "country": "USA"
        }
      },
      {
        "@type": "RelatedPlaceRefOrValue",
        "role": "BillingAddress",
        "place": {
          "streetName": "5612 Oxford",
          "streetType": "PL",
          "postcode": "40291",
          "city": "Louisville",
          "stateOrProvince": "KY",
          "country": "USA",
          "@type": "GeographicAddress",
          "geographicSubAddress": [
            {
              "buildingName": "APT APT",
              "@type": "geographicSubAddress",
              "subUnit": [
                {
                  "@type": "GeographicSubAddressUnit",
                  "subUnitType": "APT",
                  "subUnitNumber": "APT"
                }
              ]
            }
          ]
        }
      }
    ],
    "realizingService": [
      {
        "@type": "ServiceRef",
        "id": ".CMEC.123456..ATI.",
        "name": "SomeOtherId"
      },
      {
        "@type": "ServiceRef",
        "id": ".BMEC.123456..ATI.",
        "name": "CircuitID"
      }
    ],
    "realizingResource": [
      {
        "@type": "ResourceRef",
        "id": "987654321",
        "name": "PortID"
      },
      {
        "@type": "ResourceRef",
        "id": "1.2.3.4",
        "name": "IPv4"
      },
      {
        "@type": "ResourceRef",
        "id": "1111:abc::de00:23:4567",
        "name": "IPv6"
      },
      {
        "@type": "ResourceRef",
        "id": "1234abcd5678",
        "name": "CPE-SerialNumber"
      }
    ],
    "productSpecification": {
      "@type": "ProductSpecificationRef",
      "id": "PR-ADI-EMBEDDED-BASE",
      "name": "HORIZON Dedicated Internet (HDI)",
      "version": "Embedded Base 10.0"
    },
    "productPrice": [
      {
        "@type": "ProductPrice",
        "priceType": "Access-Price",
        "price": {
          "@type": "Price",
          "dutyFreeAmount": {
            "value": "123.00",
            "unit": "USD"
          },
          "taxIncludedAmount": {
            "value": "135.30"
          },
          "taxRate": "10.0"
        }
      }
    ]
  }
}
'

    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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
    {
  "status": 201,
  "timestamp": "2024-11-18T15:25:57.137Z",
  "responseData": {
    "headers": {
      "datacontenttype": "application/json",
      "id": "c31f5942-e198-4272-9811-ce4677d97b77",
      "time": "2024-10-03 12:34:56.123Z",
      "type": "com.att.c360dataPrep.tmf637.post.v5",
      "source": "billing",
      "version": "5",
      "traceparent": "...",
      "tracestate": "..."
    },
    "value": {
      "id": "9ffb3182-409d-48cb-a266-1379117bff58",
      "status": "active",
      "name": "AT&T Dedicated Internet (ADI)",
      "relatedParty": [
        {
          "@type": "RelatedPartyOrPartyRole",
          "role": "Customer",
          "partyOrPartyRole": {
            "@type": "Organization",
            "contactMedium": [
              {
                "@type": "GeographicAddressContactMedium",
                "@schemaLocation": "",
                "contactType": "ServiceAddress",
                "postCode": "96813",
                "country": "US",
                "street1": "502 700 Bishop St Ste",
                "stateOrProvince": "HI",
                "city": "Honolulu"
              }
            ],
            "status": "validated",
            "organizationType": "company",
            "isLegalEntity": true,
            "externalReference": [
              {
                "@type": "ExternalIdentifier",
                "externalIdentifierType": "CustID",
                "id": "12349876",
                "owner": "Instar"
              }
            ],
            "tradingName": "FRIENDLY ARCHITECTS",
            "name": "FRIENDLY ARCHITECTS"
          }
        }
      ],
      "place": [
        {
          "@type": "RelatedPlaceRefOrValue",
          "role": "ServiceAddress",
          "place": {
            "@type": "GeographicAddress",
            "geographicSubAddress": [
              {
                "@type": "GeographicSubAddress",
                "buildingName": "",
                "levelType": "Floor",
                "levelNumber": "1",
                "subUnit": [
                  {
                    "@type": "GeographicSubAddressUnit",
                    "subUnitNumber": "123",
                    "subUnitType": "Unit"
                  }
                ]
              }
            ],
            "streetName": "321 FMO DRIVE",
            "country": "US",
            "city": "TRUE NORTH CITY",
            "postcode": "12345",
            "stateOrProvince": "ZZ"
          }
        }
      ],
      "productCharacteristic": [
        {
          "@type": "StringCharacteristic",
          "name": "Management Option",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Billing Option",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "IP Version",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "WAN IPv4 Block Size",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Additional WAN IPv4 Addresses Needed",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "LanIPv4 Address Block Size",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Additional LAN IP Addresses",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Class of Service",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Class of Service Profile",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Access Speed",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "MBC Speed",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Port Speed",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Interface",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Router Model",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Router Manufacturer",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Vendor",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Service MCN Triplet",
          "value": ""
        },
        {
          "@type": "StringCharacteristic",
          "name": "Access MCN Triplet",
          "value": ""
        }
      ],
      "@type": "ATTProduct",
      "@baseType": "Product",
      "@schemaLocation": "/schema/AttProduct_tmf637.schema.json",
      "externalReference": [
        {
          "@type": "ExternalIdentifier",
          "id": ".BMEC.123456..ATI.",
          "externalIdentifierType": "CircuitID",
          "owner": "INSTAR"
        },
        {
          "@type": "ExternalIdentifier",
          "id": "192837465",
          "externalIdentifierType": "SiteID",
          "owner": "INSTAR"
        }
      ],
      "externalBillingAccountReference": [],
      "productSpecification": {
        "@type": "ProductSpecificationRef",
        "id": "PR-ADI-EMBEDDED-BASE",
        "name": "AT&T Dedicated Internet (ADI)",
        "version": "Embedded Base 1.0"
      },
      "agreementItem": [],
      "realizingService": [
        {
          "@type": "ServiceRef",
          "id": ".BMEC.123456..ATI.",
          "name": "CircuitID"
        }
      ],
      "realizingResource": [
        {
          "@type": "ResourceRef",
          "id": "987654321",
          "name": "PortID"
        },
        {
          "@type": "ResourceRef",
          "id": "1.2.3.4",
          "name": "IPv4"
        },
        {
          "@type": "ResourceRef",
          "id": "1111:abc::de00:23:4567",
          "name": "IPv6"
        },
        {
          "@type": "ResourceRef",
          "id": "1234abcd5678",
          "name": "CPE-SerialNumber"
        }
      ],
      "externalIdentifier": [
        {
          "owner": "provisioning",
          "externalIdentifierType": "id",
          "id": "3036ac98-760b-45e6-9b6d-50cb8cfc08d1"
        }
      ],
      "href": "/products/671b9d13d56f91ccd66e0142"
    }
  }
}