{ "openapi": "3.0.1", "info": { "title": "Contract Service API", "description": "API documentation for Contract Service", "contact": { "name": "Contract MS Support Team", "email": "dl-ContractMS-DL@intl.att.com" }, "version": "1.0" }, "servers": [ { "url": "https://coms.dev.att.com/contract-service", "description": "Generated server url" } ], "tags": [ { "name": "Contract", "description": "Operations related to contract" }, { "name": "Esign", "description": "Operations related to esign" }, { "name": "ABR", "description": "Operations related to ABR" }, { "name": "Pricing-Info", "description": "Operations related to Pricing Info" }, { "name": "IEBUS", "description": "Operations related to IEBUS" }, { "name": "Contract-Details", "description": "Operation for getting contract details" }, { "name": "Ping", "description": "Operations related to Ping" } ], "paths": { "/update-abrContractEvent/docViewerEvent/{cnum}": { "post": { "tags": [ "ABR" ], "summary": "Set ABR Contract Event", "description": "This API sets the ABR contract event with the given cnum", "operationId": "setAbrContractEvent", "parameters": [ { "name": "cnum", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Contract event set successfully", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid cnum provided", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/status/contract-status/publish/{transaction-id}": { "post": { "tags": [ "Contract" ], "summary": "Publish Contract Status for IOT", "description": "This Api is used to publish the Contract Status Event to iebus for IOT", "operationId": "updateContractStatus", "parameters": [ { "name": "fromSystem", "in": "header", "description": "From System", "required": true, "schema": { "type": "string" } }, { "name": "transaction-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status Publish Successful", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/status/contract-status/publish-docViewerEvent/{cnum}": { "post": { "tags": [ "Contract" ], "summary": "Publish Doc Viewer Event for IOT or ADOPT", "description": "This API is used to publish the Doc Viewer Event to iebus for IOT or to cbus for ADOPT, depending on the contract type and OrchestrationCodeId", "operationId": "publishDocViewerEvent", "parameters": [ { "name": "cnum", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Doc Viewer Event Publish Successful", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/publish-message-topic": { "get": { "tags": [ "IEBUS" ], "summary": "Getting message topics", "description": "This Api is used for getting message from topic", "operationId": "receiveMessageDetails", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "IEBUS" ], "summary": "Publish message topics", "description": "This Api is used for publishing message to topic", "operationId": "processMessageDetails", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractStatusEvent" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/processMessageDetails": { "post": { "tags": [ "ABR" ], "summary": "Process Message Details", "description": "This API processes message details from the message broker", "operationId": "processMessageDetails_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceContractStatusEvent" } } }, "required": true }, "responses": { "200": { "description": "Message processed successfully", "content": { "*/*": { "schema": { "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/pricing-info-details": { "post": { "tags": [ "Pricing-Info" ], "summary": "responds with getPricingInfo details", "description": "Currently BC is using this API to get the pricing information for a product.", "operationId": "getPricingInfo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceCatalogRequest" } } }, "required": true }, "responses": { "200": { "description": "Fetched Pricing Info details successfully", "content": { "application/json": { "schema": { "type": "string" } } } }, "300": { "description": "Data Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request : Mandatory Field Missing", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication failed or was not provided", "content": { "application/json": { "schema": { "type": "string" } } } }, "402": { "description": "Access to a specific resource is not allowed for this API user.", "content": { "application/json": { "schema": { "type": "string" } } } }, "403": { "description": "Invalid Data in Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "405": { "description": "Requested Method not Allowed", "content": { "application/json": { "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable format", "content": { "application/json": { "schema": { "type": "string" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "type": "string" } } } }, "420": { "description": "Invalid Data in Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "The server encountered and internal error or time out; please retry", "content": { "application/json": { "schema": { "type": "string" } } } }, "501": { "description": "The server does not recognize the request", "content": { "application/json": { "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable - The server is currently unable to receive requests; please retry", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/esign/{source-contract-group-id}/update-esign-status": { "post": { "tags": [ "Esign" ], "summary": "Update Esign Status", "description": "This Api is used for updating status for esign", "operationId": "processStatusNotification", "parameters": [ { "name": "source-contract-group-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractStatusNotificationRequest" } } }, "required": true }, "responses": { "200": { "description": "Update Esign Successful", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractStatusNotificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "object" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/create-contract": { "post": { "tags": [ "Contract" ], "summary": "Generate Contract", "description": "This Api is used to generate contract for the given offerName and fromSystem", "operationId": "processContractGenerationRequest", "parameters": [ { "name": "offerName", "in": "header", "description": "Offer Name", "required": true, "schema": { "type": "string" } }, { "name": "fromSystem", "in": "header", "description": "From System", "required": true, "schema": { "type": "string" } }, { "name": "requestType", "in": "header", "description": "Request Type", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractGenerationRequest" } } }, "required": true }, "responses": { "200": { "description": "Contract Generate Successful", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractGenerationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/contract/signature/{contract-id}": { "post": { "tags": [ "Esign" ], "summary": "Send Contract to Esign", "description": "This Api is used for sending contract to Esign", "operationId": "sendContractToEsign", "parameters": [ { "name": "contract-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully sent contract to Esign", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractSignatureResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractSignatureResponse" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractSignatureResponse" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractSignatureResponse" } } } } } } }, "/contract-details": { "post": { "tags": [ "Contract-Details" ], "summary": "Retrieve the details of the contract", "description": "Retrieve the details of the contract", "operationId": "contractDetails", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDetailsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/consume-message-topic": { "post": { "tags": [ "IEBUS" ], "summary": "Consume message topics", "description": "This Api is used for consuming message from topic", "operationId": "consumeMessageAndProcessForInventory", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "500": { "description": "Unexpected Runtime error" }, "503": { "description": "Service not available" } } } }, "/validateInterface": { "get": { "tags": [ "validateInterface" ], "summary": "validateInterface asap", "description": "validateInterface asap to check if service is up", "operationId": "validateInterface", "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "404": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/usage-rules/configurations": { "get": { "tags": [ "Contract-Builder" ], "summary": "Retrieves all usage rule names and their default configurations", "description": "Returns all usage rule names and their default configurations", "operationId": "findUsageRuleConfigurations", "responses": { "200": { "description": "Retrieved all usage rule names and their default configurations successfully", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ClauseConfiguration" } } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "example": { "message": "An unexpected error occurred. Please try again later." } } } } } } }, "/status/contract-status/{transaction-id}": { "get": { "tags": [ "Contract" ], "summary": "Get Contract Details", "description": "This Api is used to get contract details by transactionId", "operationId": "processContractGenerationStatus", "parameters": [ { "name": "offerName", "in": "header", "description": "Offer Name", "required": true, "schema": { "type": "string" } }, { "name": "fromSystem", "in": "header", "description": "From System", "required": true, "schema": { "type": "string" } }, { "name": "transaction-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "downloadDocApi", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get Contract Successful", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContractGenerationStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } }, "503": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/ping": { "get": { "tags": [ "Ping" ], "summary": "Ping api", "description": "Ping api to check if service is up", "operationId": "getPing", "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "string" } } } }, "404": { "description": "Service not available", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/file/view/{name}": { "get": { "tags": [ "Contract" ], "summary": "view file", "description": "To view the contract with .pdf extension", "operationId": "viewFile", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File retrieve Successful", "content": { "application/octet-stream": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/octet-stream": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/octet-stream": { "schema": { "type": "object" } } } }, "503": { "description": "Service not available", "content": { "application/octet-stream": { "schema": { "type": "object" } } } } } } }, "/file/download/{name}": { "get": { "tags": [ "Contract" ], "summary": "Download contract", "description": "To download the contract with both .pdf and .doc extension", "operationId": "downloadFile", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File downloading Successful", "content": { "application/octet-stream": { "schema": { "type": "object" } }, "application/pdf": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/octet-stream": { "schema": { "type": "object" } }, "application/pdf": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/octet-stream": { "schema": { "type": "object" } }, "application/pdf": { "schema": { "type": "object" } } } }, "503": { "description": "Service not available", "content": { "application/octet-stream": { "schema": { "type": "object" } }, "application/pdf": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "ContractStatusEvent": { "type": "object", "properties": { "transactionID": { "type": "string" }, "alias": { "type": "string" }, "fromSystem": { "type": "string" }, "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "maNumber": { "type": "string" }, "pricePlanInstances": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlanInstance" } }, "esignId": { "type": "integer", "format": "int32" } } }, "Document": { "type": "object", "properties": { "contractUrl": { "type": "string" }, "contractFileName": { "type": "string" }, "contractFileType": { "type": "string" }, "contractFileData": { "type": "string" } } }, "PricePlanInstance": { "type": "object", "properties": { "contractSolutionNumber": { "type": "string" }, "attContractId": { "type": "string" }, "contractUrl": { "type": "string" }, "pricePlanId": { "type": "string" }, "agreementId": { "type": "string" }, "document": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } }, "InterfaceContractStatusEvent": { "type": "object", "properties": { "transactionID": { "type": "string" }, "fromSystem": { "type": "string" }, "messageType": { "type": "string" }, "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "attContractId": { "type": "string" }, "contractSolutionId": { "type": "string" }, "typeOfContractActivity": { "type": "string" }, "contractEffectiveDate": { "type": "string", "format": "date-time" }, "originalContractId": { "type": "string" } } }, "PriceCatalogRequest": { "type": "object", "properties": { "offerId": { "type": "string" }, "productId": { "type": "string" }, "pricePlanId": { "type": "string" }, "pricePlanVersion": { "type": "integer", "format": "int32" }, "ratePlanId": { "type": "string" }, "ratePlanVersion": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "dataType": { "type": "string", "enum": [ "DiscountOnly", "PriceOnly", "DiscountAndPrice" ] }, "persona": { "type": "string" }, "offerName": { "type": "string" }, "productName": { "type": "string" }, "serviceType": { "type": "string" }, "flagMISE": { "type": "string" }, "validationSuccess": { "type": "boolean" }, "pricePlanName": { "type": "string" } } }, "AnnotatedContract": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileType": { "type": "string" }, "fileData": { "type": "string" } } }, "ContractDocumentStatusDto": { "type": "object", "properties": { "contractDocumentStatus": { "type": "string" }, "actionPerformedUtcDate": { "type": "string", "format": "date-time" }, "singleSignatureCoverPageExist": { "type": "boolean" }, "pcsHomerNumber": { "type": "string" }, "creditCheckProcessNumber": { "type": "string" }, "segment": { "type": "string" }, "sourceContractIdentifier": { "type": "string" }, "commentList": { "type": "array", "items": { "type": "string" } }, "signedUtcDate": { "type": "string", "format": "date-time" }, "signerPerson": { "$ref": "#/components/schemas/SignerPerson" }, "annotatedContract": { "$ref": "#/components/schemas/AnnotatedContract" }, "signatureRecord": { "$ref": "#/components/schemas/SignatureRecord" }, "signatureType": { "type": "string" }, "autoCounterSigned": { "type": "boolean" }, "preSigned": { "type": "boolean" }, "ecatsId": { "type": "string" } } }, "ContractStatusNotificationRequest": { "type": "object", "properties": { "sourceSystemIdentifier": { "type": "string" }, "isGroupStatus": { "type": "boolean" }, "contractDocumentStatus": { "$ref": "#/components/schemas/ContractDocumentStatusDto" }, "groupStatus": { "type": "boolean", "writeOnly": true } } }, "SignatureRecord": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileType": { "type": "string" }, "fileData": { "type": "string" } } }, "SignerPerson": { "type": "object", "properties": { "uniquePersonIdentifier": { "type": "string" }, "signatureName": { "type": "string" }, "title": { "type": "string" }, "email": { "type": "string" }, "foreignIdentifier": { "type": "string" } } }, "ContractStatusNotificationResponse": { "type": "object", "properties": { "errorCode": { "type": "string" }, "errorMsg": { "type": "string" } } }, "Account": { "type": "object", "properties": { "accountRowId": { "type": "string" }, "ccId": { "type": "string" }, "marketStrata": { "type": "string" }, "customerType": { "type": "string" }, "customerLegalInfo": { "$ref": "#/components/schemas/CustomerLegalInfo" }, "creditCheckApprovalNumber": { "type": "string" }, "saartAccountId": { "type": "string" }, "marketSegment": { "type": "string" }, "creditCheckId": { "type": "string" }, "locationId": { "type": "string" }, "federalTaxId": { "type": "string" }, "bureauLinesApproved": { "type": "string" }, "creditApplicationID": { "type": "string" }, "creditDecision": { "type": "string" }, "depositAmount": { "type": "string" }, "casApplicationNumber": { "type": "string" }, "unifiedCreditTransactionId": { "type": "string" }, "svid": { "type": "string" }, "absAccountOrgSegment": { "type": "string" }, "coId": { "type": "string" }, "l2LocationId": { "type": "string" } } }, "Component": { "type": "object", "properties": { "cpcComponentCodeId": { "type": "string" }, "componentCodeName": { "type": "string" }, "componentId": { "type": "string" }, "designDetails": { "type": "array", "items": { "$ref": "#/components/schemas/DesignDetail" } }, "parentComponentId": { "type": "string" }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" } } } }, "ContactInfo": { "type": "object", "properties": { "contactType": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "agentCode": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "salesStrata": { "type": "string" }, "salutation": { "type": "string" }, "salesManager": { "type": "string" }, "scvpName": { "type": "string" }, "salesRegion": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "stateProvince": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "extension": { "type": "string" }, "altPhone": { "type": "string" }, "email": { "type": "string" }, "fax": { "type": "string" }, "pager": { "type": "string" }, "pin": { "type": "string" }, "attuid": { "type": "string" }, "adminId": { "type": "string" } } }, "ContractGenerationRequest": { "type": "object", "properties": { "productName": { "type": "string" }, "solution": { "$ref": "#/components/schemas/Solution" }, "pricingScenario": { "$ref": "#/components/schemas/PricingScenario" }, "networkDesign": { "type": "array", "properties": { "empty": { "type": "boolean" }, "first": { "$ref": "#/components/schemas/NetworkDesign" }, "last": { "$ref": "#/components/schemas/NetworkDesign" } }, "items": { "$ref": "#/components/schemas/NetworkDesign" } }, "installationSites": { "type": "array", "items": { "$ref": "#/components/schemas/InstallationSites" } }, "fromSystem": { "type": "string" }, "requestType": { "type": "string" }, "callBackUrl": { "type": "string" }, "jsonRequestStr": { "type": "string" }, "attSolutionWebserviceID": { "type": "integer", "format": "int32" }, "transactionID": { "type": "string" }, "solutionID": { "type": "integer", "format": "int32" }, "pricingScenarioID": { "type": "integer", "format": "int32" }, "globalCustomerID": { "type": "integer", "format": "int32" } } }, "CustomerLegalInfo": { "type": "object", "properties": { "customerLegalName": { "type": "string" }, "streetAddress1": { "type": "string" }, "streetAddress2": { "type": "string" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "country": { "type": "string" }, "countryName": { "type": "string" }, "zipOrPostalCode": { "type": "string" }, "telephone": { "type": "string" }, "buildingName": { "type": "string" }, "houseNumber": { "type": "string" } } }, "Design": { "type": "object", "properties": { "component": { "type": "array", "items": { "$ref": "#/components/schemas/Component" } } } }, "DesignDetail": { "type": "object", "properties": { "cpcUdfId": { "type": "string" }, "udfAttributeId": { "type": "array", "items": { "type": "string" } }, "udfAttributeText": { "type": "array", "items": { "type": "string" } } } }, "FeatureOnOff": { "type": "object", "properties": { "featureOnOffName": { "type": "string" }, "featureOnOffValue": { "type": "string" } } }, "InstallationSites": { "type": "object", "properties": { "siteId": { "type": "string" }, "streetAddress": { "type": "string" }, "streetAddress2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zip": { "type": "string" }, "lata": { "type": "integer", "format": "int64" }, "npanxx": { "type": "integer", "format": "int64" }, "room": { "type": "string" }, "floor": { "type": "string" }, "building": { "type": "string" }, "clli": { "type": "string" }, "design": { "$ref": "#/components/schemas/Design" }, "locationType": { "type": "string" }, "quoteId": { "type": "string" }, "meetMeRoom": { "type": "string" }, "clliCity": { "type": "string" }, "clliState": { "type": "string" }, "swcClliCode": { "type": "string" }, "asrNumber": { "type": "string" }, "accessArrangement": { "type": "string" }, "accessPriceGroup": { "type": "string" }, "jurisdiction": { "type": "string" }, "geographicLocation": { "type": "string" }, "portSpeed": { "type": "string" }, "accessMileageGroup": { "type": "string" }, "accessMileage": { "type": "string" }, "cirSpeed": { "type": "string" }, "classOfService": { "type": "string" }, "leadStateInd": { "type": "string" } } }, "NetworkDesign": { "type": "object", "properties": { "designComponent": { "type": "string" }, "designComponentQuantity": { "type": "string" }, "component": { "type": "array", "items": { "$ref": "#/components/schemas/Component" } } } }, "PricingScenario": { "type": "object", "properties": { "pricePlanInstance": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlanInstance" } } } }, "Reference": { "type": "object", "properties": { "referenceType": { "type": "string" }, "referenceId": { "type": "string" } } }, "Solution": { "type": "object", "properties": { "solutionId": { "type": "string" }, "isOnNet": { "type": "string" }, "alias": { "type": "string" }, "autoSignature": { "type": "integer", "format": "int32" }, "opportunityId": { "type": "string" }, "account": { "$ref": "#/components/schemas/Account" }, "gcpSolutionId": { "type": "string" }, "preQualNo": { "type": "string" }, "supportRequestID": { "type": "string" }, "supportRequestType": { "type": "string" }, "supportRequestReason": { "type": "string" }, "hasContractNegotiationContactUpdate": { "type": "string" }, "hasContractNegotiationPriceUpdate": { "type": "string" }, "hasCustomLanguageRequest": { "type": "string" }, "hasCustomPricingRequest": { "type": "string" }, "hasCustomDiscount": { "type": "string" }, "hasCustomDesign": { "type": "string" }, "rateLetterExpirationDate": { "type": "string", "format": "date-time" }, "riderName": { "type": "string" }, "riderOption": { "type": "string" }, "serviceCommanceDate": { "type": "string", "format": "date-time" }, "isPreviewRequest": { "type": "string" }, "isContractCustomerFacing": { "type": "string" }, "termsAndConditionsFlag": { "type": "string" }, "existingSR": { "type": "string" }, "affiliateName": { "type": "string" }, "isCoversheetUpdate": { "type": "string" }, "customContractNumber": { "type": "string" }, "customContractEffectivedate": { "type": "string" }, "opportunitySegment": { "type": "string" }, "opportunityDivision": { "type": "string" }, "dba": { "type": "string" }, "opportunityName": { "type": "string" }, "billerid": { "type": "string" }, "typeofaddendum": { "type": "string" }, "isCountryadded": { "type": "string" }, "updateType": { "type": "string" }, "abnAttachmentType": { "type": "string" }, "cpeType": { "type": "string" }, "overrideIndicator": { "type": "string" }, "authorityLevel": { "type": "string" }, "microServiceInd": { "type": "string" }, "ebmindicator": { "type": "string" }, "hasErateDiscountPriceUpdate": { "type": "string" }, "eisFlag": { "type": "string" }, "featureOnOff": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureOnOff" } }, "isShadowContract": { "type": "string" }, "misehighspeedonoff": { "type": "string" }, "sellerLocation": { "type": "string" }, "rateLetterApprovalNumber": { "type": "string" }, "rateLetterVersion": { "type": "string" }, "microServiceABRInd": { "type": "string" }, "modularContractProduct": { "type": "string" }, "sourceSystem": { "type": "string" }, "leadDesignId": { "type": "integer", "format": "int64" }, "nonStandardTc": { "type": "string" }, "confirmSerOrderLetter": { "type": "string" }, "csoReferenceNo": { "type": "string" }, "tariffType": { "type": "string" }, "jurisdiction": { "type": "string" }, "migrationInd": { "type": "string" }, "gssoUid": { "type": "string" }, "npwUid": { "type": "string" }, "salesReady": { "type": "string" }, "rateLetterCirInd": { "type": "string" }, "rateLetterDiscType": { "type": "string" }, "riderId": { "type": "integer", "format": "int64" }, "circuitQuantity": { "type": "string" }, "rateLetterDealNumber": { "type": "string" }, "rateletterRevisionNumber": { "type": "string" }, "pricerAttuid": { "type": "string" }, "isAutoRenewal": { "type": "string" }, "modelNumber": { "type": "string" }, "contractFlowType": { "type": "string" }, "childProduct": { "type": "string" }, "productFlavour": { "type": "string" }, "vpnAssociationType": { "type": "string" }, "createCIAAorTSA": { "type": "string" }, "includeContractDocument": { "type": "string" }, "sendToEsign": { "type": "string" }, "isUpdate": { "type": "string" }, "contractActionType": { "type": "string" }, "sourceContractGroup": { "type": "string" }, "moduleCodeDescription": { "type": "string" }, "attContractId": { "type": "string" }, "contractSolutionNumber": { "type": "string" }, "responseTypeCode": { "type": "string" }, "cuaDate": { "type": "string" }, "allowVoiceSignature": { "type": "string" }, "allowFaxSignature": { "type": "string" }, "customerCcEmail": { "type": "string" }, "attCcEmail": { "type": "string" }, "customerEmailNotes": { "type": "string" }, "lanIpBillingInd": { "type": "string" }, "zoneEffectiveDate": { "type": "string", "format": "date-time" }, "creditCheckExpirationDate": { "type": "string", "format": "date-time" }, "contractCallBackUrl": { "type": "string" }, "isSubRate": { "type": "string" }, "forwardAlternateSalesRepIndicator": { "type": "string" }, "altSalesRepresentationEmail": { "type": "string" }, "creditCheckApprovalNumber": { "type": "string" }, "allowMerge": { "type": "string" }, "contractExpirationOffset": { "type": "integer", "format": "int32" }, "clsrNotes": { "type": "string" }, "loatype": { "type": "string" }, "iciflagValue": { "type": "string" }, "eRate": { "type": "string" }, "mContractType": { "type": "string" }, "iSExpress": { "type": "string" }, "iSLargeSite": { "type": "string" }, "WebSignature": { "type": "string" } } }, "ContractGenerationResponse": { "type": "object", "properties": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "eSignId": { "type": "integer", "format": "int32" } } }, "ContractSignatureResponse": { "type": "object", "properties": { "esignRequestId": { "type": "string" }, "status": { "type": "string" }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" } } }, "ContractDetailsRequest": { "type": "object", "properties": { "attContractNumber": { "type": "string" }, "contractSolutionNumber": { "type": "string" }, "attContractSolutionNumber": { "type": "string" }, "service": { "type": "string" }, "sourceSystemId": { "type": "string" }, "offerId": { "type": "array", "items": { "type": "string" } }, "contractSubType": { "type": "string" }, "contractStatus": { "type": "string" }, "customerSignedDate": { "type": "string", "format": "date-time" }, "counterSignedDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "ecrmOpportunityId": { "type": "string" }, "customerLegalName": { "type": "string" }, "contractGroupId": { "type": "string" }, "contractType": { "type": "string" }, "typeOfContractActivity": { "type": "string" }, "typeOfAddendum": { "type": "string" }, "docViewerId": { "type": "integer", "format": "int64" }, "docViewerLink": { "type": "string" }, "multiHierarchyInd": { "type": "string" }, "partnerType": { "type": "string" } } }, "CommitmentInstance": { "type": "object", "properties": { "marcByYear": { "type": "array", "items": { "$ref": "#/components/schemas/MarcByYear" } }, "bundledMarc": { "type": "string" } } }, "ContractDetail": { "type": "object", "properties": { "contractInfo": { "$ref": "#/components/schemas/ContractInfo" }, "opportunity": { "$ref": "#/components/schemas/Opportunity" }, "pricingScenario": { "$ref": "#/components/schemas/PricingScenario" } } }, "ContractDetailsResponse": { "type": "object", "properties": { "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "contractDetail": { "type": "array", "items": { "$ref": "#/components/schemas/ContractDetail" } } } }, "ContractInfo": { "type": "object", "properties": { "contractId": { "type": "string" }, "attContractNumber": { "type": "string" }, "attContractSolutionNumber": { "type": "string" }, "contractSubType": { "type": "string" }, "typeOfContractActivity": { "type": "string" }, "typeOfContract": { "type": "string" }, "hasNonStandardContractLanguage": { "type": "string" }, "marketStrata": { "type": "string" }, "documentUrl": { "type": "string" }, "legalEntityCode": { "type": "string" }, "contractEndDate": { "type": "string", "format": "date-time" }, "customerSignedDate": { "type": "string", "format": "date-time" }, "counterSignedDate": { "type": "string", "format": "date-time" }, "termsAndConditionsFlag": { "type": "string" }, "addCountryInd": { "type": "string" }, "contractTerm": { "type": "string" }, "contractTermExtension": { "type": "string" }, "contractTermReduction": { "type": "string" }, "contractEffDate": { "type": "string", "format": "date-time" }, "contractRevenueCommitment": { "type": "string" }, "maNumber": { "type": "string" }, "docviewerID": { "type": "string" }, "coterminousFlag": { "type": "string" }, "bundledMarcFlag": { "type": "string" }, "bundledServiceName": { "type": "string" }, "replacedContract": { "type": "array", "items": { "$ref": "#/components/schemas/ReplacedContract" } }, "commitmentInstance": { "$ref": "#/components/schemas/CommitmentInstance" }, "customerDetail": { "$ref": "#/components/schemas/CustomerDetail" }, "contactInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInfo" } } } }, "CustomerDetail": { "type": "object", "properties": { "customerNumber": { "type": "string" }, "customerName": { "type": "string" }, "streetAddress1": { "type": "string" }, "streetAddress2": { "type": "string" }, "streetAddress3": { "type": "string" }, "streetAddress4": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "province": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "buildingName": { "type": "string" }, "houseNumber": { "type": "string" }, "telephoneNumber": { "type": "string" } } }, "MarcByYear": { "type": "object", "properties": { "marcYear": { "type": "string" }, "minAnnualRevCommitment": { "type": "string" } } }, "Opportunity": { "type": "object", "properties": { "erateIndicator": { "type": "string" } } }, "ReplacedContract": { "type": "object", "properties": { "replacedContractNumber": { "type": "string" }, "service": { "type": "string" } } }, "BookmarkMapping": { "type": "object", "properties": { "bookmarkName": { "type": "string" }, "renderer": { "type": "string" }, "rendererConfiguration": { "type": "string" } } }, "ClauseConfiguration": { "type": "object", "properties": { "usageRuleServiceName": { "type": "string" }, "dataTableClause": { "type": "boolean" }, "mergeColumns": { "type": "string" }, "mergeRows": { "type": "string" }, "textToHyperlinks": { "type": "boolean" }, "evaluateBindingVariables": { "type": "boolean" }, "dataTableBookmarkName": { "type": "string" }, "mailMergeTableName": { "type": "string" }, "mailMergeTableTitle": { "type": "string" }, "mailMergeDataSource": { "type": "string" }, "mailMergeTableCount": { "type": "integer", "format": "int32" }, "insertSectionBreakAbove": { "type": "boolean" }, "appendSectionBreak": { "type": "boolean" }, "appendPageBreak": { "type": "boolean" }, "topMargin": { "type": "string" }, "bottomMargin": { "type": "string" }, "leftMargin": { "type": "string" }, "rightMargin": { "type": "string" }, "attributes": { "type": "string" }, "bookmarkMappingList": { "type": "array", "items": { "$ref": "#/components/schemas/BookmarkMapping" } }, "dataConfiguration": { "type": "string" }, "mergeRowIndexes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "mergeColumnIndexes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "attributeList": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContractGenerationStatusResponse": { "type": "object", "properties": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "solutionId": { "type": "string" }, "pricePlanInstances": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlanInstance" } }, "pricingScenarioId": { "type": "string" }, "loaNumber": { "type": "string" }, "maNumber": { "type": "string" }, "eSignId": { "type": "integer", "format": "int32" } } } } } }