{ "info": { "title": "att-order-eapi", "version": "v1", "description": "This Expierence API is used by the user for creating order and order enrichment ." }, "paths": { "/order": { "post": { "summary": "Create Order & Sub-Order", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_postOrder" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "x-transaction-id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "required": false, "in": "header", "schema": { "title": "Transaction Id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "example": "73c427a4-2482-4e64-8cac-ea4ace577871", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "Create_Order", "description": "To facilitate the order creation process and accept the terms and conditions- https://www.att.com/legal/terms.consumerServiceAgreement.html ", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } } } } }, "/order-enrichment/cdg": { "put": { "summary": "Order Group Enrichment", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putEnrich" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "x-page-slug": "Order_Enrichment", "description": "To gather additional information about CDG (customer data group).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_4" } } } } }, "get": { "summary": "Order Group Enrichment", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_getCDG" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "x-page-slug": "Order_Enrichment_cdg", "description": "To gather additional information about CDG (customer data group).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_reqCDG" } } } } }, "post": { "summary": ":Post Order Summary", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_resSummary" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "x-page-slug": "Order_Enrichment_Summary", "description": "To post a summary about the Order Group.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_reqSummary" } } } } } }, "/order-enrichment/billing": { "put": { "summary": "Post Order Billing ", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putEnrich" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "description": "The purpose of this API endpoint is to add information about new billing account for IPBB product.", "x-page-slug": "order_billing", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_3" } } } } }, "post": { "summary": "Post Billing", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billingAccountResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "Post_Billing", "description": "The purpose of this API endpoint is to add information about new billing account for ADI product.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_postBillingReq" } } } } }, "get": { "summary": "Get Billing", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_questions" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "Get_Billing", "description": "This method is used to fetch security questions for ipbb." } }, "/order-enrichment/shipping": { "put": { "summary": "Order Shipping", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putEnrich" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "x-page-slug": "Shipping order", "description": "To gather additional information about shipping.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_2" } } } } } }, "/order-enrichment/installation": { "put": { "summary": "Order Installation", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putEnrich" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "description": "To gather additional information about installation.", "x-page-slug": "Order Installation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_1" } } } } } }, "/order-enrichment/newBilling": { "post": { "summary": "New Billing", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_newBillingRes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "description": "The purpose of this API endpoint is to add information about new billing account for ADI product.", "x-page-slug": "OrderNewBilling", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_newBillingReq" } } } } } }, "/order-enrichment/service-appointment": { "put": { "summary": "Service Appointment", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_resServiceAppt" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "x-transaction-id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "required": false, "in": "header", "schema": { "title": "Transaction Id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "example": "73c427a4-2482-4e64-8cac-ea4ace577871", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "Order_Enrichment_ServiceAppt", "description": "To update information about an Order Enrichment Service Appointment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_reqServiceAppt" } } } } }, "post": { "summary": "Service Appointment", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_post_serviceApptRes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "Order_Enrichment_ServiceAppt_post", "description": "To post information about an Order Enrichment Service Appointment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_post_serviceApptReq" } } } } } }, "/order-enrichment/gw-site-readiness": { "put": { "summary": "GW Site Readiness", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_gw-siteRes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "gw_site_readiness", "description": "Populates if the ABV site readiness enriched successfully", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_gw-siteReq" } } } } } }, "/order-enrichment/tn-configuration": { "put": { "summary": "TN Configuration", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putTNRes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "x-transaction-id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "required": false, "in": "header", "schema": { "title": "Transaction Id", "description": "This field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.", "example": "73c427a4-2482-4e64-8cac-ea4ace577871", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "tn_configuration", "description": "Endpoint to configure the Servie App Configuration.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_putTNReq" } } } } } }, "/order-enrichment/transport-type": { "post": { "summary": "Transport Type", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_transportRes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\n" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The supplied credentials are invalid.\n" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "TThe server understood the request but refuses to authorize it.\n" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The server cannot find the requested resource.\n" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.\n" }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent.\n" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardError" } } }, "description": "An internal processing error occurred while processing the API request.\n" } }, "parameters": [ { "name": "source", "description": "This field should identify the calling system/application.", "required": false, "in": "header", "schema": { "title": "Source", "description": "This field should identify the calling system/application.", "example": "product-papi/product", "type": "string" } }, { "name": "client_id", "required": true, "in": "header", "schema": { "title": "Client Id", "example": "", "type": "string" } }, { "name": "client_secret", "required": true, "in": "header", "schema": { "title": "Client Secret", "example": "", "type": "string" } }, { "name": "x-trace-id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "required": true, "in": "header", "schema": { "title": "idp trace id", "description": "This field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.", "example": "a49fd114-c14b-11ea-b3de-0242ac130004", "type": "string" } } ], "x-page-slug": "post_transport", "description": "This API endpoint allows you to update or enrich the transport type details of an order by providing information about the primary and backup internet connections associated with that order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type_transportReq" } } } } } } }, "openapi": "3.0.0", "servers": [ { "url": "https://att-order-eapi.gw.cloud.att.com/api/v1" } ], "components": { "schemas": { "type": { "type": "object", "example": { "quoteId": "0Q0Kf000000xjXgKAI", "checkT&C": true, "contacts": { "contactDetails": { "primary": { "zip": "95350", "type": "primary", "city": "Modesto", "email": "alpha@tes.com", "state": "CA", "street": "3430 Tully Rd", "lastName": "N", "firstName": "Sha" }, "alternate": { "zip": "55402", "type": "alternate", "city": "Minneapolis", "email": "lrachel@gmail.com", "state": "MN", "street": "901 Marquette Ave STE 700", "lastName": "Deep", "firstName": "Vikas" } } } }, "required": [ "quoteId", "contacts" ], "properties": { "quoteId": { "type": "string", "example": "0Q055000000g9ke", "minLength": 1 }, "contacts": { "type": "object", "required": [ "contactDetails" ], "properties": { "contactDetails": { "type": "object", "required": [ "primary", "alternate" ], "properties": { "primary": { "type": "object", "required": [ "type" ], "properties": { "zip": { "type": "string", "example": "95350", "minLength": 1 }, "type": { "enum": [ "primary" ], "type": "string", "example": "primary" }, "city": { "type": "string", "example": "Modesto", "minLength": 1 }, "email": { "type": "string", "example": "jefi.james@accenture.com", "minLength": 1 }, "state": { "type": "string", "example": "CA", "minLength": 1 }, "street": { "type": "string", "example": "3430 Tully Rd", "minLength": 1 }, "lastName": { "type": "string", "example": "james", "minLength": 1 }, "firstName": { "type": "string", "example": "sahajefi", "minLength": 1 } } }, "alternate": { "type": "object", "required": [ "type" ], "properties": { "zip": { "type": "string", "example": "55402", "minLength": 1 }, "type": { "enum": [ "alternate" ], "type": "string", "example": "alternate" }, "city": { "type": "string", "example": "Minneapolis", "minLength": 1 }, "email": { "type": "string", "example": "vbanna@salesforce.com", "minLength": 1 }, "state": { "type": "string", "example": "MN", "minLength": 1 }, "street": { "type": "string", "example": "901 Marquette Ave STE 700", "minLength": 1 }, "lastName": { "type": "string", "example": "Deep", "minLength": 1 }, "firstName": { "type": "string", "example": "Vikas", "minLength": 1 } } } } } } } } }, "type_postOrder": { "type": "object", "properties": { "status": { "type": "string" }, "orderId": { "type": "string" }, "subOrder": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "subOrderItem": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string" }, "orderItemType": { "type": "string" } }, "required": [ "orderItemId", "orderItemType" ] } } }, "required": [ "subOrderId", "subOrderItem" ] }, "statusMessage": { "type": "string" } }, "required": [ "status", "orderId", "subOrder", "statusMessage" ] }, "type_putTNRes": { "type": "array", "items": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" } }, "required": [ "subOrderId", "status", "statusMessage" ] } }, "type_putTNReq": { "type": "array", "items": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "tnConfig": { "type": "array", "items": { "type": "object", "properties": { "telephoneLineNumber": { "type": "string" }, "utilityType": { "type": "string" }, "manufacturer": { "type": "string" }, "model": { "type": "string" }, "copperLineTerminateLocation": { "type": "string" }, "copperLineTerminateLocationOther": { "type": "string" }, "callerId": { "type": "string" }, "hotline": { "type": "string" }, "hotlineNumber": { "type": "string" } }, "required": [ "telephoneLineNumber", "utilityType", "manufacturer", "model", "copperLineTerminateLocation", "copperLineTerminateLocationOther", "callerId", "hotline", "hotlineNumber" ] } } }, "required": [ "subOrderId", "tnConfig" ] } }, "type_transportRes": { "type": "object", "properties": { "orderId": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "subOrderId": { "type": "string" } }, "required": [ "orderId", "status", "statusMessage", "subOrderId" ] }, "type_transportReq": { "type": "object", "properties": { "orderId": { "type": "string" }, "subOrderId": { "type": "string" }, "primaryInternetConnection": { "type": "object", "properties": { "name": { "type": "string" }, "providerName": { "type": "string" }, "installationDate": { "type": "string" } }, "required": [ "name", "providerName", "installationDate" ] }, "backupInternetConnection": { "type": "object", "properties": { "name": { "type": "string" }, "providerName": { "type": "string" }, "installationDate": { "type": "string" } }, "required": [ "name", "providerName", "installationDate" ] } }, "required": [ "orderId", "subOrderId", "primaryInternetConnection", "backupInternetConnection" ] }, "type_putEnrich": { "type": "object", "properties": { "status": { "type": "string" }, "orderId": { "type": "string" }, "subOrderId": { "type": "string" }, "statusMessage": { "type": "string" } }, "required": [ "status", "orderId", "subOrderId", "statusMessage" ] }, "type_reqServiceAppt": { "type": "object", "properties": { "orderId": { "type": "string" }, "subOrderId": { "type": "string" }, "serivceAppointmentRequestDate": { "type": "string", "format": "date" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "required": [ "orderId", "subOrderId", "serivceAppointmentRequestDate", "startDate", "endDate" ] }, "type_resServiceAppt": { "type": "object", "properties": { "searchCDGResponse": { "type": "object", "properties": { "invoiceNumber": { "type": "integer" }, "flowName": { "type": "string" }, "outputValues": { "type": "array", "items": { "type": "object", "properties": { "billingAccountId": { "type": "string" }, "billingAccountName": { "type": "string" }, "cdgId": { "type": "string" }, "cdgName": { "type": "string" }, "cdgDescripton": { "type": "string" } }, "required": [ "billingAccountId", "billingAccountName", "cdgId", "cdgName", "cdgDescripton" ] } } }, "required": [ "invoiceNumber", "flowName", "outputValues" ] } }, "required": [ "searchCDGResponse" ] }, "type_gw-siteReq": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "abvSiteConfig": { "type": "array", "items": { "type": "object", "properties": { "firewall": { "type": "string" }, "internetAccessPortLocationOther": { "type": "string" }, "internetAccessPortLocation": { "type": "string" }, "roomSpaceRequirement": { "type": "string" }, "outsideLines": { "type": "string" }, "buildingType": { "type": "string" }, "cablingLength": { "type": "string" }, "copperLinesLabeled": { "type": "string" }, "centralPointCopperWiring": { "type": "string" }, "powerProvidedtoDevice": { "type": "string" }, "simPort1APN": { "type": "string" }, "simPort2": { "type": "string" }, "simPort1": { "type": "string" }, "wanPort": { "type": "string" } }, "required": [ "firewall", "internetAccessPortLocationOther", "internetAccessPortLocation", "roomSpaceRequirement", "outsideLines", "buildingType", "cablingLength", "copperLinesLabeled", "centralPointCopperWiring", "powerProvidedtoDevice", "simPort1APN", "simPort2", "simPort1", "wanPort" ] } } }, "required": [ "subOrderId", "abvSiteConfig" ] }, "type_gw-siteRes": { "type": "object", "properties": { "createABVSiteReadinessResponse": { "type": "object", "properties": { "outputValues": { "type": "array", "items": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "status": { "type": "string" }, "message": { "type": "string" } }, "required": [ "subOrderId", "status", "message" ] } } }, "required": [ "outputValues" ] } }, "required": [ "createABVSiteReadinessResponse" ] }, "type_1": { "type": "object", "example": { "quoteId": "0Q0Kf000000xjXgKAI", "orderId": "801Kf000004FnicIAC", "contacts": { "contactDetails": { "dayToDayContact": { "type": "dayToDayContact", "email": "abc@accen.com" }, "authorizedContact": { "type": "authorizedContact", "email": "abc@accen.com" }, "implementationTechnical": { "type": "implementationTechnical", "email": "abc@accen.com" }, "supportTechnicalPrimary": { "type": "supportTechnicalPrimary", "email": "abc@accen.com" }, "implementationSiteAccess": { "type": "implementationSiteAccess", "email": "abc@accen.com" }, "supportSiteAccessPrimary": { "type": "supportSiteAccessPrimary", "email": "abc@accen.com" }, "supportTechnicalAlternate": { "type": "supportTechnicalAlternate", "email": "lrachel@gmail.com" }, "supportSiteAccessAlternate": { "type": "supportSiteAccessAlternate", "email": "lrachel@gmail.com" }, "implementationSiteAccessAlternate": { "type": "implementationSiteAccessAlternate", "email": "lrachel@gmail.com" } } }, "subOrderId": "801Kf000004FnihIAC", "premiseNotes": "Test", "customerRequestedDueDate": "2024-04-09T19:00:00.000+0000", "customerRequestedStartDate": "2024-04-08T20:00:00.000+0000", "startBillingBeforeReqDueDate": "false" }, "required": [ "quoteId", "orderId", "subOrderId", "customerRequestedStartDate", "customerRequestedDueDate", "startBillingBeforeReqDueDate", "contacts" ], "properties": { "quoteId": { "type": "string", "example": "aswuhwbcewuwnoe2", "minLength": 1 }, "orderId": { "type": "string", "example": "801Dx000001cs61IAA", "minLength": 1 }, "contacts": { "type": "object", "required": [ "contactDetails" ], "properties": { "contactDetails": { "type": "object", "required": [ "implementationTechnical", "implementationSiteAccess", "implementationSiteAccessAlternate", "supportSiteAccessPrimary", "supportSiteAccessAlternate", "supportTechnicalPrimary", "supportTechnicalAlternate", "authorizedContact", "dayToDayContact" ], "properties": { "dayToDayContact": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "dayToDayContact" ], "type": "string", "example": "dayToDayContact" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "authorizedContact": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "authorizedContact" ], "type": "string", "example": "authorizedContact" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "implementationTechnical": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "implementationTechnical" ], "type": "string", "example": "implementationTechnical" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "supportTechnicalPrimary": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "supportTechnicalPrimary" ], "type": "string", "example": "supportTechnicalPrimary" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "implementationSiteAccess": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "implementationSiteAccess" ], "type": "string", "example": "implementationSiteAccess" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "supportSiteAccessPrimary": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "supportSiteAccessPrimary" ], "type": "string", "example": "supportSiteAccessPrimary" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "supportTechnicalAlternate": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "supportTechnicalAlternate" ], "type": "string", "example": "supportTechnicalAlternate" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "supportSiteAccessAlternate": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "supportSiteAccessAlternate" ], "type": "string", "example": "supportSiteAccessAlternate" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } }, "implementationSiteAccessAlternate": { "type": "object", "required": [ "type", "email" ], "properties": { "type": { "enum": [ "implementationSiteAccessAlternate" ], "type": "string", "example": "implementationSiteAccessAlternate" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 } } } } } } }, "subOrderId": { "type": "string", "example": "801Dx000001cs66IAA", "minLength": 1 }, "premiseNotes": { "type": "string", "example": "Test" }, "customerRequestedDueDate": { "type": "string", "example": "2024-06-30T19:00:00.000+0000", "minLength": 1 }, "customerRequestedStartDate": { "type": "string", "example": "2024-01-16T20:00:00.000+0000", "minLength": 1 }, "startBillingBeforeReqDueDate": { "type": "string", "example": "true", "minLength": 1 } } }, "type_2": { "type": "object", "example": { "quoteId": "0Q0Kf000000xjXgKAI", "orderId": "801Kf000004FnicIAC", "contacts": { "contactDetails": [ { "type": "shipping", "firstName": "Test", "lastName": "Test", "email": "abc@accen.com", "street": "2900 W PLANO PWKY", "city": "Plano", "state": "TX", "country": "US", "zipCode": "52432-1233", "floor": "1", "room": "2", "additionalNotes": "Hello there " } ] }, "subOrderId": "801Kf000004FnihIAC" }, "required": [ "quoteId", "orderId", "subOrderId", "contacts" ], "properties": { "quoteId": { "type": "string", "example": "878765469hjgfcft678", "minLength": 1 }, "orderId": { "type": "string", "example": "8012f000001MkwKAAS", "minLength": 1 }, "contacts": { "type": "object", "required": [ "contactDetails" ], "properties": { "contactDetails": { "type": "array", "items": { "type": "object", "required": [ "type", "firstName", "lastName", "email", "street", "city", "state", "country", "zipCode" ], "properties": { "type": { "enum": [ "shipping" ], "type": "string" }, "city": { "type": "string", "example": "Plano", "minLength": 1 }, "room": { "type": "string", "example": "2" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 }, "state": { "type": "string", "example": "TX", "minLength": 1 }, "floor": { "type": "string", "example": "1" }, "street": { "type": "string", "example": "2900 W PLANO PWKY", "minLength": 1 }, "country": { "type": "string", "example": "USA", "minLength": 1 }, "zipCode": { "type": "string", "example": "75075-9876", "pattern": "^(\\d{5})||((\\d{5})\\-(\\d{4}))$", "minLength": 5, "maxLength": 10 }, "lastName": { "type": "string", "example": "Test", "minLength": 1 }, "firstName": { "type": "string", "example": "Test", "minLength": 1 }, "additionalNotes": { "type": "string", "example": "Hello" } } } } } }, "subOrderId": { "type": "string", "example": "8012f000001MslxAAC", "minLength": 1 } } }, "billingAccountResponse": { "type": "object", "example": { "billingAccountName": "Test Existing Billing Account", "billingAccountInvoiceNumber": "123456789" }, "required": [ "billingAccountName", "billingAccountInvoiceNumber" ], "properties": { "billingAccountName": { "type": "string", "description": "This field represents the billing account name.", "minLength": 1 }, "billingAccountInvoiceNumber": { "type": "string", "description": "This field represents the billing account invoice number.", "minLength": 1 } } }, "type_post_serviceApptReq": { "type": "object", "properties": { "subOrderId": { "type": "string" }, "serivceAppointmentRequestDate": { "type": "string", "format": "date" } }, "required": [ "subOrderId", "serivceAppointmentRequestDate" ] }, "type_post_serviceApptRes": { "type": "object", "properties": { "availableAppointmentDates": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}$" } }, "required": [ "startDate", "endDate" ] } }, "workOrder": { "type": "object", "properties": { "dispatchSystem": { "type": "string" }, "externalOrderId": { "type": "string" }, "workOrderId": { "type": "string" } }, "required": [ "dispatchSystem", "externalOrderId", "workOrderId" ] } }, "required": [ "availableAppointmentDates", "workOrder" ] }, "type_3": { "type": "object", "example": { "quoteId": "0Q0Kf000000xjXgKAI", "orderId": "801Kf000004FnicIAC", "subOrderId": "801Kf000004FnihIAC", "invoiceNumber": "8310012302858" }, "required": [ "quoteId", "orderId", "subOrderId", "invoiceNumber" ], "properties": { "quoteId": { "type": "string", "example": "0Q023000000n2yx", "minLength": 1 }, "orderId": { "type": "string", "example": "8012f000000rt27AAA", "minLength": 1 }, "subOrderId": { "type": "string", "example": "8012f000000rt2CAAQ", "minLength": 1 }, "invoiceNumber": { "type": "string", "example": "10001982", "minLength": 1 } } }, "type_reqSummary": { "type": "object", "properties": { "orderId": { "type": "string" }, "subOrderId": { "type": "string" }, "toEmail": { "type": "string", "format": "email" }, "ccEmail": { "type": "string", "format": "email" } }, "required": [ "orderId", "subOrderId", "toEmail", "ccEmail" ] }, "type_resSummary": { "type": "object", "properties": { "ContextId": { "type": "string" }, "EmailTo": { "type": "string", "format": "email" }, "ProductName": { "type": "string" }, "SellerTitle": { "type": "string" }, "BusinessName": { "type": "string" }, "EmailCC": { "type": "string", "format": "email" }, "action": { "type": "string" }, "SellerName": { "type": "string" }, "Id": { "type": "integer" }, "flowName": { "type": "string" }, "orderId": { "type": "string" } }, "required": [ "ContextId", "EmailTo", "ProductName", "SellerTitle", "BusinessName", "EmailCC", "action", "SellerName", "Id", "flowName", "orderId" ] }, "type_4": { "type": "object", "example": { "cdg": "000346", "quoteId": "0Q0Kf000000xjXgKAI", "orderId": "801Kf000004FnicIAC", "subOrderId": "801Kf000004FnihIAC" }, "required": [ "quoteId", "orderId", "subOrderId", "cdg" ], "properties": { "cdg": { "type": "string", "example": "000138", "minLength": 1 }, "quoteId": { "type": "string", "example": "0Q023000000n2yx", "minLength": 1 }, "orderId": { "type": "string", "example": "80155000001o9YdAAI", "minLength": 1 }, "subOrderId": { "type": "string", "example": "80155000001o9YiAAI", "minLength": 1 } } }, "type_reqCDG": { "type": "object", "example": { "invoiceNumber": "6677543" }, "required": [ "invoiceNumber" ], "properties": { "invoiceNumber": { "type": "string", "example": "10001982", "minLength": 1 } } }, "type_questions": { "type": "object", "example": { "securityQuestions": "Who is your favorite childhood hero?, What is your favorite restaurant?, Who is your favorite actor?, Who is your favorite singer?" }, "required": [ "securityQuestions" ], "properties": { "securityQuestions": { "type": "string", "example": "Who is your favorite childhood hero?, What is your favorite restaurant?, Who is your favorite actor?, Who is your favorite singer?", "minLength": 1 } } }, "type_newBillingReq": { "type": "object", "example": { "contacts": { "contactDetails": [ { "type": "shipping", "firstName": "Test", "lastName": "Test", "email": "abc@accen.com", "street": "2900 W PLANO PWKY", "city": "Plano", "state": "TX", "country": "US", "zipCode": "52432-1233", "floor": "1", "room": "2", "additionalNotes": "Hello there " } ] }, "orderId": "801J1YAI", "subOrderId": "801YAI", "paperlessBilling": true, "accInformation": { "description": "api", "accountName": "apiBAPI1" }, "cdgDescription": "89", "invoiceAndPurchaseOrderInformation": { "custPurchaseOrderNo": "009", "invoiceDescription": "INVBYU" }, "taxAddress": { "city": "Addison", "state": "IL", "street": "1820 Kings Point Dr S", "zipCode": "60101-1744" } }, "required": [ "contacts", "orderId", "subOrderId", "paperlessBilling", "accInformation", "invoiceAndPurchaseOrderInformation", "taxAddress" ], "properties": { "contacts": { "type": "object", "required": [ "contactDetails" ], "properties": { "contactDetails": { "type": "array", "items": { "type": "object", "required": [ "type", "firstName", "lastName", "email", "street", "city", "state", "country", "zipCode" ], "properties": { "type": { "enum": [ "shipping" ], "type": "string" }, "city": { "type": "string", "example": "Plano", "minLength": 1 }, "room": { "type": "string", "example": "2" }, "email": { "type": "string", "example": "test@test.com", "minLength": 1 }, "state": { "type": "string", "example": "TX", "minLength": 1 }, "floor": { "type": "string", "example": "1" }, "street": { "type": "string", "example": "2900 W PLANO PWKY", "minLength": 1 }, "country": { "type": "string", "example": "USA", "minLength": 1 }, "zipCode": { "type": "string", "example": "75075-9876", "pattern": "^(\\d{5})||((\\d{5})\\-(\\d{4}))$", "minLength": 5, "maxLength": 10 }, "lastName": { "type": "string", "example": "Test", "minLength": 1 }, "firstName": { "type": "string", "example": "Test", "minLength": 1 }, "additionalNotes": { "type": "string", "example": "Hello" } } } } } }, "orderId": { "type": "string", "example": "801J1YAI", "minLength": 1 }, "subOrderId": { "type": "string", "example": "8011YAI", "minLength": 1 }, "paperlessBilling": { "type": "boolean", "example": true }, "accInformation": { "type": "object", "required": [ "description", "accountName" ], "properties": { "description": { "type": "string", "example": "api", "minLength": 1 }, "accountName": { "type": "string", "example": "apiBAPI1", "minLength": 1 } } }, "cdgDescription": { "type": "string", "example": "89", "minLength": 1 }, "invoiceAndPurchaseOrderInformation": { "type": "object", "required": [ "custPurchaseOrderNo", "invoiceDescription" ], "properties": { "custPurchaseOrderNo": { "type": "string", "example": "009", "minLength": 1 }, "invoiceDescription": { "type": "string", "example": "INVBYU", "minLength": 1 } } }, "taxAddress": { "type": "object", "required": [ "city", "state", "street", "zipCode" ], "properties": { "city": { "type": "string", "example": "Addison", "minLength": 1 }, "state": { "type": "string", "example": "IL", "minLength": 1 }, "street": { "type": "string", "example": "1820 Kings Point Dr S", "minLength": 1 }, "zipCode": { "type": "string", "example": "60101-1744", "minLength": 1 } } } } }, "type_newBillingRes": { "type": "object", "example": { "billingAccountId": "001DsBIYAY", "orderId": "80126J1YAI", "subOrderId": "801D26J6YAI" }, "required": [ "billingAccountId", "orderId", "subOrderId" ], "properties": { "billingAccountId": { "type": "string", "example": "001DsBIYAY", "minLength": 1 }, "orderId": { "type": "string", "example": "80126J1YAI", "minLength": 1 }, "subOrderId": { "type": "string", "example": "801D26J6YAI", "minLength": 1 } } }, "type_postBillingReq": { "type": "object", "example": { "contractId": "MSPS00049851SF", "billingAccountName": "801Kf000004FnicIAC", "soc": "F3", "billGroup": "001", "mcn": "TW8157", "subAccountId": "X014TZQM", "subOrderId": "801ZZQ000100LQLb" }, "required": [ "subAccountId", "subOrderId" ], "properties": { "contractId": { "type": "string", "example": "MSPS00049851SF", "minLength": 1 }, "soc": { "type": "string", "example": "F3", "minLength": 1 }, "billingAccountName": { "type": "string", "example": "801Kf000004FnicIAC", "minLength": 1 }, "billGroup": { "type": "string", "example": "001", "minLength": 1 }, "mcn": { "type": "string", "example": "TW8157", "minLength": 1 }, "subAccountId": { "type": "string", "example": "X014TZQM", "minLength": 1 }, "subOrderId": { "type": "string", "example": "8012f000001MslxAAC", "minLength": 1 } } }, "type_getCDG": { "type": "object", "properties": { "searchCDGResponse": { "type": "object", "properties": { "invoiceNumber": { "type": "integer" }, "flowName": { "type": "string" }, "outputValues": { "type": "array", "items": { "type": "object", "properties": { "billingAccountId": { "type": "string" }, "billingAccountName": { "type": "string" }, "cdgId": { "type": "string" }, "cdgName": { "type": "string" }, "cdgDescripton": { "type": "string" } }, "required": [ "billingAccountId", "billingAccountName", "cdgId", "cdgName", "cdgDescripton" ] } } }, "required": [ "invoiceNumber", "flowName", "outputValues" ] } }, "required": [ "searchCDGResponse" ] }, "StandardError": { "type": "object", "title": "Standard Error Response Item", "required": [ "node", "code", "message", "description", "transactionId", "traceId" ], "properties": { "node": { "type": "string", "example": "Store location System API", "description": "API Name" }, "code": { "type": "number", "example": 401, "description": "Status Code" }, "message": { "type": "string", "example": "NOT_AUTHORIZED", "description": "Error Message" }, "traceId": { "type": "string", "example": "712def66-c54a-11ea-87d0-0242ac130003", "description": "Trace ID" }, "description": { "type": "string", "example": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "description": "Error Description" }, "transactionId": { "type": "string", "example": "803ec5202bd54576992d082da70e6338", "description": "Transaction ID" }, "error_context": { "type": "object", "required": [ "time", "type", "category", "payload", "error_identifier", "action" ], "properties": { "time": { "type": "string", "description": "" }, "type": { "enum": [ "DATA ERROR", "SYSTEM ERROR" ], "type": "string", "description": "" }, "action": { "type": "string", "description": "Target system action e.g. create, cancel, update, delete" }, "payload": { "type": "object", "description": "payload that's being sent to the specific target system" }, "category": { "type": "string", "description": "e.g. Billing, Account, Order, Contact" }, "error_identifier": { "type": "string", "description": "Any Identifier" } } } }, "description": "Error Response", "x-amf-examples": { "example_2": { "node": "Store location System API", "code": 405, "message": "METHOD_NOT_ALLOWED", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "DATA ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "example_1": { "node": "Store location System API", "code": 401, "message": "NOT_AUTHORIZED", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "DATA ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "example_0": { "node": "Store location System API", "code": 400, "message": "BAD_REQUEST", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "DATA ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "example_3": { "node": "Store location System API", "code": 415, "message": "UNSUPPORTED_MEDIA_TYPE", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The format problem might be due to the request's indicated Content-Type or Content-Encoding, or as a result of inspecting the data directly.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "DATA ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "amf_example_1": { "node": "Store location System API", "code": 403, "message": "FORBIDDEN", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The server understood the request but refuses to authorize it. The client MAY repeat the request with new or different credentials.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "SYSTEM ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "amf_example_2": { "node": "Store location System API", "code": 404, "message": "RESOURCE_NOT_FOUND", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "DATA ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "amf_example_4": { "node": "Store location System API", "code": 500, "message": "INTERNAL_SERVER_ERROR", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "SYSTEM ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } }, "amf_example_3": { "node": "Store location System API", "code": 406, "message": "NOT_ACCEPTABLE", "traceId": "712def66-c54a-11ea-87d0-0242ac130003", "description": "The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation.", "transactionId": "803ec5202bd54576992d082da70e6338", "error_context": { "time": "2021-07-29T01:51:15.000Z", "type": "SYSTEM ERROR", "action": "create", "payload": {}, "category": "Account", "error_identifier": "123" } } } } } } }