{ "openapi": "3.1.0", "paths": { "/failed-messages": { "get": { "operationId": "FailedMessagesController_findFailedMessages", "summary": "Retreive failed IEBUS messages", "description": "This endpoint allows you to track messages from IEBUS that have failed or have only been partially succesfull.\n\n\nIf multiple range filters are used (ending in **.lt, .lte, .gt, .gte**), the endpoint will return the intersection of all the used range filters.\n\n\nThis endpoint is subject to authorization with the corresponding source.\n\n", "parameters": [ { "name": "id", "required": false, "in": "query", "description": "Check for failed messages by product ID", "schema": { "example": "c31f5942-e198-4272-9811-ce4677d97b77" } }, { "name": "id[]", "required": false, "in": "query", "description": "Subsequent product ID/s to check for failed messages, any number of query params can be added to the request, both \"id=\" and \"id[]=\" will work.", "schema": { "example": "c31f5942-e198-4272-9811-ce4677d97b78" } }, { "name": "offset-id", "required": false, "in": "query", "description": "Check for failed messages by offset ID of sent IEBUS message", "schema": { "example": "1337" } }, { "name": "offset-id[]", "required": false, "in": "query", "description": "Subsequent offset ID/s to check for failed messages, any number of query params can be added to the request, both \"offset-id=\" and \"offset-id[]=\" will work.", "schema": { "example": "1338" } }, { "name": "offset-id.lt", "required": false, "in": "query", "description": "Filter failed messages where the offset ID is **less than** (use **.lte** suffix for less than or equal to) the specified value. Only integer values >= 0 are valid.", "schema": { "example": "100" } }, { "name": "offset-id.gt", "required": false, "in": "query", "description": "Filter failed messages where the offset ID is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Only integer values >= 0 are valid.", "schema": { "example": "50" } }, { "name": "production-timestamp.lt", "required": false, "in": "query", "description": "Filter failed messages where the production timestamp is **less than** (use **.lte** suffix for less than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.", "schema": { "example": "2025-04-29T09:26:29.602Z" } }, { "name": "production-timestamp.gt", "required": false, "in": "query", "description": "Filter failed messages where the production timestamp is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.", "schema": { "example": "2025-04-28T09:26:29.602Z" } }, { "name": "consumption-timestamp.lt", "required": false, "in": "query", "description": "Filter failed messages where the consumption timestamp is **less than** (use **.lte** suffix for less than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.", "schema": { "example": "2025-04-29T09:26:29.602Z" } }, { "name": "consumption-timestamp.gt", "required": false, "in": "query", "description": "Filter failed messages where the consumption timestamp is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-28T09:26:29.602Z`) for ajv validation.", "schema": { "example": "2025-04-28T09:26:29.602Z" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of failed messages in one page (Default: 1000)", "schema": { "example": 1000 } }, { "name": "offset", "required": false, "in": "query", "description": "Offset position (Default: 0)", "schema": { "example": 0 } } ], "responses": { "200": { "description": "Failed message(s) successfully retrieved", "content": { "application/json": { "schema": { "example": { "status": 200, "timestamp": "2025-04-29T13:07:48.438Z", "responseData": [ { "specversion": "1.0", "type": "post", "source": "com.att.tmf637-extract-and-mapping", "id": "f7b30cf1-2fca-417d-b82f-01b3607396d1", "time": "2024-11-18T17:33:00Z", "datacontenttype": "text/json", "data": { "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": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "c31f5942-e198-4272-9811-ce4677d97b77", "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": "", "contactType": "ServiceAddress", "postCode": "96813", "country": "US", "street1": "502 700 Bishop St Ste", "stateOrProvince": "HI", "city": "Honolulu" } ], "status": "deceased", "organizationType": "company", "isLegalEntity": true, "externalReference": [ { "@type": "ExternalIdentifier", "externalIdentifierType": "CustID", "id": "12349876", "owner": "Instar" } ], "tradingName": "Bridgeport Benefits of Hawaii, LLC", "name": "Bridgeport Benefits of Hawaii, LLC" } }, { "@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": "InstallationAddress", "place": { "@type": "GeographicAddress", "streetName": "5001 EXECUTIVE PKWY", "postcode": "94583-5006", "city": "SAN RAMON", "stateOrProvince": "CA", "country": "USA", "geographicSubAddress": [ { "@type": "geographicSubAddress", "subUnit": [ { "@type": "GeographicSubAddressUnit", "subUnitType": "UNIT", "subUnitNumber": "RA6" } ] } ] } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".CMEC.123456..ATI.", "name": "SomeOtherId" }, { "@type": "ServiceRef", "id": "BBEC.651639..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" } } ] } }, "error": { "response": { "message": [ { "response": "This ID IZEC.693910..ATI-304Z23//VAA already exists. Use PATCH instead of POST", "status": 405, "message": "This ID IZEC.693910..ATI-304Z23//VAA already exists. Use PATCH instead of POST", "name": "HttpException" }, { "response": "This ID IZEC.693910..ATI-304Z23//VAA-ACCESS already exists. Use PATCH instead of POST", "status": 405, "message": "This ID IZEC.693910..ATI-304Z23//VAA-ACCESS already exists. Use PATCH instead of POST", "name": "HttpException" }, { "response": "This ID IZEC.693910..ATI-304Z23//VAA-NETWORK already exists. Use PATCH instead of POST", "status": 405, "message": "This ID IZEC.693910..ATI-304Z23//VAA-NETWORK already exists. Use PATCH instead of POST", "name": "HttpException" } ], "error": "Method Not Allowed", "statusCode": 405 }, "status": 405, "options": {}, "message": "Method Not Allowed Exception", "name": "MethodNotAllowedException" }, "metadata": { "productionTimestamp": "2025-04-29T09:25:54.103Z", "consumptionTimestamp": "2025-04-29T09:26:29.602Z", "offsetId": 1015, "topic": "com.att.tdemea.pinv.dev.provisioning-inbound", "partition": 0, "pod": "undefined_undefined" } } ] } } } } }, "404": { "description": "Failed mesage(s) not found", "content": { "application/json": { "schema": { "example": { "status": 404, "timestamp": "2025-04-29T13:07:48.438Z", "errorDetail": { "message": "failedMessageNotFoundError" } } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "Failed IEBUS Messages" ] } }, "/products": { "post": { "operationId": "ProductController_create", "summary": "Saves, merges, and updates provided TMF637 product data", "description": "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.\n\n\nThis endpoint is able to process:\n\n- single TMF637 document,\n\n- package of TMF637 documents contained of ADI (AT&T Dedicated Internet), ACCESS and PORT parts,\n\n- package of TMF637 documents contained of ADI (AT&T Dedicated Internet), ACCESS, PORT and DD (Dynamic Defense) parts.\n\n\nRefer to the examples for more details on the payload structure.\n\n\nThis endpoint is subject to authorization with the corresponding source.", "parameters": [ { "name": "as-adi-package", "required": false, "in": "query", "description": "Include the entire ADI, access, port and dynamic defense product package as an array. (Default: false)", "schema": { "example": false } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Tmf637V4PostRequestBody" }, { "$ref": "#/components/schemas/Tmf637V5PostRequestBody" }, { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5PostRequestBody" } } ] }, "examples": { "input1": { "summary": "TMF 637 V5 - billing", "value": { "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" } } ] } } }, "input2": { "summary": "TMF 637 V5 - FMO parent ADI", "value": { "headers": { "datacontenttype": "application/json", "id": "81165d96-679f-4047-9e87-4ff2c496bfff", "time": "2024-10-03 12:34:56.123Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "FMO", "version": "5", "traceparent": "...", "tracestate": "..." }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "81165d96-679f-4047-9e87-4ff2c496bfff", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "relationshipType": "HasChild", "id": "5b2b0f82-fc57-4793-a656-656f7feb60b8", "@type": "ProductRelationship" }, { "relationshipType": "HasChild", "id": "4f6c5ef5-9726-415a-b5f7-b80098ab9395", "@type": "ProductRelationship" } ], "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": "500 Progress Ave", "stateOrProvince": "HI", "city": "Honolulu" } ], "status": "deceased", "organizationType": "company", "isLegalEntity": true, "externalReference": [ { "@type": "ExternalIdentifier", "externalIdentifierType": "CustID", "id": "22349876", "owner": "Instar" } ], "tradingName": "KIND MANAGERS", "name": "KIND MANAGERS" } } ], "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": "InstallationAddress", "place": { "@type": "GeographicAddress", "streetName": "5001 EXECUTIVE PKWY", "postcode": "94583-5006", "city": "SAN RAMON", "stateOrProvince": "CA", "country": "USA", "geographicSubAddress": [ { "@type": "geographicSubAddress", "subUnit": [ { "@type": "GeographicSubAddressUnit", "subUnitType": "UNIT", "subUnitNumber": "RA6" } ] } ] } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "1234abcd5678", "name": "CPE-SerialNumber" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "IBM Dedicated Internet (IDI)", "version": "Embedded Base 10.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "" }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "" } ], "productPrice": [ { "@type": "ProductPrice", "priceType": "Access-Price", "price": { "@type": "Price", "dutyFreeAmount": { "value": "123.00" }, "taxIncludedAmount": { "value": "135.30" }, "taxRate": "10.0" } } ] } } }, "input3": { "summary": "TMF 637 V5 - FMO child access", "value": { "headers": { "datacontenttype": "application/json", "id": "5b2b0f82-fc57-4793-a656-656f7feb60b8", "time": "2024-10-03 12:34:56.123Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "FMO", "version": "5", "traceparent": "...", "tracestate": "..." }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "5b2b0f82-fc57-4793-a656-656f7feb60b8", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "relationshipType": "HasParent", "id": "81165d96-679f-4047-9e87-4ff2c496bfff", "@type": "ProductRelationship" } ], "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": "500 Progress Ave", "stateOrProvince": "HI", "city": "Honolulu" } ], "status": "deceased", "organizationType": "company", "isLegalEntity": true, "externalReference": [ { "@type": "ExternalIdentifier", "externalIdentifierType": "CustID", "id": "22349876", "owner": "Instar" } ], "tradingName": "KIND MANAGERS", "name": "KIND MANAGERS" } } ], "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": "InstallationAddress", "place": { "@type": "GeographicAddress", "streetName": "5001 EXECUTIVE PKWY", "postcode": "94583-5006", "city": "SAN RAMON", "stateOrProvince": "CA", "country": "USA", "geographicSubAddress": [ { "@type": "geographicSubAddress", "subUnit": [ { "@type": "GeographicSubAddressUnit", "subUnitType": "UNIT", "subUnitNumber": "RA6" } ] } ] } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" }, { "@type": "ServiceRef", "id": ".AMEC.123456..ATI.", "name": "SomeOtherId" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "IBM Dedicated Internet (IDI)", "version": "Embedded Base 10.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "" }, { "@type": "StringCharacteristic", "name": "MBC 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": "" } ] } } }, "input4": { "summary": "TMF 637 V5 - FMO child port", "value": { "headers": { "datacontenttype": "application/json", "id": "4f6c5ef5-9726-415a-b5f7-b80098ab9395", "time": "2024-10-03 12:34:56.123Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "FMO", "version": "5", "traceparent": "...", "tracestate": "..." }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "4f6c5ef5-9726-415a-b5f7-b80098ab9395", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "relationshipType": "HasParent", "id": "81165d96-679f-4047-9e87-4ff2c496bfff", "@type": "ProductRelationship" } ], "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": "500 Progress Ave", "stateOrProvince": "HI", "city": "Honolulu" } ], "status": "deceased", "organizationType": "company", "isLegalEntity": true, "externalReference": [ { "@type": "ExternalIdentifier", "externalIdentifierType": "CustID", "id": "22349876", "owner": "Instar" } ], "tradingName": "KIND MANAGERS", "name": "KIND MANAGERS" } } ], "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": "InstallationAddress", "place": { "@type": "GeographicAddress", "streetName": "5001 EXECUTIVE PKWY", "postcode": "94583-5006", "city": "SAN RAMON", "stateOrProvince": "CA", "country": "USA", "geographicSubAddress": [ { "@type": "geographicSubAddress", "subUnit": [ { "@type": "GeographicSubAddressUnit", "subUnitType": "UNIT", "subUnitNumber": "RA6" } ] } ] } } ], "realizingService": [ { "@type": "ResourceRef", "id": "987654321", "name": "PortID" } ], "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": "IBM Dedicated Internet (IDI)", "version": "Embedded Base 10.0" }, "productCharacteristic": [ { "@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": "" } ] } } }, "input5": { "summary": "TMF 637 V5 - provisioning parent ADI", "value": { "headers": { "datacontenttype": "application/json", "id": "106-203", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-ACCESS" }, { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-NETWORK" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PG8067/001/SS203", "externalIdentifierType": "Service MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PQ8067/002/SP203", "externalIdentifierType": "Access MCN Triplet", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "12.146.170.120", "name": "IPv4" }, { "@type": "ResourceRef", "id": "2001:1890:1C15:8100::", "name": "IPv6" }, { "@type": "ResourceRef", "id": "NA", "name": "CPE-SerialNumber" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "SO_MANAGED_INDICATOR " }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "FIXED BILLING" }, { "@type": "StringCharacteristic", "name": "IP Version", "value": "v4" }, { "@type": "StringCharacteristic", "name": "WAN IPv4 Block Size", "value": "29" }, { "@type": "StringCharacteristic", "name": "Additional WAN IPv4 Addresses Needed", "value": "No" }, { "@type": "StringCharacteristic", "name": "LanIPv4 Address Block Size", "value": "28" }, { "@type": "StringCharacteristic", "name": "Additional LAN IP Addresses", "value": "No" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "Yes" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "102" }, { "@type": "StringCharacteristic", "name": "Router Model", "value": "Ribbon 4808" }, { "@type": "StringCharacteristic", "name": "Router Manufacturer", "value": "Ribbon" } ] } } }, "input6": { "summary": "TMF 637 V5 - provisioning child access", "value": { "headers": { "datacontenttype": "application/json", "id": "106-203-ACCESS", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-ACCESS", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-ACCESS-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Vendor", "value": "Ribbon" } ] } } }, "input7": { "summary": "TMF 637 V5 - provisioning child port", "value": { "headers": { "datacontenttype": "application/json", "id": "106-203-NETWORK", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-NETWORK", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "29999999", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "29999999", "name": "PortID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-PORT-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Minimum Bandwidth Commitment", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Port Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Interface", "value": "10G baseLR SMF" } ] } } }, "input8": { "summary": "TMF 637 V5 - provisioning DD", "value": { "headers": { "datacontenttype": "application/json", "id": "106-203-DynamicDefense", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-DynamicDefense", "status": "active", "name": "AT&T Dynamic Defense", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "Requires", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "29999999", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "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." } } ], "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" } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" } ], "realizingResource": [ { "@type": "ResourceRef", "id": "29999999", "name": "PortID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-DYNAMIC-DEFENSE-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Tier", "value": "1" } ] } } }, "input9": { "summary": "TMF 637 V5 - provisioning package (ADI, ACCESS, PORT)", "value": [ { "headers": { "datacontenttype": "application/json", "id": "106-203", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-ACCESS" }, { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-NETWORK" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PG8067/001/SS203", "externalIdentifierType": "Service MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PQ8067/002/SP203", "externalIdentifierType": "Access MCN Triplet", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "12.146.170.120", "name": "IPv4" }, { "@type": "ResourceRef", "id": "2001:1890:1C15:8100::", "name": "IPv6" }, { "@type": "ResourceRef", "id": "NA", "name": "CPE-SerialNumber" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "SO_MANAGED_INDICATOR " }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "FIXED BILLING" }, { "@type": "StringCharacteristic", "name": "IP Version", "value": "v4" }, { "@type": "StringCharacteristic", "name": "WAN IPv4 Block Size", "value": "29" }, { "@type": "StringCharacteristic", "name": "Additional WAN IPv4 Addresses Needed", "value": "No" }, { "@type": "StringCharacteristic", "name": "LanIPv4 Address Block Size", "value": "28" }, { "@type": "StringCharacteristic", "name": "Additional LAN IP Addresses", "value": "No" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "Yes" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "102" }, { "@type": "StringCharacteristic", "name": "Router Model", "value": "Ribbon 4808" }, { "@type": "StringCharacteristic", "name": "Router Manufacturer", "value": "Ribbon" } ] } }, { "headers": { "datacontenttype": "application/json", "id": "106-203-ACCESS", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-ACCESS", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-ACCESS-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Vendor", "value": "Ribbon" } ] } }, { "headers": { "datacontenttype": "application/json", "id": "106-203-NETWORK", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-NETWORK", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "29999999", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "29999999", "name": "PortID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-PORT-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Minimum Bandwidth Commitment", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Port Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Interface", "value": "10G baseLR SMF" } ] } } ] }, "input10": { "summary": "TMF 637 V5 - provisioning package (ADI, ACCESS, PORT, DD)", "value": [ { "headers": { "datacontenttype": "application/json", "id": "106-203", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-ACCESS" }, { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "106-203-NETWORK" }, { "@type": "ProductRelationship", "relationshipType": "AnotherType", "id": "106-203-ANOTHER" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PG8067/001/SS203", "externalIdentifierType": "Service MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "PQ8067/002/SP203", "externalIdentifierType": "Access MCN Triplet", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "12.146.170.120", "name": "IPv4" }, { "@type": "ResourceRef", "id": "2001:1890:1C15:8100::", "name": "IPv6" }, { "@type": "ResourceRef", "id": "NA", "name": "CPE-SerialNumber" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "SO_MANAGED_INDICATOR " }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "FIXED BILLING" }, { "@type": "StringCharacteristic", "name": "IP Version", "value": "v4" }, { "@type": "StringCharacteristic", "name": "WAN IPv4 Block Size", "value": "29" }, { "@type": "StringCharacteristic", "name": "Additional WAN IPv4 Addresses Needed", "value": "No" }, { "@type": "StringCharacteristic", "name": "LanIPv4 Address Block Size", "value": "28" }, { "@type": "StringCharacteristic", "name": "Additional LAN IP Addresses", "value": "No" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "Yes" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "102" }, { "@type": "StringCharacteristic", "name": "Router Model", "value": "Ribbon 4808" }, { "@type": "StringCharacteristic", "name": "Router Manufacturer", "value": "Ribbon" } ] } }, { "headers": { "datacontenttype": "application/json", "id": "106-203-ACCESS", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-ACCESS", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" }, { "@type": "ProductRelationship", "relationshipType": "AnotherType", "id": "106-203-ANOTHER" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-ACCESS-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Vendor", "value": "Ribbon" } ] } }, { "headers": { "datacontenttype": "application/json", "id": "106-203-NETWORK", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-NETWORK", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "29999999", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "NULL", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "9999999", "externalIdentifierType": "SAPID", "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." } } ], "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" } } ], "realizingResource": [ { "@type": "ResourceRef", "id": "29999999", "name": "PortID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-PORT-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Minimum Bandwidth Commitment", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Port Speed", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Interface", "value": "10G baseLR SMF" } ] } }, { "headers": { "datacontenttype": "application/json", "id": "106-203-DynamicDefense", "time": "2024-12-20 13:33:27.470Z", "type": "com.att.pinvDataPrep.tmf637.post.v5", "source": "provisioning", "version": "5", "traceparent": "data_load_id: 106 ; pinv_sales_network_id: 203 ;", "tracestate": "ttrace=traceparent:00-106 ; pinv_sales_network_id: 203 ;" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "id": "106-203-DynamicDefense", "status": "active", "name": "AT&T Dynamic Defense", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "Requires", "id": "106-203" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "29999999", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.651639..ATI", "externalIdentifierType": "CircuitID", "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." } } ], "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" } } ], "realizingService": [ { "@type": "ServiceRef", "id": ".BMEC.123456..ATI.", "name": "CircuitID" } ], "realizingResource": [ { "@type": "ResourceRef", "id": "29999999", "name": "PortID" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-DYNAMIC-DEFENSE-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 1.0" }, "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Tier", "value": "1" } ] } } ] } } } } }, "responses": { "201": { "description": "Merger of corresponding TMF637 data from various sources.\n\n\n\nThe response contains either:\n\n1. an array of single TMF637 document representing provided package part if no other related package parts were updated,\n1. an array of multiple TMF637 documents containing provided updated package part and:\n - updated related package parts in case the product relationship id had to be updated in other package parts,\n - or other package parts if the query parameter `as-adi-package` was set to `true`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "responseData": { "type": "array", "items": { "type": "object", "properties": { "headers": { "type": "object" }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } } } } }, "example": { "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" } } } } } }, "206": { "description": "When not all TMF637 that were sent were accepted and some ended with error." }, "400": { "description": "Error when processing the TMF637.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "array", "items": { "type": "object" } }, "error": { "type": "string" } } } } }, "example": { "status": 400, "timestamp": "2024-11-18T15:25:57.137Z", "errorDetail": { "message": [ { "instancePath": "", "schemaPath": "#/oneOf/0/minItems", "keyword": "minItems", "params": { "limit": 3 }, "message": "must NOT have fewer than 3 items" } ], "error": "Bad Request" } } } } }, "403": { "description": "Error when you try to submit document using a different source than yours.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" } } } } }, "example": { "status": 403, "timestamp": "2025-01-28T22:11:05.739Z", "errorDetail": { "message": "You are not allowed to create this document. Make sure you are trying to create new product of the same source you are currently logged in with.", "error": "Forbidden" } } } } }, "404": { "description": "Error when communicating with 3rd parties (i.e. resolving the geographic address, COID, GeoSiteId or GLID).", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" } } } } }, "example": { "status": 404, "timestamp": "2025-01-28T22:11:05.739Z", "errorDetail": { "message": "Could not find CoID.", "error": "Not Found" } } } } }, "405": { "description": "Error when trying to create document with an ID of already existing output document.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "array", "items": { "type": "object" } }, "error": { "type": "string" } } } } }, "example": { "status": 405, "timestamp": "2025-01-28T22:07:40.729Z", "errorDetail": { "message": [ { "error": { "message": "This ID is reserved for an exposed document. Use PATCH instead of POST" } } ], "error": "Bad Request" } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "TMF637 Products" ] }, "patch": { "operationId": "ProductController_update", "summary": "Patches a document or multiple documents", "description": "This endpoint allows you to patch a specific TMF637 product/s based on the given input.\n\n### What is `eTag`?\n`eTag` is a unique identifier for the entire document. It is used to ensure that the document being updated has not been modified by another process since it was last retrieved. If the provided `eTag` does not match the current `eTag` of the document, the update will fail with a `412 Precondition Failed` error.\n\n### What is `partialEtags`?\n`partialEtags` is a set of unique identifiers for specific parts of the document. It allows you to validate and update only certain sections of the document without requiring the entire document to match. Each key in `partialEtags` corresponds to a specific part of the document (e.g., `relatedParty`, `place`, etc.).\n\n### Important Note:\n- You can provide either `eTag` or `partialEtags`, but **not both** in the same request.\n- If neither is provided, the patch operation will proceed without validation.\n\nReturns the patched document afterwards. See examples for usage.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "eTag": { "type": "string" }, "partialEtags": { "type": "object", "properties": { "relatedParty": { "type": "string" }, "place": { "type": "string" }, "productSpecification_productCharacteristics": { "type": "string" }, "productRelationship": { "type": "string" }, "realizingService_realizingResource": { "type": "string" }, "agreementItem_billingAccount": { "type": "string" }, "externalReference_externalBillingAccountReference": { "type": "string" } }, "additionalProperties": false }, "patches": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "replace", "add", "remove" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } }, "required": [ "id", "patches" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "eTag": { "type": "string" }, "partialEtags": { "type": "object", "properties": { "relatedParty": { "type": "string" }, "place": { "type": "string" }, "productSpecification_productCharacteristics": { "type": "string" }, "productRelationship": { "type": "string" }, "realizingService_realizingResource": { "type": "string" }, "agreementItem_billingAccount": { "type": "string" }, "externalReference_externalBillingAccountReference": { "type": "string" } }, "additionalProperties": false }, "patches": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "replace", "add", "remove" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } }, "required": [ "id", "patches" ], "additionalProperties": false } } ] }, "examples": { "replace": { "summary": "Replace", "description": "This request body will replace productCharacteristics element, which name is 'IP Version' with value 'v6'", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" } ] } }, "addElement": { "summary": "Add element to an array", "description": "This request body will add productCharacteristics element to the first position in an array. The number behind last slash sign determines array position, where to insert the new element.", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "patches": [ { "op": "add", "path": "/productCharacteristic/0", "value": { "@type": "StringCharacteristic", "name": "Billing Option", "value": "Fixed Billing" } } ] } }, "addProperty": { "summary": "Add property to the tmf637", "description": "This request body will add 'newProperty' property to the root of the tmf637 document containing value 'New Value'", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "patches": [ { "op": "add", "path": "/newProperty", "value": "New Value" } ] } }, "remove": { "summary": "Remove", "description": "This request body will remove 'relatedParty.partyOrPartyRole.status' property, where given conditions are true. The 'value' property in 'patches' object is not used in remove operation.", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "patches": [ { "op": "remove", "path": "/relatedParty/partyOrPartyRole/status?relatedParty.partyOrPartyRole.status=inactive&relatedParty.partyOrPartyRole.contactMedium.country=US" } ] } }, "withEtag": { "summary": "With eTag", "description": "This request body will replace productCharacteristics element, which name is 'IP Version' with value 'v6', but only if provided eTag value matches the current eTag of the document. The 'eTag' property is not required", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "eTag": "2cfb0a9a2ab377120cd9c664821d13a0", "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" } ] } }, "withPartialEtags": { "summary": "With partial eTags", "description": "This request body will replace productCharacteristics element, which name is 'IP Version' with value 'v6', but only if provided partial eTags values matches the current eTags of corresponding parts of the document. The 'partialEtags' property is not required", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "partialEtags": { "relatedParty": "2cfb0a9a2ab377120cd9c664821d13a0", "place": "2cfb0a9a2ab377120cd9c664821d13a0", "productSpecification_productCharacteristics": "2cfb0a9a2ab377120cd9c664821d13a0", "productRelationship": "2cfb0a9a2ab377120cd9c664821d13a0", "realizingService_realizingResource": "2cfb0a9a2ab377120cd9c664821d13a0", "agreementItem_billingAccount": "2cfb0a9a2ab377120cd9c664821d13a0", "externalReference_externalBillingAccountReference": "2cfb0a9a2ab377120cd9c664821d13a0" }, "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" } ] } }, "multipleOfOneDoc": { "summary": "Multiple operations within one document", "description": "This request body will perform 3 operations within one document (one by one)", "value": { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" }, { "op": "add", "path": "/productCharacteristic/0", "value": { "@type": "StringCharacteristic", "name": "Billing Option", "value": "Fixed Billing" } }, { "op": "remove", "path": "/relatedParty/partyOrPartyRole/status?relatedParty.partyOrPartyRole.status=inactive&relatedParty.partyOrPartyRole.contactMedium.country=US" } ] } }, "multipleOfMultiplseDocs": { "summary": "Multiple operations within multiple documents", "description": "This request body will perform all the given operations within every document in the array. E-tag is not required for every document, so it doesn't need to be there at all, but can be provided if eTag check is required", "value": [ { "id": "c31f5942-e198-4272-9811-ce4677d97b77", "eTag": "2cfb0a9a2ab377120cd9c664821d13a0", "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" }, { "op": "add", "path": "/productCharacteristic/0", "value": { "@type": "StringCharacteristic", "name": "Billing Option", "value": "Fixed Billing" } }, { "op": "remove", "path": "/relatedParty/partyOrPartyRole/status?relatedParty.partyOrPartyRole.status=inactive&relatedParty.partyOrPartyRole.contactMedium.country=US" } ] }, { "id": "01f02671-0ca3-4ec0-95de-01d010f20480", "patches": [ { "op": "replace", "path": "/productCharacteristic/value?productCharacteristic.name=IP Version", "value": "v6" }, { "op": "add", "path": "/productCharacteristic/0", "value": { "@type": "StringCharacteristic", "name": "Billing Option", "value": "Fixed Billing" } }, { "op": "remove", "path": "/relatedParty/partyOrPartyRole/status?relatedParty.partyOrPartyRole.status=inactive&relatedParty.partyOrPartyRole.contactMedium.country=US" } ] } ] } } } } }, "responses": { "200": { "description": "Success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "responseData": { "type": "array", "items": { "type": "object", "properties": { "headers": { "type": "object" }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } } } } }, "example": { "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" } } ] } } } }, "400": { "description": "400 error is thrown when given conditions were not met in any part of the document", "content": { "application/json": { "example": "Conditions from path \"${patch.path}\" were not fulfilled. No part of the document to update was found." } } }, "403": { "description": "403 error is thrown when you don't have access to this document", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" } } } } }, "example": { "status": 403, "timestamp": "2025-01-28T22:11:05.739Z", "errorDetail": { "message": "You are not allowed to update this document. Make sure you are trying to update a product of the same source you are currently logged in with.", "error": "Forbidden" } } } } }, "404": { "description": "404 error is thrown when given id of the document is not found in either input or output document", "content": { "application/json": { "example": "Id not found in either input or output documents. Id: ${id}" } } }, "412": { "description": "412 error is thrown when given e-tag is not equal to current hashed document", "content": { "application/json": { "example": "Outdated document version. Id: ${id}" } } } }, "security": [ { "bearer": [] } ], "tags": [ "TMF637 Products" ] }, "delete": { "operationId": "ProductController_remove", "summary": "Delete a document or multiple documents", "description": "This endpoint allows you to delete a single or multiple TMF637 products by their ID.\n\n\nThis endpoint is subject to authorization with the corresponding source.\n\n\n> Note: `product-specification-id` parameter representing a value of TMF637 `productSpecification.id` will soon be mandatory. As long as a product other than ADI is not onboarded to PINV, this parameter can be omitted.", "parameters": [ { "name": "id", "required": true, "in": "query", "description": "A product ID to be removed", "schema": { "example": "c31f5942-e198-4272-9811-ce4677d97b77" } }, { "name": "id[]", "required": false, "in": "query", "description": "Subsequent product ID/s to be removed aswell, any number of query params can be added to the request, both \"id=\" and \"id[]=\" will work.", "schema": { "example": "c31f5942-e198-4272-9811-ce4677d97b78" } }, { "name": "product-specification-id", "required": false, "in": "query", "description": "A value of `productSpecification.id`.", "schema": { "enum": [ "PR-ADI-EMBEDDED-BASE", "PR-ADI-PORT-EMBEDDED-BASE", "PR-ADI-ACCESS-EMBEDDED-BASE", "PR-DYNAMIC-DEFENSE-EMBEDDED-BASE" ], "type": "string" } } ], "responses": { "200": { "description": "Document(s) successfully deleted", "content": { "application/json": { "schema": { "example": { "status": 200, "timestamp": "2025-01-15T13:41:44.183Z", "responseData": { "removedId": "c31f5942-e198-4272-9811-ce4677d97b77" } } } } } }, "206": { "description": "When not all TMF637 that were sent were deleted and some ended with an error." }, "404": { "description": "Document(s) not found", "content": { "application/json": { "schema": { "example": { "status": 404, "timestamp": "2025-01-15T13:42:52.247Z", "errorDetail": { "message": "Id not found in either input or output documents. Id: c31f5942-e198-4272-9811-ce4677d97b77" } } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "TMF637 Products" ] } }, "/products/find-all": { "post": { "operationId": "ProductController_findAll", "summary": "Retrieve multiple products based on a MongoDB query", "description": "This endpoint allows you to retrieve a list of TMF637 products from the database by providing a MongoDB-like query in the request body. \n### Features:\n- Supports advanced filtering using MongoDB operators such as `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`, `$regex`, and `$elemMatch`.\n- Allows pagination using the `limit` and `offset` query parameters.\n- Optional functionality to dereference related data using the `should-dereference` query parameter.\n- Optionally retrieves the entire ADI package using the `as-adi-package` query parameter.\n\n> **Note**: For more information about MongoDB queries, refer to the [MongoDB Query Documentation](https://www.mongodb.com/docs/manual/tutorial/query-documents/).", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Number of products in one page (Default: 1000)", "schema": { "example": 1000 } }, { "name": "offset", "required": false, "in": "query", "description": "Offset position (Default: 0)", "schema": { "example": 0 } }, { "name": "should-dereference", "required": false, "in": "query", "description": "Should dereference the 1st level of references (Default: false). Note: setting this parameter to \"true\" will cause the API performance to be slower than using references only.", "schema": { "example": false } }, { "name": "as-adi-package", "required": false, "in": "query", "description": "Include the entire ADI, access, port and dynamic defense product package as an array. (Default: false)", "schema": { "example": false } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tmf637FindAllBodySchema" }, "examples": { "simpleQuery": { "summary": "Simple query", "value": { "value.id": "123-4567" } }, "findAllByCircuitId": { "summary": "By Circuit id", "value": { "value.realizingService": { "$elemMatch": { "id": "IUEC.972722..ATI", "name": "CircuitID" } } } } } } } }, "responses": { "200": { "description": "Success response", "headers": { "X-Total-Count": { "description": "Total number of products", "schema": { "type": "integer", "example": 100 } }, "X-Result-Count": { "description": "Number of products in the current response", "schema": { "type": "integer", "example": 10 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "responseData": { "type": "array", "items": { "type": "object", "properties": { "headers": { "type": "object" }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } } } } }, "example": { "status": 200, "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" } } ] } } } } }, "security": [ { "bearer": [] } ], "tags": [ "TMF637 Products" ] } }, "/products/{id}": { "get": { "operationId": "ProductController_findOne", "summary": "Retrieve one product by id", "description": "This endpoint allows you to retrieve a single TMF637 product based on the given id.\n\n\n> Note: `product-specification-id` parameter representing a value of TMF637 `productSpecification.id` will soon be mandatory. As long as a product other than ADI is not onboarded to PINV, this parameter can be omitted.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "TMF637 product id", "schema": { "example": "b7f622a3-f2bd-49db-9247-2165be501e42" } }, { "name": "product-specification-id", "required": false, "in": "query", "description": "A value of `productSpecification.id`.", "schema": { "enum": [ "PR-ADI-EMBEDDED-BASE", "PR-ADI-PORT-EMBEDDED-BASE", "PR-ADI-ACCESS-EMBEDDED-BASE", "PR-DYNAMIC-DEFENSE-EMBEDDED-BASE" ], "type": "string" } }, { "name": "should-dereference", "required": false, "in": "query", "description": "Should dereference the 1st level of references (Default: false). Note: setting this parameter to \"true\" will cause the API performance to be slower than using references only.", "schema": { "example": false } }, { "name": "as-adi-package", "required": false, "in": "query", "description": "Include the entire ADI, access, port and dynamic defense product package as an array. (Default: false)", "schema": { "example": false } } ], "responses": { "200": { "description": "Success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "responseData": { "oneOf": [ { "type": "object", "properties": { "headers": { "type": "object" }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } }, { "type": "array", "items": { "type": "object", "properties": { "headers": { "type": "object" }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } } } ] } } }, "example": { "status": 200, "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" } } } } } }, "404": { "description": "Error when TMF637 wasn't found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "example": { "status": 404, "timestamp": "2025-01-28T22:11:05.739Z", "errorDetail": { "message": "productNotFoundError" } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "TMF637 Products" ] } }, "/ping": { "get": { "operationId": "PingController_ping", "summary": "Ping the service to check if it is online.", "description": "This endpoint checks the connectivity status of the service.", "parameters": [], "responses": { "200": { "description": "Service is online.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "example": 200 }, "timestamp": { "type": "string", "example": "2024-11-18T21:36:11.258Z" } } } } } }, "503": { "description": "Service Unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "example": 503 }, "timestamp": { "type": "string", "example": "2024-11-18T21:37:27.573Z" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string", "example": "Internal Server Error" } } } } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "Ping" ] } }, "/traces": { "get": { "operationId": "TracesController_findByQuery", "summary": "Get trace by filters.", "description": "Traceability API allows users to gain insights to processing of the product inventory data.\n\nOutput consists of 4 buckets:\n- Source Data Records\n - contain the inbound data records from the source systems,\n- Resolved Context\n - contains details about 3rd party systems (integrations) such as processing latency, request and response details,\n- Merge Rules\n - contain the rules valid for the time of document processing used to merge the inbound data records,\n- Exposed Product Inventory\n - summarize details about all requests which upserted the outbound product such as timestamp, processing time and type of request (POST/PATCH)\n - contains the outbound product itself.", "parameters": [ { "name": "inbound-id", "required": false, "in": "query", "description": "An ID of inbound product", "schema": { "example": "BBEC.687937..ATI-3230B8/12/MAA" } }, { "name": "outbound-id", "required": false, "in": "query", "description": "An ID of outbound product", "schema": { "example": "e38d0a07-73f0-465f-89e6-80b816a8b6b5" } }, { "name": "circuit-id", "required": false, "in": "query", "description": "An circuit ID of product", "schema": { "example": "BBEC.687937..ATI" } } ], "responses": { "200": { "description": "Success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "timestamp": { "type": "string" }, "responseData": { "type": "object", "properties": { "sourceDataRecords": { "type": "array", "items": { "type": "object" } }, "resolvedContext": { "type": "object" }, "mergeRules": { "type": "object" }, "exposedProductInventory": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "timestamp": "2025-03-28T15:35:57.736Z", "responseData": { "sourceDataRecords": [ { "timestamp": "2025-03-28T15:18:38.000Z", "_id": "67e6bdce46c3a21be325736d", "headers": { "source": "provisioning", "version": "5", "coId": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "geoSiteId": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "timeStamp": "2025-03-28T15:18:38.369Z" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "https://raw.githubusercontent.com/ATT_org/TMF-extensions/commitHash/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "BBEC.687937..ATI-3230B8/12/MAA-ACCESS" }, { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "BBEC.687937..ATI-3230B8/12/MAA-NETWORK" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "3230B8/12/MAA", "externalIdentifierType": "Service MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "3230B8/12/001", "externalIdentifierType": "Access MCN Triplet", "owner": "INSTAR" } ], "realizingResource": [ { "@type": "ResourceRef", "id": "", "name": "IPv4" }, { "@type": "ResourceRef", "id": "", "name": "IPv6" }, { "@type": "ResourceRef", "id": "NA", "name": "CPE-SerialNumber" } ], "realizingService": [], "id": "BBEC.687937..ATI-3230B8/12/MAA", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } } ], "place": [ { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "Plus" }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "BURSTABLE BILLING" }, { "@type": "StringCharacteristic", "name": "IP Version", "value": "ipv4" }, { "@type": "StringCharacteristic", "name": "WAN IPv4 Block Size", "value": "" }, { "@type": "StringCharacteristic", "name": "Additional WAN IPv4 Addresses Needed", "value": "No" }, { "@type": "StringCharacteristic", "name": "LanIPv4 Address Block Size", "value": "" }, { "@type": "StringCharacteristic", "name": "Additional LAN IP Addresses", "value": "No" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "125" }, { "@type": "StringCharacteristic", "name": "Router Model", "value": "CISCO 9010 AR" }, { "@type": "StringCharacteristic", "name": "Router Manufacturer", "value": "CISCO" }, { "@type": "StringCharacteristic", "name": "Customer Prem Router Model", "value": "ASR1002X" }, { "@type": "StringCharacteristic", "name": "Customer Prem Router Manufacturer", "value": "Cisco" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" }, "productPrice": [ { "priceType": "Access-Price", "price": { "taxIncludedAmount": { "value": 1430 }, "@type": "Price" }, "@type": "ProductPrice" } ] } }, { "timestamp": "2025-03-28T15:18:38.000Z", "_id": "67e6bdce46c3a21be3257371", "headers": { "source": "provisioning", "version": "5", "coId": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "geoSiteId": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "timeStamp": "2025-03-28T15:18:38.496Z" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "https://raw.githubusercontent.com/ATT_org/TMF-extensions/commitHash/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "BBEC.687937..ATI-3230B8/12/MAA" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" } ], "realizingResource": [], "realizingService": [ { "@type": "ServiceRef", "id": "BBEC.687937..ATI", "name": "CircuitID" } ], "id": "BBEC.687937..ATI-3230B8/12/MAA-ACCESS", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } } ], "place": [ { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "50000" }, { "@type": "StringCharacteristic", "name": "Vendor", "value": "CISCO" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-ACCESS-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" } } }, { "timestamp": "2025-03-28T15:18:38.000Z", "_id": "67e6bdce46c3a21be3257375", "headers": { "source": "provisioning", "version": "5", "coId": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "geoSiteId": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "timeStamp": "2025-03-28T15:18:38.602Z" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "https://raw.githubusercontent.com/ATT_org/TMF-extensions/commitHash/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "BBEC.687937..ATI-3230B8/12/MAA" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" } ], "realizingResource": [ { "@type": "ResourceRef", "id": "", "name": "PortID" } ], "realizingService": [], "id": "BBEC.687937..ATI-3230B8/12/MAA-NETWORK", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } } ], "place": [ { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Minimum Bandwidth Commitment", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Port Speed", "value": "30000" }, { "@type": "StringCharacteristic", "name": "Interface", "value": "1000 Base-LX" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-PORT-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" } } }, { "timestamp": "2025-03-28T15:32:28.000Z", "_id": "67e6c10c83506a1cd33530d3", "headers": { "source": "billing", "version": "5", "coId": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "geoSiteId": "4dd2e20d-3830-411a-a77f-3dec3a30dd33", "timeStamp": "2025-03-28T15:32:28.497Z" }, "value": { "@type": "AttProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "productRelationship": [], "externalReference": [ { "@type": "ExternalIdentifier", "id": ".BMEC.123456..ATI.", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "192837465", "externalIdentifierType": "SiteID", "owner": "INSTAR" } ], "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" } ], "realizingService": [ { "@type": "ServiceRef", "id": ".CMEC.123456..ATI.", "name": "SomeOtherId" }, { "@type": "ServiceRef", "id": "BBEC.687937..ATI", "name": "CircuitID" } ], "id": "41-1234567", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "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": "PlaceRef", "@referredType": "GeographicAddress", "id": "0000ZKSZJ3", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3" } }, { "@type": "RelatedPlaceRefOrValue", "role": "BillingAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "00010CMZGP", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "4dd2e20d-3830-411a-a77f-3dec3a30dd33", "href": "/geosites/4dd2e20d-3830-411a-a77f-3dec3a30dd33" } } ], "productCharacteristic": [], "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, "unit": "USD" }, "taxIncludedAmount": { "value": 135.3 }, "taxRate": 10 } } ] } } ], "resolvedContext": { "INLAP 000020YMVY": { "processingLatency": "804 ms", "request": { "url": "https://inlap-ms.test.att.com/alav/service/v2/geographicAddressValidation", "query": { "type": "gis", "glid": "000020YMVY" } }, "response": { "0": { "id": "GISAddress", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY", "provideAlternative": false, "validationDate": "2025-03-28T15:18:37.484Z", "validationResult": "success", "validatonResultDetails": { "additionalInformation": "Single Match. AutoBuild Status: Input CLLI not found/not eligible for Auto Build", "responseCode": "G0000" }, "@type": "GeographicAddressValidationExtended", "validGeographicAddress": { "id": "000020YMVY", "streetNr": "1122", "streetName": "3RD", "streetType": "AVE", "postcode": "98101-2904", "city": "SEATTLE", "stateOrProvince": "WA", "country": "USA", "@type": "GeographicAddress", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY", "subUnitNumber": " ", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" }, "submittedGeographicAddress": { "id": "000020YMVY", "@type": "GeographicAddressExtended", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "000020YMVY", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } } } }, "CIMS 6a2d2a28-95f9-428a-b211-58a0a50cc2af": { "processingLatency": "1499 ms", "request": { "url": "https://capabilities.test.att.com/cims/organization", "query": { "country": "USA", "name": "323040A_UAT_AVPN017", "street1": "1122 3RD AVE", "city": "SEATTLE", "state": "WA", "postCode": "98101" } }, "response": { "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "isHeadOffice": false, "name": "ATT VIRTUAL OFFICE", "contactMedium": [ { "characteristic": { "city": "SEATTLE", "contactType": "Physical Address", "postCode": "98101", "stateOrProvince": "WA", "street1": "1122 3RD AVE", "@type": "MediumCharacteristic" }, "@type": "ContactMedium" } ], "organizationIdentification": [ { "identificationId": "94914651503_8310007189233_384048226", "identificationType": "SAART_LIVE", "@type": "OrganizationIdentification" }, { "identificationId": "94914651503_8310007189257_384048226", "identificationType": "SAART_LIVE", "@type": "OrganizationIdentification" }, { "identificationId": "94914651503_8310007189269_384048226", "identificationType": "SAART_LIVE", "@type": "OrganizationIdentification" }, { "identificationId": "94914651503_8310007189254_384048226", "identificationType": "SAART_LIVE", "@type": "OrganizationIdentification" }, { "identificationId": "efdf3350-875f-4b62-b2ac-d6a740cc7d10", "identificationType": "ABS_MARS_ID", "@type": "OrganizationIdentification" } ], "status": "validated", "@type": "Organization" } }, "GeoSite a9cc3f8f-5fe4-4dff-a30a-8dac7465122f": { "processingLatency": "801 ms", "request": { "url": "https://geosite.dev.att.com/geosites", "query": { "coid": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "glid": "000020YMVY" } }, "response": { "@type": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "creationDate": "2025-02-18T15:25:39.234000", "description": "1122 3RD AVE, SEATTLE WA 98101-2904", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "code": "STTLWA06", "relatedParty": [ { "@type": "RelatedPartyRefOrPartyRoleRef", "@baseType": "Party", "role": "Owner", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "name": "ATT VIRTUAL OFFICE", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af" } } ], "place": [ { "streetNr": "1122", "streetName": "3RD", "streetType": "AVE", "postcode": "98101-2904", "city": "SEATTLE", "stateOrProvince": "WA", "country": "USA", "id": "000020YMVY", "geographicLocation": { "bbox": [ -122.334809, 47.606994 ], "@type": "GeoJsonPoint" }, "@type": "GeographicAddress" } ] } }, "INLAP 00010CMZGP": { "processingLatency": "632 ms", "request": { "url": "https://inlap-ms.test.att.com/alav/service/v2/geographicAddressValidation", "query": { "type": "gis", "glid": "00010CMZGP" } }, "response": { "0": { "id": "GISAddress", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP", "provideAlternative": false, "validationDate": "2025-03-28T15:32:26.744Z", "validationResult": "success", "validatonResultDetails": { "additionalInformation": "Single Match. AutoBuild Status: CLLI, PSA combination not enabled for ALUB", "responseCode": "G0000" }, "@type": "GeographicAddressValidationExtended", "validGeographicAddress": { "id": "00010CMZGP", "streetNr": "5612", "streetName": "OXFORD", "streetType": "PL", "postcode": "40291", "city": "LOUISVILLE", "stateOrProvince": "KY", "country": "USA", "@type": "GeographicAddress", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "00010CMZGP", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP", "subUnitType": "APT", "subUnitNumber": "APT", "buildingName": "APT APT", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP" }, "submittedGeographicAddress": { "id": "00010CMZGP", "@type": "GeographicAddressExtended", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "00010CMZGP", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP" } } } }, "INLAP 00010FPFUU": { "processingLatency": "699 ms", "request": { "url": "https://inlap-ms.test.att.com/service/autocomplete/v3/elasticsearch", "body": { "params": { "address_type": "SERVICE_ADDRESS", "address_or_glid": "TIFTON 31793 GA RAINWATER RD BLDG FMO 2360", "size": 10 } } }, "response": { "code": "200", "message": "MULTIPLE LOCATION MATCH", "status": "SUCCESS", "hits": [ { "structureValue": "FMO", "matchCode": "S80", "city": "TIFTON", "bashKey": "DDE91B2442CC2B5BEFEF9B163C829BF0", "houseNumber": "2360", "county": "TIFT", "zip4": "5766", "zip5": "31793", "unitType": "BLDG", "streetName": "RAINWATER", "subAddress": "BLDG FMO, BLDG FMO", "state": "GA", "streetThoroughfare": "RD", "unitValue": "FMO", "address": "2360 RAINWATER RD, BLDG FMO, BLDG FMO, TIFTON, GA, 31793-5766", "baseAddress": "2360 RAINWATER RD", "glid": "00010FPFUU", "structureType": "BLDG", "retiredGlid": "NA", "postCode": "31793-5766", "locationCode": "AP05" }, { "structureValue": "FMO", "matchCode": "S80", "city": "TIFTON", "bashKey": "DDE91B2442CC2B5BEFEF9B163C829BF0", "houseNumber": "2360", "county": "TIFT", "zip4": "5766", "zip5": "31793", "streetName": "RAINWATER", "subAddress": "BLDG FMO", "lecAddr": "Y", "state": "GA", "streetThoroughfare": "RD", "address": "2360 RAINWATER RD, BLDG FMO, TIFTON, GA, 31793-5766", "baseAddress": "2360 RAINWATER RD", "glid": "00001367LM", "structureType": "BLDG", "retiredGlid": "NA", "postCode": "31793-5766", "locationCode": "AP05" } ] } }, "INLAP 0000ZKSZJ3": { "processingLatency": "638 ms", "request": { "url": "https://inlap-ms.test.att.com/alav/service/v2/geographicAddressValidation", "query": { "type": "gis", "glid": "0000ZKSZJ3" } }, "response": { "0": { "id": "GISAddress", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3", "provideAlternative": false, "validationDate": "2025-03-28T15:32:26.918Z", "validationResult": "success", "validatonResultDetails": { "additionalInformation": "Single Match. AutoBuild Status: Supplemental exist for input base address", "responseCode": "G0000" }, "@type": "GeographicAddressValidationExtended", "validGeographicAddress": { "id": "0000ZKSZJ3", "streetNr": "156", "streetName": "GENEVA", "streetType": "DR", "postcode": "32765-7203", "city": "OVIEDO", "stateOrProvince": "FL", "country": "USA", "@type": "GeographicAddress", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "0000ZKSZJ3", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3", "subUnitType": "UNIT", "subUnitNumber": "200", "levelNumber": "2", "levelType": "FL", "buildingName": "BLDG MAIN", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3" }, "submittedGeographicAddress": { "id": "0000ZKSZJ3", "@type": "GeographicAddressExtended", "@baseType": "geographicAddress", "@schemaLocation": "/location/schema/geographicAddressExtended.json", "geographicSubAddress": [ { "id": "0000ZKSZJ3", "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3", "@type": "geographicSubAddressAdditionalDetails", "@schemaLocation": "/location/schema/geographicSubAddressAdditionalDetails.json" } ], "href": "httpss://attlocaddrval-test-eastus2.az.3pc.att.com/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3" } } } }, "CIMS 4680bedd-bc70-4d98-82e8-f6d3fa8c39a6": { "processingLatency": "2020 ms", "request": { "url": "https://capabilities.test.att.com/cims/organization", "query": { "country": "US", "name": "PINV Ltd.", "street1": "2360 RAINWATER RD BLDG FMO", "city": "TIFTON", "state": "GA", "postCode": "31793" } }, "response": { "id": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "isHeadOffice": false, "name": "PINV Ltd.", "contactMedium": [ { "characteristic": { "city": "TIFTON", "contactType": "Physical Address", "postCode": "31793", "street1": "2360 RAINWATER RD BLDG FMO", "@type": "MediumCharacteristic" }, "@type": "ContactMedium" } ], "organizationIdentification": [ { "identificationId": "f371ef87-e967-4643-9d62-4c86e622a47b", "identificationType": "C-NODE", "@type": "OrganizationIdentification" } ], "status": "not validated", "@type": "Organization" } }, "GeoSite 4dd2e20d-3830-411a-a77f-3dec3a30dd33": { "processingLatency": "775 ms", "request": { "url": "https://geosite.dev.att.com/geosites", "query": { "coid": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "glid": "00010FPFUU" } }, "response": { "@type": "GeographicSite", "id": "4dd2e20d-3830-411a-a77f-3dec3a30dd33", "creationDate": "2025-01-24T10:43:24.332000", "description": "2360 RAINWATER RD, TIFTON GA 31793-5766", "href": "/geosites/4dd2e20d-3830-411a-a77f-3dec3a30dd33", "code": "TFTNGAMA", "relatedParty": [ { "@type": "RelatedPartyRefOrPartyRoleRef", "@baseType": "Party", "role": "Owner", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "name": "PINV Ltd.", "id": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/4680bedd-bc70-4d98-82e8-f6d3fa8c39a6" } } ], "place": [ { "streetNr": "2360", "streetName": "RAINWATER", "streetType": "RD", "postcode": "31793-5766", "city": "TIFTON", "stateOrProvince": "GA", "country": "USA", "id": "00001360LT", "geographicLocation": { "bbox": [ -83.530672, 31.474726 ], "@type": "GeoJsonPoint" }, "@type": "GeographicAddress" } ] } } }, "mergeRules": { "2025-01-01.4000-01-01.adi.rule-engine.config": [ { "id": 2, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "@type", "mergeRule": "Controlled by Product Inventory Capability", "mergeCandidatesAndMergePriority": "ATTProduct" }, "method": "set", "params": [ { "@type": "ATTProduct" } ] }, { "id": 3, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "@baseType", "mergeRule": "Controlled by Product Inventory Capability", "mergeCandidatesAndMergePriority": "Product" }, "method": "set", "params": [ { "@baseType": "Product" } ] }, { "id": 4, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "@schemaLocation", "mergeRule": "Controlled by Product Inventory Capability", "mergeCandidatesAndMergePriority": "/schema/AttProduct_tmf637.schema.json" }, "method": "set", "params": [ { "@schemaLocation": "/schema/AttProduct_tmf637.schema.json" } ] }, { "id": 5, "description": { "productOrAttProduct": "ATTProduct", "componentSubTypeSubClass": "externalReference (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - id, externalIdentifierType, owner", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "externalReference", [ "id", "externalIdentifierType", "owner" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 6, "description": { "productOrAttProduct": "ATTProduct", "componentSubTypeSubClass": "externalBillingAccountReference (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - id, externalIdentifierType, owner", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "externalBillingAccountReference", [ "id", "externalIdentifierType", "owner" ], [ "FMO", "billing" ] ] }, { "id": 7, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "relatedParty (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - role, partyOrPartyRole.id", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "relatedParty", [ "partyOrPartyRole.id", "role" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 8, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "place (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - role, place.id, place.@type", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "place", [ "role", "place.id", "place.@type" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 10, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productSpecification (Object)", "mergeRule": "Choose One", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document", "condition": "Must be from the same Document: productCharacteristic, productSpecification. Expectation is that productCharacteristic and productSpecification are consistent" }, "method": "getItemsFrom", "params": [ [ "productSpecification" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 9, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productCharacteristic (List)", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document", "condition": "Must be from the same Document: productCharacteristic, productSpecification. Expectation is that productCharacteristic and productSpecification are consistent" }, "method": "getItemsFrom", "params": [ [ "productCharacteristic", "productSpecification" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 11, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productOffering (Object)", "mergeRule": "Choose One", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "productOffering", [ "FMO" ] ] }, { "id": 12, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productRelationship (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - productRelationship.relationshipType, productRelationship.relationshipType.id", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "productRelationship", [ "relationshipType", "id" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 13, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "product (List)", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "product", [ "FMO" ] ] }, { "id": 14, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "agreementItem (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per combination of - agreementId, agreementItemId", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Billing Extracted Document, 3. Provisioning Extracted Document" }, "method": "createUniqueArray", "params": [ "agreementItem", [ "agreementId", "agreementItemId" ], [ "FMO", "billing", "provisioning" ] ] }, { "id": 15, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productTerm (List)", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "productTerm", [ "FMO" ] ] }, { "id": 16, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productOrderItem (List)", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "productOrderItem", [ "FMO" ] ] }, { "id": 17, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "productPrice (List)", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "productPrice", [ "FMO" ] ] }, { "id": 18, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "billingAccount (Object)", "mergeRule": "Choose One", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Billing Extracted Document" }, "method": "getItemFrom", "params": [ "billingAccount", [ "FMO", "billing" ] ] }, { "id": 19, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "intent (Object)", "mergeRule": "Choose One", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getItemFrom", "params": [ "intent", [ "FMO" ] ] }, { "id": 20, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "realizingService (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per - id", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "realizingService", [ "id" ], [ "FMO", "provisioning", "billing" ] ] }, { "id": 21, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "realizingResource (List)", "mergeRule": "Build Array of Unique Elements. Uniqueness per - id", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Provisioning Extracted Document, 3. Billing Extracted Document" }, "method": "createUniqueArray", "params": [ "realizingResource", [ "id" ], [ "FMO", "billing", "provisioning" ] ] }, { "id": 22, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "Immediate Product Attributes, other than those explicitly listed in this table, i.e., all Product Attributes that are not Sub-Objects, List or have a dedicated rule in this table.", "mergeRule": "Choose One Set For All", "mergeCandidatesAndMergePriority": "1. FMO Document, 2. Billing Extracted Document, 3. Provisioning Extracted Document", "condition": "Must be from the same document: Set of Immediate Product Attributes" }, "method": "getUnsetItemsFrom", "params": [ "properties", [ "FMO", "provisioning", "billing" ] ] }, { "id": 23, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "All Other Product Lists", "mergeRule": "Choose One Array", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getUnsetItemsFrom", "params": [ "arrays", [ "FMO" ] ] }, { "id": 24, "description": { "productOrAttProduct": "Product", "componentSubTypeSubClass": "All Other Product Sub-Objects", "mergeRule": "Choose One", "mergeCandidatesAndMergePriority": "1. FMO Document" }, "method": "getUnsetItemsFrom", "params": [ "objects", [ "FMO" ] ] } ] }, "exposedProductInventory": [ { "processingDetails": [ { "timestamp": "2025-03-28T15:25:42.000Z", "_id": "67e6bf764eca25c8b9a82b52", "pinvRequestId": "65254c11-0544-450b-a223-1e174c342de5", "durationMs": 22901, "method": "POST", "requestType": "http" }, { "timestamp": "2025-03-28T15:32:30.000Z", "_id": "67e6c10e83506a1cd33530d4", "pinvRequestId": "991b1be6-9918-48c4-bc34-c3eb2646a698", "durationMs": 18699, "method": "POST", "requestType": "http" } ], "exposedTmf637": { "@type": "ATTProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "606f3aca-3f2f-414d-b8ab-bd004191577c" }, { "@type": "ProductRelationship", "relationshipType": "HasChild", "id": "664b4807-3a8a-4336-ad1f-d67fec9a05b2" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "3230B8/12/MAA", "externalIdentifierType": "Service MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "3230B8/12/001", "externalIdentifierType": "Access MCN Triplet", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": ".BMEC.123456..ATI.", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "192837465", "externalIdentifierType": "SiteID", "owner": "INSTAR" } ], "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" }, { "@type": "ResourceRef", "id": "", "name": "IPv4" }, { "@type": "ResourceRef", "id": "NA", "name": "CPE-SerialNumber" } ], "realizingService": [ { "@type": "ServiceRef", "id": ".CMEC.123456..ATI.", "name": "SomeOtherId" }, { "@type": "ServiceRef", "id": "BBEC.687937..ATI", "name": "CircuitID" } ], "id": "e38d0a07-73f0-465f-89e6-80b816a8b6b5", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } }, { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/4680bedd-bc70-4d98-82e8-f6d3fa8c39a6", "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": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } }, { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "0000ZKSZJ3", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=0000ZKSZJ3" } }, { "@type": "RelatedPlaceRefOrValue", "role": "BillingAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "00010CMZGP", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=00010CMZGP" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "4dd2e20d-3830-411a-a77f-3dec3a30dd33", "href": "/geosites/4dd2e20d-3830-411a-a77f-3dec3a30dd33" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Management Option", "value": "Plus" }, { "@type": "StringCharacteristic", "name": "Billing Option", "value": "BURSTABLE BILLING" }, { "@type": "StringCharacteristic", "name": "IP Version", "value": "ipv4" }, { "@type": "StringCharacteristic", "name": "WAN IPv4 Block Size", "value": "" }, { "@type": "StringCharacteristic", "name": "Additional WAN IPv4 Addresses Needed", "value": "No" }, { "@type": "StringCharacteristic", "name": "LanIPv4 Address Block Size", "value": "" }, { "@type": "StringCharacteristic", "name": "Additional LAN IP Addresses", "value": "No" }, { "@type": "StringCharacteristic", "name": "Class of Service", "value": "" }, { "@type": "StringCharacteristic", "name": "Class of Service Profile", "value": "125" }, { "@type": "StringCharacteristic", "name": "Router Model", "value": "CISCO 9010 AR" }, { "@type": "StringCharacteristic", "name": "Router Manufacturer", "value": "CISCO" }, { "@type": "StringCharacteristic", "name": "Customer Prem Router Model", "value": "ASR1002X" }, { "@type": "StringCharacteristic", "name": "Customer Prem Router Manufacturer", "value": "Cisco" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" }, "productPrice": [ { "@type": "ProductPrice", "priceType": "Access-Price", "price": { "@type": "Price", "dutyFreeAmount": { "value": 123, "unit": "USD" }, "taxIncludedAmount": { "value": 135.3 }, "taxRate": 10 } } ], "externalBillingAccountReference": [], "agreementItem": [], "billingAccount": null, "externalIdentifier": [ { "owner": "provisioning", "externalIdentifierType": "id", "id": "BBEC.687937..ATI-3230B8/12/MAA" }, { "owner": "billing", "externalIdentifierType": "id", "id": "41-1234567" } ], "href": "/products/67e6bdce46c3a21be325736f" } }, { "processingDetails": [ { "timestamp": "2025-03-28T15:18:38.000Z", "_id": "67e6bdce46c3a21be3257378", "pinvRequestId": "2e77e0bf-f497-468d-99ab-3c21d66625c8", "durationMs": 15332, "method": "POST", "requestType": "http" } ], "exposedTmf637": { "@type": "ATTProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "e38d0a07-73f0-465f-89e6-80b816a8b6b5" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" } ], "realizingResource": [], "realizingService": [ { "@type": "ServiceRef", "id": "BBEC.687937..ATI", "name": "CircuitID" } ], "id": "606f3aca-3f2f-414d-b8ab-bd004191577c", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } } ], "place": [ { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Access Speed", "value": "50000" }, { "@type": "StringCharacteristic", "name": "Vendor", "value": "CISCO" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-ACCESS-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" }, "externalBillingAccountReference": [], "agreementItem": [], "externalIdentifier": [ { "owner": "provisioning", "externalIdentifierType": "id", "id": "BBEC.687937..ATI-3230B8/12/MAA-ACCESS" } ], "href": "/products/606f3aca-3f2f-414d-b8ab-bd004191577c" } }, { "processingDetails": [ { "timestamp": "2025-03-28T15:18:38.000Z", "_id": "67e6bdce46c3a21be3257378", "pinvRequestId": "2e77e0bf-f497-468d-99ab-3c21d66625c8", "durationMs": 15332, "method": "POST", "requestType": "http" } ], "exposedTmf637": { "@type": "ATTProduct", "@baseType": "Product", "@schemaLocation": "/schema/AttProduct_tmf637.schema.json", "productRelationship": [ { "@type": "ProductRelationship", "relationshipType": "HasParent", "id": "e38d0a07-73f0-465f-89e6-80b816a8b6b5" } ], "externalReference": [ { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "PortID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "BBEC.687937..ATI", "externalIdentifierType": "CircuitID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SiteID", "owner": "INSTAR" }, { "@type": "ExternalIdentifier", "id": "", "externalIdentifierType": "SAPID", "owner": "INSTAR" } ], "realizingResource": [ { "@type": "ResourceRef", "id": "", "name": "PortID" } ], "realizingService": [], "id": "664b4807-3a8a-4336-ad1f-d67fec9a05b2", "status": "active", "name": "AT&T Dedicated Internet (ADI)", "relatedParty": [ { "@type": "RelatedPartyOrPartyRole", "role": "Customer", "partyOrPartyRole": { "@type": "PartyRef", "@referredType": "Organization", "id": "6a2d2a28-95f9-428a-b211-58a0a50cc2af", "href": "https://cims-westus2-dev-cims-container-as.azurewebsites.net/organizations/6a2d2a28-95f9-428a-b211-58a0a50cc2af", "name": "ATT VIRTUAL OFFICE" } } ], "place": [ { "@type": "RelatedPlaceRefOrValue", "role": "ServiceAddress", "place": { "@type": "PlaceRef", "@referredType": "GeographicAddress", "id": "000020YMVY", "href": "https://attlocaddrval-test-eastus2.az.3pc.att.com/restservices/alav/service/v2/geographicAddressValidation?type=gis&glid=000020YMVY" } }, { "@type": "RelatedPlaceRefOrValue", "role": "CustomerSite", "place": { "@type": "PlaceRef", "@referredType": "GeographicSite", "id": "a9cc3f8f-5fe4-4dff-a30a-8dac7465122f", "href": "/geosites/a9cc3f8f-5fe4-4dff-a30a-8dac7465122f" } } ], "productCharacteristic": [ { "@type": "StringCharacteristic", "name": "Minimum Bandwidth Commitment", "value": "10000" }, { "@type": "StringCharacteristic", "name": "Port Speed", "value": "30000" }, { "@type": "StringCharacteristic", "name": "Interface", "value": "1000 Base-LX" } ], "productSpecification": { "@type": "ProductSpecificationRef", "id": "PR-ADI-PORT-EMBEDDED-BASE", "name": "AT&T Dedicated Internet (ADI)", "version": "Embedded Base 5.0" }, "externalBillingAccountReference": [], "agreementItem": [], "externalIdentifier": [ { "owner": "provisioning", "externalIdentifierType": "id", "id": "BBEC.687937..ATI-3230B8/12/MAA-NETWORK" } ], "href": "/products/664b4807-3a8a-4336-ad1f-d67fec9a05b2" } } ] } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "Traceability API" ] } } }, "info": { "title": "Product Inventory Management Capability", "description": "True North Capability which manages Product Inventory as a Customer recognizable representation of the products and attributes they were offered, contracted and ordered.", "version": "1.0", "contact": { "name": "Tomas Strigner", "email": "ts2743@att.com", "url": "https://pinv.dev.att.com" } }, "tags": [ { "name": "Ping", "description": "Check if the capability is up and running" }, { "name": "TMF637 Products", "description": "Product Inventory TMF637 Products API" }, { "name": "Traceability API", "description": "Traceability API" }, { "name": "Failed IEBUS Messages", "description": "Failed IEBUS Messages" } ], "servers": [ { "url": "https://pinv.dev.att.com", "description": "DEV" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "Tmf637V4PostRequestBody": { "type": "object", "required": [ "headers", "value" ], "properties": { "headers": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "4" ] }, "source": { "type": "string" } }, "required": [ "version", "source" ] }, "value": { "$ref": "#/components/schemas/Tmf637V4Product" } } }, "Tmf637V5PostRequestBody": { "type": "object", "required": [ "headers", "value" ], "properties": { "headers": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "5" ] }, "source": { "type": "string" } }, "required": [ "version", "source" ] }, "value": { "$ref": "#/components/schemas/Tmf637V5Product" } } }, "Tmf637FindAllBodySchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "$eq": {}, "$ne": {}, "$gt": { "type": "number" }, "$gte": { "type": "number" }, "$lt": { "type": "number" }, "$lte": { "type": "number" }, "$in": { "type": "array", "items": {} }, "$nin": { "type": "array", "items": {} }, "$exists": { "type": "boolean" }, "$regex": { "type": "string" }, "$elemMatch": { "type": "object" } } }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": {} } ] } }, "Tmf637V4AgreementItemRef": { "type": "object", "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "agreementItemId": { "type": "string", "description": "Identifier of the agreement" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4Any": {}, "Tmf637V4BillingAccountRef": { "description": "A BillingAccount is a detailed description of a bill structure", "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identier of the billing account" }, "href": { "type": "string", "description": "Reference of the billing account" }, "name": { "type": "string", "description": "Name of the billing account" }, "@referredType": { "type": "string", "description": "Indicates the (class) type of the billing account" } } }, "Tmf637V4Characteristic": { "type": "object", "description": "Describes a given characteristic of an object or entity through a name/value pair.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "value": { "$ref": "#/components/schemas/Tmf637V4Any", "description": "The value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "Tmf637V4Money": { "description": "A base / value business entity used to represent money.", "required": [ "value", "unit" ], "type": "object", "properties": { "value": { "description": "A positive floating point number", "type": "string" }, "unit": { "description": "Currency (ISO4217 norm uses 3 letters to define the currency).", "type": "string" } } }, "Tmf637V4Price": { "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage applied for price and price alteration", "type": "object", "properties": { "taxIncludedAmount": { "$ref": "#/components/schemas/Tmf637V4Money" }, "dutyFreeAmount": { "$ref": "#/components/schemas/Tmf637V4Money" }, "percentage": { "description": "Percentage applied", "type": "number", "format": "float" }, "taxRate": { "description": "Applied tax rate on amount", "type": "number", "format": "float" }, "@type": { "description": "Indicates the (class) type of the price", "type": "string" }, "@schemaLocation": { "description": "Link to the schema describing this REST resource.", "type": "string" } } }, "Tmf637V4PriceAlteration": { "description": "Is an amount, usually of money, that modifies the price charged for a Product", "type": "object", "properties": { "id": { "type": "string", "description": "Link to the schema describing this REST resource." }, "name": { "type": "string", "description": "A short descriptive name such as \"Monthly discount\"" }, "description": { "type": "string", "description": "A narrative that explains in detail the semantics of this ProdPriceAlteration" }, "priceType": { "type": "string", "description": "A category that describes the price such as recurring, one shot and so forth" }, "unitOfMeasure": { "type": "string", "description": "Could be minutes, GB..." }, "recurringChargePeriod": { "type": "string", "description": "Could be month, week..." }, "validFor": { "$ref": "#/components/schemas/Tmf637V4TimePeriod" }, "priority": { "type": "integer", "description": "Priority level for applying this alteration among all the defined alterations", "format": "int32" }, "@type": { "type": "string", "description": "Indicated the class (type) of the price alteration." }, "@schemaLocation": { "type": "string", "description": "A link to the schema describing the price alteration." }, "price": { "$ref": "#/components/schemas/Tmf637V4Price" } } }, "Tmf637V4Product": { "type": "object", "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", "properties": { "id": { "type": "string", "description": "Unique identifier of the product" }, "href": { "type": "string", "description": "Reference of the product" }, "description": { "type": "string", "description": "Is the description of the product. It could be copied from the description of the Product Offering." }, "isBundle": { "type": "boolean", "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." }, "isCustomerVisible": { "type": "boolean", "description": "If true, the product is visible by the customer." }, "name": { "type": "string", "description": "Name of the product. It could be the same as the name of the product offering" }, "orderDate": { "type": "string", "format": "date-time", "description": "Is the date when the product was ordered" }, "productSerialNumber": { "type": "string", "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." }, "startDate": { "type": "string", "format": "date-time", "description": "Is the date from which the product starts" }, "terminationDate": { "type": "string", "format": "date-time", "description": "Is the date when the product was terminated" }, "agreement": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4AgreementItemRef" } }, "billingAccount": { "$ref": "#/components/schemas/Tmf637V4BillingAccountRef" }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4RelatedPlaceRefOrValue" } }, "product": { "type": "array", "items": {} }, "productCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4Characteristic" } }, "productOffering": { "$ref": "#/components/schemas/Tmf637V4ProductOfferingRef" }, "productOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4RelatedProductOrderItem" } }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4ProductPrice" } }, "productRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4ProductRelationship" } }, "productSpecification": { "$ref": "#/components/schemas/Tmf637V4ProductSpecificationRef" }, "productTerm": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4ProductTerm" } }, "realizingResource": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4ResourceRef" } }, "realizingService": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4ServiceRef" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V4RelatedParty" } }, "status": { "$ref": "#/components/schemas/Tmf637V4ProductStatusType", "description": "Is the lifecycle status of the product." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "Tmf637V4ProductOfferingRef": { "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product offering" }, "href": { "type": "string", "description": "Reference of the product offering" }, "name": { "type": "string", "description": "Name of the product offering" }, "@referredType": { "type": "string", "description": "Type (class) of the product offering" } } }, "Tmf637V4ProductPrice": { "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a productOfferingPrice" }, "name": { "type": "string", "description": "A short descriptive name such as \"Subscription price\"" }, "description": { "type": "string", "description": "A narrative that explains in detail the semantics of this product price" }, "priceType": { "type": "string", "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" }, "recurringChargePeriod": { "type": "string", "description": "Could be month, week..." }, "unitOfMeasure": { "type": "string", "description": "Could be minutes, GB..." }, "@type": { "type": "string", "description": "Indicates the type of ProductPrice class" }, "@schemaLocation": { "type": "string", "description": "A link to the schema describing this REST resource" }, "price": { "$ref": "#/components/schemas/Tmf637V4Price" }, "prodPriceAlteration": { "$ref": "#/components/schemas/Tmf637V4PriceAlteration" }, "billingAccount": { "$ref": "#/components/schemas/Tmf637V4BillingAccountRef" } } }, "Tmf637V4ProductRef": { "description": "A product reference to be used for relationship target", "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product" }, "href": { "type": "string", "description": "Reference of the product" } } }, "Tmf637V4ProductRelationship": { "description": "Type of the product relationship. it can be 'bundled' if the product is a bundle and you want to describe the 'bundled' products inside this bundle, 'reliesOn' if the product needs another already owned product to rely on \n(e.g. an option on an already owned mobile access product) or 'targets' or 'isTargeted' (depending on the way of expressing the link) for any other kind of links that may be useful", "required": [ "product" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the product relationship" }, "product": { "$ref": "#/components/schemas/Tmf637V4ProductRef" } } }, "Tmf637V4ProductSpecificationRef": { "type": "object", "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "Version of the product specification" }, "targetProductSchema": { "$ref": "#/components/schemas/Tmf637V4TargetProductSchema", "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4ProductStatusType": { "type": "string", "description": "Possible values for the status of the product", "enum": [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted " ] }, "Tmf637V4ProductTerm": { "type": "object", "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", "properties": { "description": { "type": "string", "description": "Description of the productTerm" }, "name": { "type": "string", "description": "Name of the productTerm" }, "duration": { "$ref": "#/components/schemas/Tmf637V4Quantity", "description": "Duration of the productTerm" }, "validFor": { "$ref": "#/components/schemas/Tmf637V4TimePeriod", "description": "productTerm validity period" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "Tmf637V4Quantity": { "type": "object", "description": "An amount in a given unit", "properties": { "amount": { "default": 1, "type": "number", "format": "float", "description": "Numeric value in a given unit" }, "units": { "type": "string", "description": "Unit" } } }, "Tmf637V4RelatedParty": { "type": "object", "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "required": [ "@referredType", "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity.", "example": "https://cims.it.att.com/organization/48fc84be-fcfc-55f2-8b9a-327c6a64c97a" }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party", "example": "Customer, CutomerContact, ..." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4RelatedPlaceRefOrValue": { "type": "object", "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "required": [ "role" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation.", "example": "GeographicSite" } } }, "Tmf637V4RelatedProductOrderItem": { "type": "object", "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", "required": [ "orderItemId", "productOrderId" ], "properties": { "orderItemAction": { "type": "string", "description": "Action of the order item for this product" }, "orderItemId": { "type": "string", "description": "Identifier of the order item where the product was managed" }, "productOrderHref": { "type": "string", "description": "Reference of the related entity." }, "productOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "role": { "type": "string", "description": "role of the product order item for this product" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4ResourceRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the resource" }, "value": { "type": "string", "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4ServiceRef": { "type": "object", "description": "Service reference, for when Service is used by other entities", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Tmf637V4TargetProductSchema": { "type": "object", "description": "The reference object to the schema and type of target product which is described by product specification", "required": [ "@schemaLocation", "@type" ], "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "This field provides a link to the schema describing the target product" }, "@type": { "type": "string", "description": "Class type of the target product" } } }, "Tmf637V4TimePeriod": { "description": "A time period described through 2 dates", "type": "object", "properties": { "startDateTime": { "description": "", "type": "string", "format": "date-time" }, "endDateTime": { "description": "", "type": "string", "format": "date-time" } } }, "Tmf637V5AccountRef": { "type": "object", "description": "Account reference. A account may be a party account or a financial account.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5Addressable": { "type": "object", "description": "Base schema for adressable entities", "properties": { "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" } } }, "Tmf637V5AgreementItemRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "It's a Agreement item that has been executed previously.", "properties": { "agreementName": { "type": "string", "description": "Name of the related entity." }, "agreementHref": { "type": "string", "description": "Reference of the related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "agreementId": { "type": "string", "description": "Unique identifier of a related entity." }, "agreementItemId": { "type": "string", "description": "Id of an item of a Agreement" } } } ] }, "Tmf637V5AgreementRef": { "type": "object", "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5Attachment": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "Complements the description of an element (for instance a product) through video, pictures...", "properties": { "name": { "type": "string", "description": "The name of the attachment" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "content": { "type": "string", "format": "base64", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "size": { "$ref": "#/components/schemas/Tmf637V5Quantity" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "attachmentType": { "type": "string", "description": "a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy" }, "mimeType": { "type": "string", "description": "a technical characterization of the attachment content format using IETF Mime Types" } } } ] }, "Tmf637V5AttachmentRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", "properties": { "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "url": { "description": "Link to the attachment media/content", "type": "string" } } } ] }, "Tmf637V5AttachmentRefOrValue": { "type": "object", "description": "The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself", "oneOf": [ { "$ref": "#/components/schemas/Tmf637V5Attachment" }, { "$ref": "#/components/schemas/Tmf637V5AttachmentRef" } ] }, "Tmf637V5BillingAccountRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", "properties": { "ratingType": { "type": "string", "description": "Indicates whether the account follows a specific payment option such as prepaid or postpaid" } } } ] }, "Tmf637V5BusinessPartner": { "type": "object", "description": "When business partner is the BusinessPartner ", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRole" } ] }, "Tmf637V5CalendarPeriod": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "properties": { "day": { "type": "string", "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" }, "timeZone": { "type": "string", "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" }, "hourPeriod": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5HourPeriod" } }, "status": { "type": "string", "description": "Indication of the availability of the caledar period (e.g.: available, booked, etc.)" } } } ] }, "Tmf637V5Characteristic": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Describes a given characteristic of an object or entity through a name/value pair.", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5CharacteristicRelationship" } } } } ] }, "Tmf637V5CharacteristicRelationship": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Another Characteristic that is related to the current Characteristic;", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" } } } ] }, "Tmf637V5Consumer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRole" } ] }, "Tmf637V5ContactMedium": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Indicates the contact medium that could be used to contact the party.", "properties": { "id": { "type": "string", "description": "Identifier for this contact medium." }, "preferred": { "type": "boolean", "description": "If true, indicates that is the preferred contact medium" }, "contactType": { "type": "string", "description": "Type of the contact medium to qualifiy it like pro email / personal email. This is not used to define the contact medium used." }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } } ] }, "Tmf637V5CreditProfile": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", "properties": { "creditProfileDate": { "type": "string", "format": "date-time", "description": "The date the profile was established" }, "creditRiskRating": { "type": "integer", "description": "This is an integer whose value is used to rate the risk" }, "creditScore": { "type": "integer", "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } } ] }, "Tmf637V5Disability": { "type": "object", "description": "Lack or inadequate strength or ability.", "properties": { "disabilityCode": { "type": "string", "description": "Code of the disability" }, "disabilityName": { "type": "string", "description": "Name of the disability" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } }, "Tmf637V5Duration": { "type": "object", "description": "A time interval in a given unit of time", "properties": { "amount": { "type": "integer", "description": "Time interval (number of seconds, minutes, hours, etc.)" }, "units": { "type": "string", "description": "Unit of time (seconds, minutes, hours, etc.)" } } }, "Tmf637V5Entity": { "type": "object", "description": "Base entity schema for use in TMForum Open-APIs. Property.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5Addressable" } ] }, "Tmf637V5EntityRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5Addressable" }, { "type": "object", "description": "Entity reference schema to be use for all entityRef class.", "properties": { "id": { "type": "string", "description": "The identifier of the referred entity." }, "href": { "type": "string", "description": "The URI of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] } ] }, "Tmf637V5EntityRelationship": { "type": "object", "description": "A uni-directionmal relationship from this entity to a target entity instance", "properties": { "href": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string", "description": "The association role for this entity" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "associationSpec": { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "description": "Type of relationship such as migration, substitution, dependency, exclusivity" }, "id": { "type": "string" }, "@referredType": { "type": "string" }, "@type": { "type": "string" } } }, "Tmf637V5Expression": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Expression is the ontology-encoded form of the Intent", "properties": { "expressionLanguage": { "$ref": "#/components/schemas/Tmf637V5ExpressionLanguageEnum" }, "iri": { "type": "string", "description": "Internationalized Resource Identifier of the intent Expression" }, "expressionValue": { "type": "string", "description": "expression value is the ontology-encoded form of the Intent such as RDF-XML, Turtle, Json-LD,..." } } } ] }, "Tmf637V5ExpressionLanguageEnum": { "enum": [ "Turtle", "JSON-LD", "RDF-XML", "Other" ], "type": "string", "description": "Possible values for the serialized Expression language of an intent or Intent report" }, "Tmf637V5Extensible": { "type": "object", "description": "Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "required": [ "@type" ] }, "Tmf637V5ExternalIdentifier": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.", "properties": { "owner": { "type": "string", "description": "Name of the external system that owns the entity.", "example": "MagentoCommerce" }, "externalIdentifierType": { "type": "string", "description": "Type of the identification, typically would be the type of the entity within the external system", "example": "ProductOrder" }, "id": { "type": "string", "description": "identification of the entity within the external system." } } } ] }, "Tmf637V5GeographicAddress": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Place" }, { "type": "object", "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", "properties": { "city": { "type": "string", "description": "City that the address is in" }, "country": { "type": "string", "description": "Country that the address is in" }, "locality": { "type": "string", "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" }, "postcode": { "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" }, "stateOrProvince": { "type": "string", "description": "the State or Province that the address is in" }, "streetName": { "type": "string", "description": "Name of the street or other street type" }, "streetNr": { "type": "string", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" }, "streetNrLast": { "type": "string", "description": "Last number in a range of street numbers allocated to a property" }, "streetNrLastSuffix": { "type": "string", "description": "Last street number suffix for a ranged address" }, "streetNrSuffix": { "type": "string", "description": "the first street number suffix" }, "streetSuffix": { "type": "string", "description": "A modifier denoting a relative direction" }, "streetType": { "type": "string", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " }, "countryCode": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5StandardIdentifier" }, "description": "Country codes are short alphabetic or numeric geographical codes (geocodes) developed to represent countries and dependent areas, for use in data processing and communications. Several different systems have been developed to do this. The term country code frequently refers to ISO 3166-1 alpha-2 or international dialing codes, the E.164 country calling codes." }, "externalIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ExternalIdentifier" } }, "geographicLocation": { "$ref": "#/components/schemas/Tmf637V5GeographicLocationRefOrValue" }, "geographicSubAddress": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5GeographicSubAddress" } }, "geographicAddressType": { "type": "string", "description": "Classification of the address, e.g., residential, industrial " } } } ] }, "Tmf637V5GeographicLocation": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Place" }, { "type": "object", "description": "A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute.", "properties": { "id": { "type": "string", "description": "Unique identifier of the geographic location" }, "href": { "type": "string", "description": "An URI used to access to the geographic location resource" }, "@type": { "type": "string", "enum": [ "GeoJsonPoint", "GeoJsonMultiPoint", "GeoJsonLineString", "GeoJsonMultiLineString", "GeoJsonPolygon" ], "description": "The name of the GeoJSON structure used in the geometry attribute" }, "bbox": { "type": "array", "description": "A bounding box array that contains the geometry. The axes order follows the axes order of the geometry", "items": { "type": "number" } } } } ] }, "Tmf637V5GeographicLocationRef": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5GeographicLocationRefOrValue": { "type": "object", "description": "The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class itself", "oneOf": [ { "$ref": "#/components/schemas/Tmf637V5GeographicLocation" }, { "$ref": "#/components/schemas/Tmf637V5GeographicLocationRef" } ] }, "Tmf637V5GeographicSite": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Place" }, { "type": "object", "properties": { "code": { "type": "string", "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and time when the GeographicSite was created" }, "description": { "type": "string", "description": "Text describing additional information regarding the site" }, "status": { "type": "string", "description": "The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPartyOrPartyRole" } }, "externalIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ExternalIdentifier" } }, "calendar": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5CalendarPeriod" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5PlaceRefOrValue" } }, "siteRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5GeographicSiteRelationship" } } } } ] }, "Tmf637V5GeographicSiteRelationship": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "properties": { "href": { "type": "string", "description": "Reference of the related geographic site" }, "role": { "type": "string", "description": "Role of the related site in the relationship" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "id": { "type": "string", "description": "Unique identifier of the related site entity within the server" }, "relationshipType": { "type": "string", "description": "Type of relationship" } } } ] }, "Tmf637V5GeographicSubAddress": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", "properties": { "buildingName": { "type": "string", "description": "allows for buildings that have well-known names" }, "href": { "type": "string", "description": "Link to the subAddress" }, "id": { "type": "string", "description": "Unique Identifier of the subAddress" }, "levelNumber": { "type": "string", "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" }, "levelType": { "type": "string", "description": "describes level types within a building" }, "name": { "type": "string", "description": "Name of the subAddress to identify it with a meaningful identification" }, "privateStreetName": { "type": "string", "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." }, "privateStreetNumber": { "type": "string", "description": "private streets numbers internal to a private street" }, "subUnit": { "type": "array", "description": "Representation of a SubUnit. It is used for describing subunit within a subAddress e.g. BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.", "items": { "$ref": "#/components/schemas/Tmf637V5GeographicSubAddressUnit" } }, "subAddressType": { "type": "string", "description": "Type of subAddress : it can be a subunit or a private street" } } } ] }, "Tmf637V5GeographicSubAddressUnit": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Representation of a SubUnit. It is used for describing subunit within a subAddress e.g. BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.", "properties": { "subUnitNumber": { "type": "string", "description": "The discriminator used for the subunit, often just a simple number but may also be a range." }, "subUnitType": { "type": "string", "description": "The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF, RACK" } } } ] }, "Tmf637V5HourPeriod": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "properties": { "endHour": { "type": "string", "description": "The time when the status ends applying" }, "startHour": { "type": "string", "description": "The time when the status starts applying" } } } ] }, "Tmf637V5Individual": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Party" }, { "type": "object", "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", "properties": { "gender": { "type": "string", "description": "Gender" }, "placeOfBirth": { "type": "string", "description": "Reference to the place where the individual was born" }, "countryOfBirth": { "type": "string", "description": "Country where the individual was born" }, "nationality": { "type": "string", "description": "Nationality" }, "maritalStatus": { "type": "string", "description": "Marital status (married, divorced, widow ...)" }, "birthDate": { "type": "string", "format": "date-time", "description": "Birth date" }, "deathDate": { "type": "string", "format": "date-time", "description": "Date of death" }, "title": { "type": "string", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl" }, "generation": { "type": "string", "description": "e.g.. Sr, Jr, III (the third)" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "middleName": { "type": "string", "description": "Middles name or initial" }, "name": { "type": "string", "description": "Full name flatten (first, middle, and last names) - this is the name that is expected to be presented in reference data types such as PartyRef, RelatedParty, etc. that refer to Individual" }, "formattedName": { "type": "string", "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean)" }, "location": { "type": "string", "description": "Temporary current location of the individual (may be used if the individual has approved its sharing)" }, "status": { "$ref": "#/components/schemas/Tmf637V5IndividualStateType" }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5OtherNameIndividual" }, "description": "List of other names by which this individual is known" }, "individualIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5IndividualIdentification" }, "description": "List of official identifications issued to the individual, such as passport, driving licence, social security number" }, "disability": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Disability" }, "description": "List of disabilities suffered by the individual" }, "languageAbility": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5LanguageAbility" }, "description": "List of national languages known by the individual" }, "skill": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Skill" }, "description": "List of skills exhibited by the individual" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "givenName": { "type": "string", "description": "First name of the individual" } } } ] }, "Tmf637V5IndividualIdentification": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", "properties": { "identificationId": { "type": "string", "description": "Identifier" }, "issuingAuthority": { "type": "string", "description": "Authority which has issued the identifier, such as: social security, town hall" }, "issuingDate": { "type": "string", "format": "date-time", "description": "Date at which the identifier was issued" }, "identificationType": { "type": "string", "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "attachment": { "$ref": "#/components/schemas/Tmf637V5AttachmentRefOrValue" } } } ] }, "Tmf637V5IndividualStateType": { "enum": [ "initialized", "validated", "deceased" ], "type": "string", "description": "Valid values for the lifecycle state of the individual" }, "Tmf637V5Intent": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "An Intent instance is the formal description of all expectations including requirements, goals, and constraints given to a technical system", "properties": { "description": { "type": "string", "description": "The description of the intent." }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether an intent represents a single intent (false), or a bundle of intents(true)." }, "priority": { "type": "string", "description": "Can be used by intent owner to prioritize intents in an intent management system" }, "statusChangeDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date that the entity status changed to the current one" }, "context": { "type": "string", "description": "A string used to give a context to the intent" }, "version": { "type": "string", "description": "A field that identifies the specific version of an instance of an intent." }, "intentSpecification": { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, "intentRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5EntityRelationship" }, "description": "A list of intents related to this intent" }, "characteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Characteristic" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPartyRefOrPartyRoleRef" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5AttachmentRefOrValue" }, "description": "Attachments that may be of relevance to this intent, such as picture, document, media" }, "name": { "type": "string", "description": "The name of the intent." }, "expression": { "$ref": "#/components/schemas/Tmf637V5Expression" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and time of the creation of this REST resource" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this intent" } } } ] }, "Tmf637V5IntentRef": { "type": "object", "description": "Intent reference, for when Intent is used by other entities", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5IntentRefOrValue": { "type": "object", "description": "Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)", "oneOf": [ { "$ref": "#/components/schemas/Tmf637V5IntentRef" }, { "$ref": "#/components/schemas/Tmf637V5Intent" } ] }, "Tmf637V5ItemActionType": { "enum": [ "add", "modify", "delete", "noChange" ], "type": "string", "description": "action to be performed on the entity managed by the item" }, "Tmf637V5LanguageAbility": { "type": "object", "description": "Ability of an individual to understand or converse in a language.", "properties": { "languageCode": { "type": "string", "description": "Language code (RFC 5646)" }, "languageName": { "type": "string", "description": "Language name" }, "isFavouriteLanguage": { "type": "boolean", "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" }, "writingProficiency": { "type": "string", "description": "Writing proficiency evaluated for this language" }, "readingProficiency": { "type": "string", "description": "Reading proficiency evaluated for this language" }, "speakingProficiency": { "type": "string", "description": "Speaking proficiency evaluated for this language" }, "listeningProficiency": { "type": "string", "description": "Listening proficiency evaluated for this language" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } }, "Tmf637V5Money": { "type": "object", "description": "A base / value business entity used to represent money", "properties": { "unit": { "type": "string", "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" }, "value": { "type": "number", "format": "float", "description": "A signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type" } } }, "Tmf637V5Organization": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Party" }, { "type": "object", "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", "properties": { "isLegalEntity": { "type": "boolean", "description": "If value is true, the organization is a legal entity known by a national referential." }, "isHeadOffice": { "type": "boolean", "description": "If value is true, the organization is the head office" }, "organizationType": { "type": "string", "description": "Type of Organization (company, department...)" }, "existsDuring": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "name": { "type": "string", "description": "Organization name (department name for example)" }, "nameType": { "type": "string", "description": "Type of the name : Co, Inc, Ltd, etc." }, "status": { "$ref": "#/components/schemas/Tmf637V5OrganizationStateType" }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5OtherNameOrganization" }, "description": "List of additional names by which the organization is known" }, "organizationIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5OrganizationIdentification" }, "description": "List of official identifiers given to the organization, for example company number in the registry of companies" }, "organizationChildRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5OrganizationChildRelationship" }, "description": "List of organizations that are contained within this organization. For example if this organization is the Legal Department, the child organizations might include Claims, Courts, Contracts" }, "organizationParentRelationship": { "$ref": "#/components/schemas/Tmf637V5OrganizationParentRelationship" }, "tradingName": { "type": "string", "description": "Name that the organization (unit) trades under" } } } ] }, "Tmf637V5OrganizationChildRelationship": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Child references of an organization in a structure of organizations.", "properties": { "relationshipType": { "type": "string", "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." }, "organization": { "$ref": "#/components/schemas/Tmf637V5OrganizationRef" } } } ] }, "Tmf637V5OrganizationIdentification": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Represents our registration of information used as proof of identity by an organization", "properties": { "identificationId": { "type": "string", "description": "Identifier" }, "issuingAuthority": { "type": "string", "description": "Authority which has issued the identifier (chamber of commerce...)" }, "issuingDate": { "type": "string", "format": "date-time", "description": "Date at which the identifier was issued" }, "identificationType": { "type": "string", "description": "Type of identification information used to identify the company in a country or internationally" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "attachment": { "$ref": "#/components/schemas/Tmf637V5AttachmentRefOrValue" } } } ] }, "Tmf637V5OrganizationParentRelationship": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Parent references of an organization in a structure of organizations.", "properties": { "relationshipType": { "type": "string", "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." }, "organization": { "$ref": "#/components/schemas/Tmf637V5OrganizationRef" } } } ] }, "Tmf637V5OrganizationRef": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5OrganizationStateType": { "enum": [ "initialized", "validated", "closed" ], "type": "string", "description": "Valid values for the lifecycle state of the organization" }, "Tmf637V5OtherNameIndividual": { "type": "object", "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", "properties": { "title": { "type": "string", "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl, etc." }, "generation": { "type": "string", "description": "e.g. Sr, Jr, etc." }, "givenName": { "type": "string", "description": "First name" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "middleName": { "type": "string", "description": "Middle name or initial" }, "fullName": { "type": "string", "description": "Full name flatten (first, middle, and last names)" }, "formattedName": { "type": "string", "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean, etc.)" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } }, "Tmf637V5OtherNameOrganization": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Keeps track of other names, for example the old name of an organization.", "properties": { "tradingName": { "type": "string", "description": "The name that the organization trades under" }, "nameType": { "type": "string", "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" }, "name": { "type": "string", "description": "Organization name (department name for example)" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } } ] }, "Tmf637V5Party": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "Generic and Abstract Party structure used to define commonalities between sub concepts of Individual and Organization.", "properties": { "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ExternalIdentifier" }, "description": "List of identifiers of the Party in an external system, for example when party information is imported from a commerce system" }, "partyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Characteristic" }, "description": "List of additional characteristics that a Party can take on." }, "taxExemptionCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5TaxExemptionCertificate" }, "description": "List of tax exemptions granted to the party. For example, a war veteran might have partial exemption from state tax and a full exemption from federal tax" }, "creditRating": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5PartyCreditProfile" }, "description": "List of credit profiles and scores for the party, typically received from an external credit broker" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPartyOrPartyRole" }, "description": "List of parties and/or party roles related to this party" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ContactMedium" }, "description": "List of means for contacting the party, e.g. mobile phone, email address" } } } ] }, "Tmf637V5PartyCreditProfile": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", "properties": { "creditAgencyName": { "type": "string", "description": "Name of the credit agency giving the score" }, "creditAgencyType": { "type": "string", "description": "Type of the credit agency giving the score" }, "ratingReference": { "type": "string", "description": "Reference corresponding to the credit rating" }, "ratingScore": { "type": "integer", "format": "int32", "description": "A measure of a party's creditworthiness calculated on the basis of a combination of factors such as their income and credit history" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } } ] }, "Tmf637V5PartyOrPartyRole": { "type": "object", "description": "", "anyOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRef" }, { "$ref": "#/components/schemas/Tmf637V5PartyRoleRef" }, { "$ref": "#/components/schemas/Tmf637V5Individual" }, { "$ref": "#/components/schemas/Tmf637V5Organization" }, { "$ref": "#/components/schemas/Tmf637V5PartyRole" }, { "$ref": "#/components/schemas/Tmf637V5Supplier" }, { "$ref": "#/components/schemas/Tmf637V5BusinessPartner" }, { "$ref": "#/components/schemas/Tmf637V5Consumer" }, { "$ref": "#/components/schemas/Tmf637V5Producer" } ] }, "Tmf637V5PartyRef": { "type": "object", "description": "A Party reference", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5PartyRefOrPartyRoleRef": { "type": "object", "description": "", "oneOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRef" }, { "$ref": "#/components/schemas/Tmf637V5PartyRoleRef" } ] }, "Tmf637V5PartyRole": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "The part played by a party in a given context.", "properties": { "name": { "type": "string", "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It's the name of the PartyRole unique entity." }, "description": { "type": "string", "description": "A description of the PartyRole." }, "role": { "type": "string", "description": "Role played by the engagedParty in this context. As role is defined by partyRoleSpecification, this role attribute can be used to precise the role defined by partyRoleSpecification, or it can be used to define the role in case there is no partyRoleSpecification." }, "engagedParty": { "$ref": "#/components/schemas/Tmf637V5PartyRef" }, "partyRoleSpecification": { "$ref": "#/components/schemas/Tmf637V5PartyRoleSpecificationRef" }, "characteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Characteristic" }, "description": "Describes the characteristic of a party role." }, "account": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5AccountRef" } }, "agreement": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5AgreementRef" } }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ContactMedium" } }, "paymentMethod": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5PaymentMethodRef" } }, "creditProfile": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5CreditProfile" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPartyOrPartyRole" } }, "status": { "type": "string", "description": "Used to track the lifecycle status of the party role." }, "statusReason": { "type": "string", "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } } ] }, "Tmf637V5PartyRoleRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "Party role reference. A party role represents the part played by a party in a given context.", "properties": { "partyId": { "type": "string", "description": "The identifier of the engaged party that is linked to the PartyRole object." }, "partyName": { "type": "string", "description": "The name of the engaged party that is linked to the PartyRole object." } } } ] }, "Tmf637V5PartyRoleSpecificationRef": { "type": "object", "description": "Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5PaymentMethodRef": { "type": "object", "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5Place": { "type": "object", "description": "Place reference.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" } ] }, "Tmf637V5PlaceRef": { "type": "object", "description": "Place reference.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5PlaceRefOrValue": { "type": "object", "description": "The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself", "anyOf": [ { "$ref": "#/components/schemas/Tmf637V5GeographicLocation" }, { "$ref": "#/components/schemas/Tmf637V5GeographicSite" }, { "$ref": "#/components/schemas/Tmf637V5GeographicAddress" }, { "$ref": "#/components/schemas/Tmf637V5PlaceRef" } ] }, "Tmf637V5Price": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price and Price Alteration.", "properties": { "dutyFreeAmount": { "$ref": "#/components/schemas/Tmf637V5Money" }, "percentage": { "type": "number", "format": "float", "description": "Percentage to apply for ProdOfferPriceAlteration" }, "taxIncludedAmount": { "$ref": "#/components/schemas/Tmf637V5Money" }, "taxRate": { "type": "number", "format": "float", "description": "Tax rate" } } } ] }, "Tmf637V5PriceAlteration": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Is an amount, usually of money, that modifies the price charged for an order item.", "properties": { "applicationDuration": { "type": "integer", "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" }, "description": { "type": "string", "description": "A narrative that explains in detail the semantics of this order item price alteration" }, "name": { "type": "string", "description": "Name of the order item price alteration" }, "productOfferingPrice": { "$ref": "#/components/schemas/Tmf637V5ProductOfferingPriceRef" }, "priceType": { "type": "string", "description": "A category that describes the price such as recurring, one time and usage." }, "priority": { "type": "integer", "description": "Priority level for applying this alteration among all the defined alterations on the order item price" }, "recurringChargePeriod": { "type": "string", "description": "Could be month, week..." }, "unitOfMeasure": { "type": "string", "description": "Could be minutes, GB..." }, "price": { "$ref": "#/components/schemas/Tmf637V5Price" } } } ] }, "Tmf637V5Producer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRole" } ] }, "Tmf637V5Product": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", "properties": { "agreementItem": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5AgreementItemRef" } }, "billingAccount": { "$ref": "#/components/schemas/Tmf637V5BillingAccountRef" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and time when the product was created" }, "description": { "type": "string", "description": "Is the description of the product. It could be copied from the description of the Product Offering." }, "isBundle": { "type": "boolean", "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." }, "isCustomerVisible": { "type": "boolean", "description": "If true, the product is visible by the customer." }, "name": { "type": "string", "description": "Name of the product. It could be the same as the name of the product offering" }, "orderDate": { "type": "string", "format": "date-time", "description": "Is the date when the product was ordered" }, "productCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5Characteristic" } }, "productOffering": { "$ref": "#/components/schemas/Tmf637V5ProductOfferingRef" }, "productOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedOrderItem" } }, "product": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ProductRefOrValue" } }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ProductPrice" } }, "productRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ProductRelationship" } }, "productSerialNumber": { "type": "string", "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." }, "productSpecification": { "$ref": "#/components/schemas/Tmf637V5ProductSpecificationRef" }, "productTerm": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ProductTerm" } }, "realizingResource": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ResourceRef" } }, "realizingService": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5ServiceRef" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPartyOrPartyRole" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5RelatedPlaceRefOrValue" } }, "startDate": { "type": "string", "format": "date-time", "description": "Is the date from which the product starts" }, "status": { "$ref": "#/components/schemas/Tmf637V5ProductStatusType" }, "terminationDate": { "type": "string", "format": "date-time", "description": "Is the date when the product was terminated" }, "intent": { "$ref": "#/components/schemas/Tmf637V5IntentRefOrValue" } } } ] }, "Tmf637V5ProductOfferingPriceRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", "properties": { "version": { "type": "string", "description": "Version of the product offering price" } } } ] }, "Tmf637V5ProductOfferingRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "properties": { "version": { "type": "string", "description": "Version of the product offering" } } } ] }, "Tmf637V5ProductPrice": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Description of price and discount awarded", "properties": { "description": { "type": "string", "description": "Description of the Product price" }, "name": { "type": "string", "description": "Name of the Product price" }, "productOfferingPrice": { "$ref": "#/components/schemas/Tmf637V5ProductOfferingPriceRef" }, "recurringChargePeriod": { "type": "string", "description": "Used for recurring charge to indicate period (month, week, etc..)." }, "unitOfMeasure": { "type": "string", "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" }, "price": { "$ref": "#/components/schemas/Tmf637V5Price" }, "priceAlteration": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5PriceAlteration" } }, "priceType": { "type": "string", "description": "indicate if the price is for recurrent or no-recurrent charge" } } } ] }, "Tmf637V5ProductRef": { "type": "object", "description": "A Product reference", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5ProductRefOrValue": { "type": "object", "description": "The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself", "oneOf": [ { "$ref": "#/components/schemas/Tmf637V5Product" }, { "$ref": "#/components/schemas/Tmf637V5ProductRef" } ] }, "Tmf637V5ProductRelationship": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "Used to describe relationship between product.", "properties": { "id": { "type": "string", "description": "Id of the related product" }, "relationshipType": { "type": "string", "description": "Relationship type as relies on, bundles, etc..." } } } ] }, "Tmf637V5ProductSpecificationRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" }, { "type": "object", "description": "ProductSpecification reference. A product Specification represents entities that are orderable from the provider of the catalog.", "properties": { "version": { "type": "string", "description": "Version of the product specification" }, "targetProductSchema": { "$ref": "#/components/schemas/Tmf637V5TargetProductSchema" } } } ] }, "Tmf637V5ProductStatusType": { "enum": [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted " ], "type": "string", "description": "Possible values for the status of the product" }, "Tmf637V5ProductTerm": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", "properties": { "description": { "type": "string", "description": "Description of the productTerm" }, "duration": { "$ref": "#/components/schemas/Tmf637V5Duration" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "name": { "type": "string", "description": "Name of the productTerm", "example": "12months commitment" } } } ] }, "Tmf637V5Quantity": { "type": "object", "description": "An amount in a given unit", "properties": { "amount": { "type": "number", "format": "float", "default": 1, "description": "Numeric value in a given unit" }, "units": { "type": "string", "description": "Unit" } } }, "Tmf637V5RelatedOrderItem": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "It's a Order item that has been executed previously.", "properties": { "orderItemAction": { "$ref": "#/components/schemas/Tmf637V5ItemActionType" }, "orderHref": { "type": "string", "description": "Reference of the related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "role": { "type": "string", "description": "Role played by the Order" }, "orderId": { "type": "string", "description": "Unique identifier of a related Order." }, "orderItemId": { "type": "string", "description": "Id of an item of a prduct order" } } } ] }, "Tmf637V5RelatedPartyOrPartyRole": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity", "properties": { "role": { "description": "Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'", "type": "string" }, "partyOrPartyRole": { "$ref": "#/components/schemas/Tmf637V5PartyOrPartyRole" } } } ] }, "Tmf637V5RelatedPartyRefOrPartyRoleRef": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity", "properties": { "role": { "description": "Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'", "type": "string" }, "partyOrPartyRole": { "$ref": "#/components/schemas/Tmf637V5PartyRefOrPartyRoleRef" } } } ] }, "Tmf637V5RelatedPlaceRefOrValue": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Entity reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the RelatedPlace entity and not the RelatedPlaceRefOrValue class itself", "properties": { "role": { "type": "string" }, "place": { "$ref": "#/components/schemas/Tmf637V5PlaceRefOrValue" } } } ] }, "Tmf637V5ResourceRef": { "type": "object", "description": "Resource reference, for when Resource is used by other entities.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5ServiceRef": { "type": "object", "description": "Service reference, for when Service is used by other entities.", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "$ref": "#/components/schemas/Tmf637V5EntityRef" } ] }, "Tmf637V5Skill": { "type": "object", "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", "properties": { "skillCode": { "type": "string", "description": "Code of the skill" }, "skillName": { "type": "string", "description": "Name of the skill, such as Java language" }, "evaluatedLevel": { "type": "string", "description": "Level of expertise in a skill evaluated for an individual" }, "comment": { "type": "string", "description": "A free text comment linked to the evaluation done" }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" } } }, "Tmf637V5StandardIdentifier": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Entity" }, { "type": "object", "description": "The corresponding identification of the resource in different standard, regulatory definitions. The standard specification identifier (e.g., ISO 3166-1 Alpha-2) and the corresponding value (e.g., BE) relevant to a particular resource. It is anticipated that multiple standards can provide definitions for a single entity, e.g., a country identifier can be specified in various standards (e.g., \"ISO 3166-1 Alpha 2\", \"ISO 3166-1 Alpha 3\", \"ISO 3166-1 Numeric\")", "properties": { "format": { "type": "string", "description": "Standard/Regulatory definition identifier. e.g., ISO 3166-1", "example": "ISO 3166-1" }, "value": { "type": "string", "description": "The value of the resource in the corresponding standard.e.g., a country code value", "example": "GB" } } } ] }, "Tmf637V5Supplier": { "type": "object", "description": "When business partner is the Supplier ", "allOf": [ { "$ref": "#/components/schemas/Tmf637V5PartyRole" } ] }, "Tmf637V5TargetProductSchema": { "type": "object", "description": "The reference object to the schema and type of target product which is described by product specification", "properties": { "@type": { "type": "string", "description": "Class type of the target product" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "This field provides a link to the schema describing the target product" } } }, "Tmf637V5TaxDefinition": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).", "properties": { "id": { "type": "string", "description": "Unique identifier of the tax." }, "name": { "type": "string", "description": "Tax name." }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "jurisdictionName": { "type": "string", "description": "Name of the jurisdiction that levies the tax", "example": "USA" }, "jurisdictionLevel": { "type": "string", "description": "Level of the jurisdiction that levies the tax", "example": "Country" }, "taxType": { "type": "string", "description": "Type of the tax.", "example": "VAT" } } } ] }, "Tmf637V5TaxExemptionCertificate": { "allOf": [ { "$ref": "#/components/schemas/Tmf637V5Extensible" }, { "type": "object", "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", "properties": { "id": { "type": "string", "description": "Identifier of the tax exemption within list of the exemptions" }, "taxDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/Tmf637V5TaxDefinition" }, "description": "A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." }, "validFor": { "$ref": "#/components/schemas/Tmf637V5TimePeriod" }, "certificateNumber": { "type": "string", "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" }, "issuingJurisdiction": { "type": "string", "description": "Name of the jurisdiction that issued the exemption", "example": "USA" }, "reason": { "type": "string", "description": "Reason for the tax exemption" }, "attachment": { "$ref": "#/components/schemas/Tmf637V5AttachmentRefOrValue" } } } ] }, "Tmf637V5TimePeriod": { "type": "object", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "properties": { "startDateTime": { "description": "Start of the time period, using IETC-RFC-3339 format", "type": "string", "format": "date-time", "example": "1985-04-12T23:20:50.52Z" }, "endDateTime": { "description": "End of the time period, using IETC-RFC-3339 format", "type": "string", "format": "date-time", "example": "1985-04-12T23:20:50.52Z" } } } } } }