{ "openapi": "3.0.1", "info": { "title": "OpenAPI definition", "version": "v0" }, "servers": [ { "url": "https://coms.dev.att.com/contract-inventory", "description": "Generated server url" } ], "paths": { "/cache/{cnum}": { "put": { "tags": [ "cache" ], "summary": "Create JSON cache", "description": "Create JSON cache for the given contract number", "operationId": "createJsonCache", "parameters": [ { "name": "cnum", "in": "path", "description": "Contract number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-soc-rate": { "post": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "SOCRates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } } } } }, "/contract-info": { "post": { "tags": [ "contract-info-controller" ], "summary": "Retrieves the customer contract from inventory", "description": "Returns the customer contract and its related information", "operationId": "createContractInfoRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInfoResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInfoResponse" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInfoResponse" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInfoResponse" } } } } } } }, "/contract-details": { "post": { "tags": [ "contract" ], "summary": "Get contract inventory details", "description": "Response ok or error message", "operationId": "getContractDetails", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDetailRequest" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-design-price": { "post": { "tags": [ "contract" ], "summary": "Get contract price and features", "description": "Response ok or error message", "operationId": "priceAndFeaturesRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractPriceAndFeatures" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractPriceAndFeatures" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-contact": { "post": { "tags": [ "contract-contact-controller" ], "summary": "Returns the customer contact and its related information", "description": "Retrieves the contact from contract inventory", "operationId": "ContractContactRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractContact" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractContact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractContact" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractContact" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractContact" } } } } } } }, "/contract-cdr": { "post": { "tags": [ "cdr-contract-controller" ], "summary": "Retrieves the customer contract from inventory", "description": "Retrieves the contact from inventory service", "operationId": "ContractContactRequest_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractResponse" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractResponse" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractResponse" } } } } } } }, "/contract-avpn-details": { "post": { "tags": [ "contract" ], "summary": "Get contract price and features", "description": "Response ok or error message", "operationId": "createCDRContractInventoryDetails", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractDetailsRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractDetailsResponse" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractDetailsResponse" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CDRContractDetailsResponse" } } } } } } }, "/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" } } } } } } }, "/contract-soc-rate/{offer-name}/{product-name}": { "get": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "getSOCRates", "parameters": [ { "name": "offer-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product-name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-soc-rate/{offer-name}/{product-name}/{att-contract-id}/{rate-satablitiy-date}/{price-plan-id}/{rate-plan-id}": { "get": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "getSOCRates_1", "parameters": [ { "name": "offer-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "att-contract-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rate-satablitiy-date", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "price-plan-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rate-plan-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-soc-rate/{offer-name}/{product-name}/{att-contract-id}/{rate-satablitiy-date}": { "get": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "getSOCRates_2", "parameters": [ { "name": "offer-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "att-contract-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rate-satablitiy-date", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-soc-rate/{offer-name}/{product-name}/{att-contract-id}/{rate-satablitiy-date}/{price-plan-id}": { "get": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "getSOCRates_3", "parameters": [ { "name": "offer-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "att-contract-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rate-satablitiy-date", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "price-plan-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-soc-rate/{offer-name}/{product-name}/{att-contract-id}": { "get": { "tags": [ "soc-rates-controller" ], "summary": "Returns detailed information about SOCRates", "description": "Retrieve the details of the SOCRates", "operationId": "getSOCRates_4", "parameters": [ { "name": "offer-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "att-contract-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SOCRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Service not available", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Unexpected Runtime error", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-sdn/{cnum}/{tier}/{lns}": { "get": { "tags": [ "contract-sdn" ], "summary": "Get SDN details", "description": "Response ok or error message", "operationId": "findByCnum", "parameters": [ { "name": "cnum", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lns", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-sdn/{cnum}": { "get": { "tags": [ "contract-sdn" ], "summary": "Get SDN details", "description": "Response ok or error message", "operationId": "findByCnum_1", "parameters": [ { "name": "cnum", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-sdn/{cnum}/{tier}": { "get": { "tags": [ "contract-sdn" ], "summary": "Get SDN details", "description": "Response ok or error message", "operationId": "findByCnum_2", "parameters": [ { "name": "cnum", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/contract-data": { "get": { "tags": [ "contract-data" ], "summary": "Get Contract Data", "description": "Response ok or error message", "operationId": "getContractData", "parameters": [ { "name": "cnum", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "SOCRatesRequest": { "type": "object", "properties": { "offerName": { "type": "string" }, "productName": { "type": "string" }, "attContractId": { "type": "string" } } }, "Biller": { "type": "object", "properties": { "billerCode": { "type": "string" }, "billerName": { "type": "string" }, "rateIdExternal": { "type": "string" } } }, "Contact": { "type": "object", "properties": { "contactType": { "type": "string" }, "endCustomerName": { "type": "string" }, "streetAddress": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zip": { "type": "string" } } }, "Discount": { "type": "object", "properties": { "discountIdInternal": { "type": "string" }, "discountIdExternal": { "type": "string" }, "discountId": { "type": "string" }, "discountVersion": { "type": "string" }, "parentDiscountIdInternal": { "type": "string" }, "parentDiscountIdExternal": { "type": "string" }, "parentDiscountId": { "type": "string" }, "parentDiscountVersion": { "type": "string" }, "discountDescription": { "type": "string" }, "discountDisplay": { "type": "string" }, "discountType": { "type": "string" }, "replicateDiscountId": { "type": "string" }, "discountPercentage": { "type": "string" }, "componentGroupCategory": { "type": "string" }, "compGrpCatDispSeq": { "type": "string" }, "discountTypeCode": { "type": "string" }, "discountCategory": { "type": "string" }, "discountGroup": { "type": "string" }, "displayDiscountCategory": { "type": "string" }, "displayDiscountCatSequence": { "type": "string" }, "displayDiscountSequence": { "type": "string" }, "ratePlanIdInternal": { "type": "string" }, "ratePlanIdExternal": { "type": "string" }, "ratePlanId": { "type": "string" }, "toCountryName": { "type": "string" }, "discountLevel": { "type": "string" }, "discountEffectiveDate": { "type": "string", "format": "date-time" }, "discountEndDate": { "type": "string", "format": "date-time" }, "isoCountryCode": { "type": "string" }, "isoCurrencyCode": { "type": "string" }, "promotionid": { "type": "string" }, "discountStatus": { "type": "string" }, "discountRange": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountRange" } }, "componentGroupCategoryDisplaySequence": { "type": "string" } } }, "Discount2RateXref": { "type": "object", "properties": { "discountIdInternal": { "type": "string" }, "discountIdExternal": { "type": "string" }, "discountID": { "type": "string" }, "discountId": { "type": "integer", "format": "int32" }, "scheduleVariableName": { "type": "string" }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/RateReference" } } } }, "DiscountRange": { "type": "object", "properties": { "discountRangeID": { "type": "string" }, "discountRangeName": { "type": "string" }, "minAnnualRevCommitment": { "type": "string" }, "maxAnnualRevCommitment": { "type": "string" }, "term": { "type": "integer", "format": "int32" }, "authorityLevel": { "type": "string" }, "minAmount": { "type": "integer", "format": "int32" }, "maxAmount": { "type": "integer", "format": "int32" }, "defaultDiscountPercentage": { "type": "integer", "format": "int32" }, "incrementDiscountPercentage": { "type": "integer", "format": "int32" }, "contractedDiscountPercentage": { "type": "integer", "format": "int32" }, "nod": { "type": "string" }, "installOption": { "type": "string" }, "minQuantity": { "type": "integer", "format": "int32" }, "maxQuantity": { "type": "integer", "format": "int32" } } }, "Esign": { "type": "object", "properties": { "hasNonStandardContractLanguage": { "type": "string" }, "hasNonStandardPricing": { "type": "string" } } }, "FeatureOnOFF": { "type": "object", "properties": { "featureOnOffName": { "type": "string" }, "featureOnOffValue": { "type": "string" } } }, "Marc": { "type": "object", "properties": { "typeofMarcCommitment": { "type": "string" }, "minAnnualRevCommitment": { "type": "string" }, "marcByYear": { "type": "array", "items": { "$ref": "#/components/schemas/MarcByYear" } } } }, "MarcByYear": { "type": "object", "properties": { "commitmentYear": { "type": "string" }, "commitmentAmount": { "type": "string" }, "commitmentTerm": { "type": "integer", "format": "int32" }, "extENDTerm": { "type": "integer", "format": "int32" }, "coterminousTermDate": { "type": "string", "format": "date-time" } } }, "PricePlan": { "type": "object", "properties": { "pricePlanIdInternal": { "type": "string" }, "pricePlanIdExternal": { "type": "string" }, "pricePlanDescription": { "type": "string" }, "pricePlanId": { "type": "string" }, "pricePlanVersion": { "type": "integer", "format": "int32" }, "billingPricePlanId": { "type": "string" }, "pricePlanName": { "type": "string" }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Discount" } } } }, "PricePlan2RatePlan": { "type": "object", "properties": { "pricePlanIdInternal": { "type": "string" }, "pricePlanIdExternal": { "type": "string" }, "pricePlanId": { "type": "string" }, "ratePlanIdInternal": { "type": "string" }, "ratePlanIdExternal": { "type": "string" }, "ratePlanId": { "type": "string" } } }, "Pricing": { "type": "object", "properties": { "offerId": { "type": "integer", "format": "int32" }, "offerVersion": { "type": "string" }, "offerName": { "type": "string" }, "productId": { "type": "integer", "format": "int64" }, "productName": { "type": "string" }, "ratesPlan": { "type": "array", "items": { "$ref": "#/components/schemas/RatesPlan" } }, "pricePlan": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlan" } }, "pricePlan2RatePlan": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlan2RatePlan" } }, "discount2rateXrefs": { "type": "array", "items": { "$ref": "#/components/schemas/Discount2RateXref" } } } }, "Rate": { "type": "object", "properties": { "rateIdInternal": { "type": "string" }, "rateIdExternal": { "type": "string" }, "rateId": { "type": "string" }, "rateVersion": { "type": "string" }, "rateDescription": { "type": "string" }, "salesRateDescription": { "type": "string" }, "rateType": { "type": "string" }, "rateSubType": { "type": "string" }, "rateGroup": { "type": "string" }, "rateSubGroup": { "type": "string" }, "rate": { "type": "string" }, "attribute1": { "type": "string" }, "attribute2": { "type": "string" }, "attribute3": { "type": "string" }, "modelName": { "type": "string" }, "storage": { "type": "string" }, "rateChargeUnit": { "type": "string" }, "hsiaeBrassOfferCode": { "type": "string" }, "rateEffectiveDate": { "type": "string", "format": "date-time" }, "rateEndDate": { "type": "string", "format": "date-time" }, "ratePlanEffectiveDate": { "type": "string", "format": "date-time" }, "rateEquipment": { "type": "string" }, "isoCountryCode": { "type": "string" }, "alpha3CountryCode": { "type": "string" }, "isoCurrencyCode": { "type": "string" }, "rateCode": { "type": "string" }, "rateGroupId": { "type": "string" }, "equipmentManufacturer": { "type": "string" }, "managementType": { "type": "string" }, "group": { "type": "string" }, "rateCategory": { "type": "string" }, "rateStatus": { "type": "string" }, "accessSpeed": { "type": "string" }, "portSpeed": { "type": "string" }, "associatedRates": { "type": "string" }, "serviceType": { "type": "string" }, "pbi": { "type": "string" }, "beid": { "type": "string" }, "ppcCode": { "type": "string" }, "biller": { "type": "array", "items": { "$ref": "#/components/schemas/Biller" } } } }, "RateReference": { "type": "object", "properties": { "rateIdInternal": { "type": "integer", "format": "int32" }, "rateIdExternal": { "type": "string" }, "rateId": { "type": "object" } } }, "RatesPlan": { "type": "object", "properties": { "ratePlanIdInternal": { "type": "string" }, "ratePlanIdExternal": { "type": "string" }, "ratePlanId": { "type": "string" }, "ratePlanVersion": { "type": "string" }, "billingRatePlan": { "type": "string" }, "ratePlanName": { "type": "string" }, "ratePlanDescription": { "type": "string" }, "ratePlaneffectiveDate": { "type": "string", "format": "date-time" }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } } } }, "SOCRatesOutput": { "type": "object", "properties": { "attContractId": { "type": "string" }, "rateStabilityDate": { "type": "string", "format": "date-time" }, "contractAuthorityLevel": { "type": "string" }, "contractTerm": { "type": "integer", "format": "int32" }, "accIndicator": { "type": "string" }, "discountTier": { "type": "string" }, "contractFlowType": { "type": "string" }, "featureOnOFF": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureOnOFF" } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "subAccount": { "$ref": "#/components/schemas/SubAccount" }, "pricing": { "type": "array", "items": { "$ref": "#/components/schemas/Pricing" } }, "marc": { "$ref": "#/components/schemas/Marc" }, "esign": { "$ref": "#/components/schemas/Esign" }, "lanIpBillingInd": { "type": "string" }, "loaNumber": { "type": "string" } } }, "SOCRatesResponse": { "type": "object", "properties": { "errorCode": { "type": "string" }, "errorMsg": { "type": "string" }, "socRatesOutput": { "$ref": "#/components/schemas/SOCRatesOutput" } } }, "SubAccount": { "type": "object", "properties": { "ucCustomerNumber": { "type": "string" }, "subAccountNumber": { "type": "string" } } }, "ATTContractIdDetails": { "type": "object", "properties": { "attContractId": { "type": "string" }, "contractTerm": { "type": "integer", "format": "int32" }, "siteType": { "type": "string" }, "ppcos": { "type": "string" }, "marketSegment": { "type": "string" }, "aggregator": { "type": "string" }, "contractType": { "type": "string" }, "zipCode": { "type": "string" }, "siteAddress": { "type": "string" }, "zipList": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "siteAddressList": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "status": { "type": "string" } } }, "Contacts": { "type": "object", "properties": { "contactType": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "fax": { "type": "string" }, "telephoneNumber": { "type": "string" }, "address1": { "type": "string" }, "streetAddress": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "stateProvince": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "attUid": { "type": "string" }, "positionName": { "type": "string" }, "primaryIndicator": { "type": "string" }, "lata": { "type": "string" }, "cilli": { "type": "string" } } }, "ContractDataRequest": { "type": "object", "properties": { "attContractIdList": { "type": "array", "items": { "$ref": "#/components/schemas/ATTContractIdDetails" } } } }, "ContractInfoRequest": { "type": "object", "properties": { "contractDataRequest": { "$ref": "#/components/schemas/ContractDataRequest" } } }, "ContractDataResponse": { "type": "object", "properties": { "attContractIdList": { "type": "array", "items": { "$ref": "#/components/schemas/ATTContractIdDetails" } }, "statusId": { "type": "string" }, "statusMessage": { "type": "string" } } }, "ContractInfoResponse": { "type": "object", "properties": { "contractDataResponse": { "$ref": "#/components/schemas/ContractDataResponse" } } }, "ContractDetailRequest": { "required": [ "contractNumber", "requestType", "requestValue" ], "type": "object", "properties": { "contractNumber": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "ratePlanID": { "maxLength": 50, "minLength": 0, "type": "string" }, "requestType": { "maxLength": 500, "minLength": 1, "type": "string" }, "requestValue": { "type": "string" }, "contractFiltersList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ContractFilter" } } } }, "ContractFilter": { "required": [ "filterName", "filterValue" ], "type": "object", "properties": { "filterName": { "maxLength": 500, "minLength": 1, "type": "string" }, "filterValue": { "maxLength": 500, "minLength": 1, "type": "string" } } }, "ContractInfo": { "type": "object", "properties": { "contractNumber": { "type": "string" }, "contractSubType": { "type": "string" }, "customerType": { "type": "string" }, "contractType": { "type": "string" }, "contractedBusinessName": { "type": "string" }, "contractStatus": { "type": "string" }, "contractEffectiveDate": { "type": "string" }, "contractTerm": { "type": "string" }, "isExpress": { "type": "string" }, "hasWifi": { "type": "string" }, "hasCWSS": { "type": "string" }, "isCustomContract": { "type": "string" }, "isModularContract": { "type": "string" }, "marketSegment": { "type": "string" }, "isGrowth": { "type": "string" }, "docviewerUrl": { "type": "string" }, "typeOfContractActivity": { "type": "string" }, "isAccessContract": { "type": "string" }, "accessContractType": { "type": "string" }, "contractFlowType": { "type": "string" }, "isSubRate": { "type": "string" } } }, "ContractPriceAndFeatures": { "type": "object", "properties": { "contractPriceAndFeaturesResponse": { "$ref": "#/components/schemas/ContractPriceAndFeaturesResponse" }, "contractPriceAndFeaturesRequest": { "$ref": "#/components/schemas/ContractPriceAndFeaturesRequest" }, "storeJson": { "type": "string" } } }, "ContractPriceAndFeaturesRequest": { "type": "object", "properties": { "transactionID": { "type": "string" }, "productOffer": { "type": "string" }, "contractNumber": { "type": "string" }, "transactionType": { "type": "string" }, "accessContractType": { "type": "string" }, "locationId": { "type": "string" }, "accessVendorName": { "type": "string" }, "zipcode": { "type": "string" }, "filterOptions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterOption" } }, "saneInd": { "type": "string" } } }, "ContractPriceAndFeaturesResponse": { "type": "object", "properties": { "transactionID": { "type": "string" }, "contractNumber": { "type": "string" }, "status": { "type": "string" }, "errorCode": { "type": "string" }, "errorDesc": { "type": "string" }, "errorDescExt": { "type": "string" }, "contractInfo": { "$ref": "#/components/schemas/ContractInfo" }, "productOffer": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffer" } } } }, "FilterOption": { "type": "object", "properties": { "accessSpeed": { "type": "string" }, "portSpeed": { "type": "string" }, "mbcSpeed": { "type": "string" }, "speedUnit": { "type": "string" } } }, "ProductOffer": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int64" }, "productName": { "type": "string" }, "offerId": { "type": "integer", "format": "int64" }, "offerName": { "type": "string" }, "ratePlanId": { "type": "integer", "format": "int64" } } }, "ContractContact": { "type": "object", "properties": { "getContractContactDetailsRequest": { "$ref": "#/components/schemas/ContractContactRequest" }, "getContractContactDetails": { "$ref": "#/components/schemas/ContractContactResponse" } } }, "ContractContactRequest": { "type": "object", "properties": { "contractId": { "type": "string" }, "invoiceAccountNumber": { "type": "string" }, "requestType": { "type": "string" } } }, "ContractContactResponse": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/Contracts" } } } }, "Contracts": { "type": "object", "properties": { "attContractId": { "type": "string" }, "l3AccountId": { "type": "string" }, "contractTerm": { "type": "string" }, "contractStatus": { "type": "string" }, "contractSubType": { "type": "string" }, "contractSolutionNumber": { "type": "string" }, "contractEffectiveDate": { "type": "string", "format": "date-time" }, "contractEndDate": { "type": "string", "format": "date-time" }, "contractCustomerName": { "type": "string" }, "contractServiceName": { "type": "string" }, "masterAgreementNumber": { "type": "string" }, "invoiceAccountNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAccountNumbers" } }, "customerLegalInfo": { "$ref": "#/components/schemas/CustomerLegalInfo" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } } } }, "CustomerLegalInfo": { "type": "object", "properties": { "customerLegalName": { "type": "string" }, "streetAddress1": { "type": "string" }, "streetAddress2": { "type": "string" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "country": { "type": "string" }, "zipOrPostalCode": { "type": "string" }, "telephone": { "type": "string" } } }, "InvoiceAccountNumbers": { "type": "object", "properties": { "invoiceAccountNumber": { "type": "string" } } }, "CDRContractRequest": { "type": "object", "properties": { "offerId": { "type": "integer", "format": "int64" }, "strata": { "type": "string" }, "statusType": { "type": "array", "items": { "$ref": "#/components/schemas/StatusType" } }, "typeofRequest": { "type": "integer", "format": "int32" }, "sortBy": { "type": "integer", "format": "int32" }, "sortOn": { "type": "string" }, "mustHaveDiscounts": { "type": "string" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriterion" }, "view": { "type": "integer", "format": "int32" }, "filterCriteria": { "$ref": "#/components/schemas/FilterCriteria" }, "customerSignedDateRange": { "$ref": "#/components/schemas/CustomerSignedDateRange" }, "sellersATTUID": { "type": "string" }, "perPageSize": { "type": "string" }, "pageIndex": { "type": "string" } } }, "CustomerSignedDateRange": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "FilterCriteria": { "type": "object", "properties": { "include": { "type": "array", "items": { "$ref": "#/components/schemas/FilterType" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/FilterType" } } } }, "FilterType": { "type": "object", "properties": { "filterName": { "type": "string" }, "filterValue": { "type": "string" } } }, "SearchCriterion": { "type": "object", "properties": { "searchKey": { "type": "string" }, "searchValue": { "type": "string" }, "include": { "type": "array", "items": { "$ref": "#/components/schemas/FilterType" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/FilterType" } }, "isExactSearch": { "type": "string" } } }, "StatusType": { "type": "object", "properties": { "status": { "type": "string" } } }, "AVPNContractDetails": { "type": "object", "properties": { "ethernetAccessIndicator": { "type": "string" }, "lspLocations": { "type": "string" }, "customSla": { "type": "string" }, "customTerms": { "type": "string" }, "csfInd": { "type": "string" } } }, "CDRContract": { "type": "object", "properties": { "customerName": { "type": "string" }, "contractStartDate": { "type": "string", "format": "date-time" }, "contractEffectiveDate": { "type": "string", "format": "date-time" }, "contractEndDate": { "type": "string", "format": "date-time" }, "contractNumber": { "type": "string" }, "contractStatus": { "type": "string" }, "contractSubType": { "type": "string" }, "contractTerm": { "type": "integer", "format": "int32" }, "contractType": { "type": "string" }, "contractActivityType": { "type": "string" }, "dunsNumber": { "type": "string" }, "contractSource": { "type": "string" }, "isCustomContract": { "type": "string" }, "contractedBusinessPhone": { "type": "string" }, "customerType": { "type": "string" }, "contractID": { "type": "string" }, "l3AccountId": { "type": "string" }, "oldL3AccountId": { "type": "string" }, "svid": { "type": "string" }, "subAccountId": { "type": "string" }, "accountName": { "type": "string" }, "masterAgreementNumber": { "type": "string" }, "billerCode": { "type": "string" }, "opportunityId": { "type": "string" }, "opportunityName": { "type": "string" }, "mobilityShadowAgreementIndicator": { "type": "string" }, "mobilityShadowAgreementNumber": { "type": "string" }, "invoiceType": { "type": "string" }, "coterminousExpirationDate": { "type": "string", "format": "date-time" }, "coterminousIndicator": { "type": "string" }, "discountAuthorityLevel": { "type": "integer", "format": "int32" }, "contractTermExtension": { "type": "string" }, "pmoServiceType": { "type": "string" }, "contractSubOffer": { "type": "string" }, "fmoInd": { "type": "string" }, "accIndicator": { "type": "string" }, "serviceLocationCountry": { "type": "string" }, "ebmIndicator": { "type": "string" }, "annualValue": { "type": "integer", "format": "int64" }, "customerSignedDate": { "type": "string", "format": "date-time" }, "attSignedDate": { "type": "string", "format": "date-time" }, "customerAddress": { "type": "string" }, "customerAddress1": { "type": "string" }, "customerAddress2": { "type": "string" }, "customerCity": { "type": "string" }, "customerState": { "type": "string" }, "customerZip": { "type": "string" }, "customerCountry": { "type": "string" }, "docViewerId": { "type": "integer", "format": "int32" }, "docViewerUrl": { "type": "string" }, "gcoNumber": { "type": "string" }, "strata": { "type": "string" }, "orderableStatus": { "type": "string" }, "isbIndicator": { "type": "string" }, "bundledMarcFlag": { "type": "string" }, "bundledServiceName": { "type": "string" }, "ccid": { "type": "string" }, "pcsHomerNumber": { "type": "string" }, "solutionType": { "type": "string" }, "federalBillerCode": { "type": "string" }, "bvoipIpt": { "type": "string" }, "hasCid": { "type": "string" }, "contractGroupSignedDate": { "type": "string", "format": "date-time" }, "hasCustomPricing": { "type": "string" }, "coaContractNumber": { "type": "string" }, "coaCounterSignedDate": { "type": "string", "format": "date-time" }, "billingSystem": { "type": "string" }, "promotionName": { "type": "string" }, "contractServiceType": { "type": "string" }, "contractCustomerName": { "type": "string" }, "dayAfterExpiration": { "type": "string" }, "totalContractTerm": { "type": "integer", "format": "int32" }, "contractSolutionNumber": { "type": "string" }, "resellerFlag": { "type": "string" }, "contractAlias": { "type": "string" }, "statusId": { "type": "string" }, "productOffer": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffer" } }, "listOfServices": { "type": "array", "items": { "$ref": "#/components/schemas/ListOfServices" } }, "originalContract": { "type": "array", "items": { "$ref": "#/components/schemas/OriginalContract" } }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "avpnContractDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AVPNContractDetails" } }, "usAccessDetails": { "type": "array", "items": { "$ref": "#/components/schemas/USAccessDetails" } }, "replacedContract": { "type": "array", "items": { "$ref": "#/components/schemas/ReplacedContract" } }, "rateInstances": { "type": "array", "items": { "$ref": "#/components/schemas/RateInstance" } }, "installSiteList": { "type": "array", "items": { "$ref": "#/components/schemas/InstallationSite" } }, "subcontractList": { "type": "array", "items": { "$ref": "#/components/schemas/SubContract" } }, "invoiceInfo": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceInfo" } }, "masterContractNumber": { "type": "string" }, "masterContractInd": { "type": "string" }, "contractFlowType": { "type": "string" }, "iciFlagValue": { "type": "string" }, "customContractNumber": { "type": "string" }, "regionalInd": { "type": "string" }, "narrative": { "type": "string" }, "erate": { "type": "string" }, "esignContractDocId": { "type": "string" }, "esignDocId": { "type": "string" }, "erateBenNumber": { "type": "string" }, "erate470Number": { "type": "string" }, "eratePricingVenue": { "type": "string" }, "ecatsFileNumber": { "type": "string" } } }, "CDRContractResponse": { "type": "object", "properties": { "countOfContract": { "type": "integer", "format": "int32" }, "cdrContractInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContract" } }, "errorCode": { "type": "string" }, "errorMsg": { "type": "string" } } }, "InstallationSite": { "type": "object", "properties": { "siteId": { "type": "string" }, "state": { "type": "string" } } }, "InvoiceInfo": { "type": "object", "properties": { "multipleInvoiceInd": { "type": "string" }, "invoiceAccountNo": { "type": "string" } } }, "ListOfServices": { "type": "object", "properties": { "productName": { "type": "string" } } }, "OriginalContract": { "type": "object", "properties": { "contractNumber": { "type": "string" } } }, "RateInstance": { "type": "object", "properties": { "rate": { "type": "string" }, "rateId": { "type": "string" }, "siteId": { "type": "string" }, "usoc": { "type": "string" }, "rateType": { "type": "string" }, "serviceComponentDescription": { "type": "string" }, "jurisdiction": { "type": "string" }, "quantity": { "type": "string" } } }, "ReplacedContract": { "type": "object", "properties": { "oldContractNumber": { "type": "string" }, "oldContractTerm": { "type": "string" }, "oldContractStartDate": { "type": "string", "format": "date-time" }, "oldContractExpiryDate": { "type": "string", "format": "date-time" } } }, "SubContract": { "type": "object", "properties": { "state": { "type": "string" }, "contractID": { "type": "string" } } }, "USAccessDetails": { "type": "object", "properties": { "integratedContractIndicator": { "type": "string" }, "dealID": { "type": "string" }, "serviceBillingName": { "type": "string" }, "serviceMCN": { "type": "string" }, "serviceGRC": { "type": "string" }, "serviceSOC": { "type": "string" }, "serviceBillerCode": { "type": "string" }, "enumber": { "type": "string" } } }, "CDRContractDetailsRequest": { "type": "object", "properties": { "contractInfo": { "$ref": "#/components/schemas/ContractInfo" } } }, "CDRContractCountryInfoDetails": { "type": "object", "properties": { "contractCountry": { "type": "string" }, "discountInstance": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContractDiscountInstance" } }, "creditInformation": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContractCreditInformation" } } } }, "CDRContractCreditInformation": { "type": "object", "properties": { "monthOffset": { "type": "string" }, "creditAmount": { "type": "string" }, "creditFrequency": { "type": "string" }, "typeOfCredit": { "type": "string" }, "holdReleaseIndicator": { "type": "string" }, "isoCurrencyCode": { "type": "string" }, "gcpCreditID": { "type": "string" }, "conditionText": { "type": "string" } } }, "CDRContractDetailsResponse": { "type": "object", "properties": { "errorCode": { "type": "string" }, "errorMsg": { "type": "string" }, "contractInfo": { "$ref": "#/components/schemas/CDRContractInfoResponse" } } }, "CDRContractDiscountInstance": { "type": "object", "properties": { "discountId": { "type": "string" }, "discountDescription": { "type": "string" }, "externalDiscountID": { "type": "string" }, "externalDiscountDescription": { "type": "string" }, "customDiscount": { "type": "string" }, "discountPercentage": { "type": "string" }, "gcpBeid": { "type": "string" }, "subGroupName": { "type": "string" }, "beidRateplanEffDate": { "type": "string", "format": "date-time" }, "gcpBeidDescription": { "type": "string" } } }, "CDRContractInfoResponse": { "type": "object", "properties": { "contractNumber": { "type": "string" }, "serviceName": { "type": "string" }, "isbIndicator": { "type": "string" }, "priceplanInstance": { "$ref": "#/components/schemas/CDRContractPricePlanInstance" } } }, "CDRContractPricePlanInstance": { "type": "object", "properties": { "priceplanId": { "type": "string" }, "priceplanDescription": { "type": "string" }, "externalPriceplanId": { "type": "string" }, "externalPriceplanDescription": { "type": "string" }, "offerId": { "type": "string" }, "offerName": { "type": "string" }, "countryInfoDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContractCountryInfoDetails" } }, "rateplanInstance": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContractRatePlanInstance" } } } }, "CDRContractRateInstance": { "type": "object", "properties": { "rateId": { "type": "string" }, "rateDescription": { "type": "string" }, "externalRateId": { "type": "string" }, "externalRateDescription": { "type": "string" }, "isCustomRate": { "type": "string" }, "rateType": { "type": "string" }, "rate": { "type": "string" } } }, "CDRContractRatePlanInstance": { "type": "object", "properties": { "rateplanId": { "type": "string" }, "rateplanDescription": { "type": "string" }, "externalRateplanId": { "type": "string" }, "externalRateplanDescription": { "type": "string" }, "rateplanEffectiveDate": { "type": "string", "format": "date-time" }, "rateStabilityDate": { "type": "string", "format": "date-time" }, "isoCountryCode": { "type": "string" }, "rateInstance": { "type": "array", "items": { "$ref": "#/components/schemas/CDRContractRateInstance" } } } } } } }