{ "openapi": "3.0.1", "security": [ { "Authorization": [] } ], "info": { "title": "Service Qualification Management APIs", "description": "## TMF API Reference: TMF645 - Service Qualification ##\n\n Version 2.0

\n Service Qualification API is part of the Pre-Ordering Management API Family. The primary purpose of Service Qualification Management is to retrieve available, qualified, and existing AT&T services for a provided address. The goal of this API is to provide service technical eligibility. Since v2, the API is split in 2 resources to distinguish specific service qualification request to be performed on a described configurated service (or a list of configured services) from a retrieval of services eligible for a given context. The API allows to manage synchronous as asynchronous eligibility response (eligibility provided in POST response or later with an id and state provided ).\n### Query Service Qualification resource: ###\n Query Service Qualification is used to retrieve a list of services eligible in a given request provided by requester (via searchCriteria).\n
\n\n
\n Upstream services: \n\n ` EdgeProfileDataConsumerMs, wireless-sales-eapi, CCMULE, MyATT-MAS, Digital Sales UI, IDP Inter-APP Gateway, att-wireline-sales-eapi, OCE(Order Capture Engine), SF ` \n\n Downstream services: \n ` FacilityCheckMs, DPLCustomerGraphMs, CustomerGraphOrchestrationMs, CustomerGraphSearchMs, UnifiedServicePlanOrchMs `\n

\n[Sequence Diagram](https://codecloud.web.att.com/projects/ST_GOV/repos/dplservicequalificationms_specs/browse/docs/Architecture.md) \n\n[Service Qualification Management website](https://wiki.web.att.com/display/DRC/ATT+Service+Qualification) \n\n[Email Omni Commerce Enabler Services Team](mailto:DL-OmniEnabler@list.att.com)", "version": "v2", "x-att-catalog": { "shortDescription": "The primary purpose of Service Qualification Management is to retrieve available, qualified, and existing AT&T services for a provided address.", "productTeam": "OmniCommerce Enabler Services", "scrumTeam": "SPT-CC-Omni Enabler Services", "scrumTeamContact": "DL-OmniEnabler@list.att.com", "attFunctionalDomain": "Commerce Services", "attSubDomain": "Omni Enabler Services", "gatewayUsed": "No", "internetFacing": "AppGW", "status": "STABLE", "mots": 33826, "apiType": "SYSTEM", "channelsSupported": [ "WEB", "NATIVE APP", "RETAIL", "CALL CENTER", "IVR" ], "appCodeUrl": "https://codecloud.web.att.com/projects/ST_DIGINSALES/repos/service-qualification-management-papi/browse", "specRepoUrl": "https://anypoint.mulesoft.com/exchange/4a3c77b5-bd29-4bba-8947-fc28c6b8e442/service-qualification-management-papi/minor/2.0/console/summary/", "otherUrls": [ "https://wiki.web.att.com/display/DRC/ATT+Service+Qualification", "https://wiki.web.att.com/pages/viewpage.action?pageId=1384520766" ], "ccProject": "ST_DIGINSALES" } }, "servers": [ { "url": "https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/service-qual-management-papi-test2" } ], "tags": [ { "name": "Query Service Qualification" }, { "name": "Service Qualification Details" }, { "name": "v1 - Query Service Qualification [deprecated]" } ], "paths": { "/v2/query-service-qualification": { "get": { "tags": [ "Query Service Qualification" ], "summary": "Available services at a geographical address.", "description": "In the request, the user must provide either the full address (zip code and address line 1) or the addressId (a unique identifier for every address). The service's response, based on the request, could be one of the following: no match, out of footprint, close match, MDU (Multi-Dwelling Unit), existing service, or green address.\n\n The serviceQualification object : This contains details about the list of services that are available at that address. This contains 2 objects, serviceQualificationItem and serviceInventory.\n\n Apart from salesChannelId and salesChannelType, `either one of these fields is also required - PlaceId, ZipCode, enablerBan, telephoneNumber.`\n", "operationId": "listQueryServiceQualificationV2", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "schema": { "type": "integer" } }, { "schema": { "type": "string", "maxLength": 30 }, "in": "query", "name": "placeId", "description": "Unique Address Id of the validated address", "example": "100001" }, { "schema": { "type": "string", "maxLength": 30 }, "in": "query", "name": "individualId", "description": "Customer individual id from Customer Graph", "example": "456" }, { "schema": { "type": "string", "maxLength": 10 }, "required": true, "in": "query", "name": "salesChannelId", "description": "Sales Channel Id that is provided by the IDP Configuration layer", "example": "WEB" }, { "schema": { "type": "string", "enum": [ "WEB", "RETAIL_STORE", "RETAIL_CALL_CENTER", "IVR", "CHAT", "NATIVE_APP", "EXTERNAL_PARTNER", "P13N", "EDS" ] }, "in": "query", "required": true, "name": "salesChannelType", "example": "WEB" }, { "schema": { "type": "string" }, "in": "query", "name": "agentId", "description": "Agent Id", "example": "AG456" }, { "schema": { "type": "string" }, "in": "query", "name": "partnerId", "description": "Partner Id", "example": "PART101" }, { "schema": { "type": "string" }, "in": "query", "name": "storeId", "description": "Retail Store Id", "example": "S190" }, { "schema": { "type": "string" }, "in": "query", "name": "zipCode", "description": "Zip code of the address you need results for.", "example": "98011" }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "enablerBan", "description": "User billing account number", "example": "BAN EXAMPLE" }, { "schema": { "type": "string", "maxLength": 10 }, "in": "query", "name": "telephoneNumber", "description": "10 digit ATT POTS Telephone number.", "example": "9876543210" }, { "schema": { "type": "boolean" }, "in": "query", "name": "agentOverride", "example": true }, { "schema": { "type": "string" }, "in": "query", "name": "overrideServiceName", "description": "Name of the agent service trying to overriding." }, { "schema": { "type": "boolean" }, "in": "query", "name": "acpEligible", "description": "True/False based on user's eligibility for ACP.", "example": true }, { "schema": { "type": "string", "enum": [ "CONSUMER", "Business" ] }, "in": "query", "name": "customerType", "description": "Type of customer, individual consumer or SMB (small business).", "example": "CONSUMER" }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "currentSwimlanes", "description": "List of comma separated current swimlane speeds." }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "currentPlans", "description": "List of comma separated current swimlane plans." }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "migrationAccountNumbers", "description": "List of comma separated migration account numbers. Required for migrating customers. Applicable for AIA flow (except IVR channel)." }, { "schema": { "type": "boolean" }, "in": "query", "name": "ignoreCache", "description": "Default value is FALSE. When ignoreCache is TRUE, we ignore the cached response and return the ServiceQual response by invoking all the downstream apps.", "example": false }, { "schema": { "type": "string" }, "in": "query", "name": "serviceType", "description": "Service Type when provided, will route to service qual for specific service type light weight route", "example": "Fiber" }, { "schema": { "type": "boolean" }, "in": "query", "name": "accessEligible", "description": "True/False based on user's eligibility for Access.", "example": true } ], "responses": { "200": { "description": "Success", "headers": { "X-Total-Count": { "description": "Total number of items matching criteria", "schema": { "type": "integer" } }, "X-Result-Count": { "description": "Actual number of items returned in the response body", "schema": { "type": "integer" } } }, "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "examples": { "queryServiceQualificationResponseExample": { "$ref": "#/components/examples/queryServiceQualificationResponse-200" }, "queryServiceQualificationResponseForBusinessExample": { "$ref": "#/components/examples/queryServiceQualificationBusinessResponse-200" }, "BSSE_Fiber_Sample_Response": { "$ref": "#/components/examples/BSSEFiberResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-500" } } } } } }, "x-internal": true }, "parameters": [] }, "/v2/service-qualification-details": { "get": { "tags": [ "Service Qualification Details" ], "summary": "Service qualification details by qualification Id.", "description": "This API endpoint can be used to retrieve service qualification details using a qualification Id. If this endpoint is being invoked from the shopping cart, passing the placeId as a query parameter is required.", "operationId": "qualificationdetails1", "parameters": [ { "name": "qualificationId", "in": "query", "required": true, "description": "Qualification Id to retrieve the service qualification details.", "schema": { "type": "string" }, "example": "a7b3b610-923c-4be9-b9a0-894393385bf7" }, { "name": "placeId", "in": "query", "required": false, "description": "Unique address Id of the validated address. *`Mandatory while this endpoint is invoked from Shopping cart.`*\n", "schema": { "type": "string" }, "example": "0000MDGVN" } ], "responses": { "200": { "description": "Success", "headers": { "X-Total-Count": { "description": "Qualification ID Response Count", "schema": { "type": "integer" } }, "X-Result-Count": { "description": "Actual number of items returned in the response body", "schema": { "type": "integer" } } }, "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "examples": { "ServiceQualificationDetailsResponseExample": { "$ref": "#/components/examples/queryServiceQualificationResponse-200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ServiceQualificationDetailsResponse-Error1": { "$ref": "#/components/examples/ServiceQualificationDetailsResponse-400-1" }, "ServiceQualificationDetailsResponse-Error2": { "$ref": "#/components/examples/ServiceQualificationDetailsResponse-400" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-500" } } } } } }, "x-internal": true }, "parameters": [] }, "/v2/save-service-qualification-details": { "get": { "tags": [ "Service Qualification Details" ], "summary": "Service qualification details into cassandra.", "description": "This API endpoint is used to persist the user and cart details into the cassandra database.", "operationId": "Qualificationdetails", "parameters": [ { "name": "placeId", "in": "query", "description": "Unique address Id of the validated address. *`Mandatory while this endpoint is invoked from Shopping cart.`*\n", "required": true, "example": "00000NGI7B", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Cart ID", "required": true, "example": "75021100-737d-11ee-b776-9139496b020e", "schema": { "type": "string" } }, { "name": "qualificationId", "in": "query", "description": "Qualification Id to retrieve the service qualification details. If this parameter is not passed, a newly generated unique qualification Id will be returned.", "schema": { "type": "string" }, "example": "a7b3b610-923c-4be9-b9a0-894393385bf7" } ], "responses": { "200": { "description": "Success", "headers": { "X-Total-Count": { "description": "Response count of Saved Address ID details into Cassandra", "schema": { "type": "integer" } }, "X-Result-Count": { "description": "Actual number of items returned in the response body", "schema": { "type": "integer" } } }, "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "examples": { "save-service-qualification-details response example 1": { "$ref": "#/components/examples/saveQualificationDetailsResponse-200-1" }, "save-service-qualification-details response example 2": { "$ref": "#/components/examples/saveQualificationDetailsResponse-200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/saveQualificationDetailsResponse-400" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-500" } } } } } }, "x-internal": true }, "parameters": [] }, "/v1/query-service-qualification": { "get": { "deprecated": true, "tags": [ "v1 - Query Service Qualification [deprecated]" ], "summary": "List or find QueryServiceQualification objects", "description": "This operation list or find QueryServiceQualification entities", "operationId": "listQueryServiceQualificationV1", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "schema": { "type": "integer" } }, { "schema": { "type": "string" }, "in": "query", "name": "placeId", "description": "Service location Place Id", "example": "100001" }, { "schema": { "type": "string" }, "in": "query", "name": "individualId", "description": "Customer individual id from Customer Graph", "example": "456" }, { "schema": { "type": "string" }, "in": "query", "name": "salesChannelId", "description": "Sales Channel Id will be provided by IDP Configuration layer", "example": "WEB" }, { "schema": { "type": "string", "enum": [ "WEB", "RETAIL_STORE", "RETAIL_CALL_CENTER", "IVR", "CHAT", "NATIVE_APP", "EXTERNAL_PARTNER", "P13N", "EDS" ] }, "in": "query", "name": "salesChannelType", "description": "Sales Channel Type", "example": "WEB" }, { "schema": { "type": "string" }, "in": "query", "name": "agentId", "description": "Agent Id", "example": "AG456" }, { "schema": { "type": "string" }, "in": "query", "name": "partnerId", "description": "Partner Id", "example": "PART101" }, { "schema": { "type": "string" }, "in": "query", "name": "storeId", "description": "Retail Store Id", "example": "S190" } ], "responses": { "200": { "description": "Success", "headers": { "X-Total-Count": { "description": "Total number of items matching criteria", "schema": { "type": "integer" } }, "X-Result-Count": { "description": "Actual number of items returned in the response body", "schema": { "type": "integer" } } }, "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "examples": { "queryServiceQualificationResponseExample": { "$ref": "#/components/examples/queryServiceQualificationResponse-200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-400" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "queryServiceQualificationResponse-Error": { "$ref": "#/components/examples/queryServiceQualificationResponse-500" } } } } } }, "x-internal": true }, "parameters": [] } }, "components": { "securitySchemes": { "Authorization": { "description": "Basic HTTP Authentication with a username and password", "type": "http", "scheme": "Basic" } }, "schemas": { "AccountDetails": { "type": "object", "properties": { "billingAccountNumber": { "type": "string", "description": "Billing account number for this service" }, "accountStatusCode": { "type": "string", "description": "Status code which indicates the account status for a specific service account" }, "customerTypeCode": { "type": "string", "description": "Customer Type code associated to the account for a specified service." }, "migrationIndicator": { "type": "boolean", "description": "Indicator which indicates whether the service is eligible for migration." }, "migrationIneligibleReasons": { "type": "array", "description": "List of AIA migration Ineligible Reasons populated from CG(only applicable for Uverse customers not eligible for AIA migration)", "items": { "$ref": "#/components/schemas/MigrationIneligibleReason" } }, "accountCharacteristic": { "type": "array", "description": "A list of characteristics that characterize this account (AccountCharacteristic [*]) ", "items": { "$ref": "#/components/schemas/Characteristic" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Base schema for account details entities" }, "Addressable": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Base schema for addressable entities" }, "AlternateServiceProposal": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of a alternate service proposal" }, "alternateServiceAvailabilityDate": { "type": "string", "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", "format": "date-time" }, "alternateService": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date" }, "Any": { "type": "object" }, "Characteristic": { "required": [ "name", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } }, "value": { "type": "string", "description": "Value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "CheckServiceQualification": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the serviceQualification resource" }, "href": { "type": "string", "description": "Hyperlink to access the serviceQualification" }, "checkServiceQualificationDate": { "type": "string", "description": "Date when the serviceQualification was submitted", "format": "date-time" }, "description": { "type": "string", "description": "Description of the serviceQualification" }, "effectiveQualificationDate": { "type": "string", "description": "Effective date to serviceQualification completion", "format": "date-time" }, "estimatedResponseDate": { "type": "string", "description": "Date when the requester expect to provide an answer for the qualification request.", "format": "date-time" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification response expires", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "provideAlternative": { "type": "boolean", "description": "When the value is TRUE means that alternative solutions should be provided", "default": false }, "provideUnavailabilityReason": { "type": "boolean", "description": "When the value is TRUE means that unavailability reason are expected for non available service.", "default": false }, "qualificationResult": { "type": "string", "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)" }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceQualificationItem": { "type": "array", "description": "A list of service qualification items.", "items": { "$ref": "#/components/schemas/CheckServiceQualificationItem" } }, "state": { "$ref": "#/components/schemas/TaskStateType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "CheckServiceQualification is used to perform a technical eligibility on service configuration(s). It allows to retrieve services that are technically available in the context of the interaction (place, party, service characteristics, ...)." }, "CheckServiceQualification_Create": { "required": [ "serviceQualificationItem" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of the serviceQualification" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "provideAlternative": { "type": "boolean", "description": "When the value is TRUE means that alternative solutions should be provided", "default": false }, "provideUnavailabilityReason": { "type": "boolean", "description": "When the value is TRUE means that unavailability reason are expected for non available service.", "default": false }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceQualificationItem": { "minItems": 1, "type": "array", "description": "A list of service qualification items.", "items": { "$ref": "#/components/schemas/CheckServiceQualificationItem" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "CheckServiceQualification is used to perform a technical eligibility on service configuration(s). It allows to retrieve services that are technically available in the context of the interaction (place, party, service characteristics, ...).\nSkipped properties: id,href,state,effectiveQualificationDate,qualificationResult,expirationDate,checkServiceQualificationDate,estimatedResponseDate,serviceQualificationItem.alternateServiceProposal,serviceQualificationItem.state,serviceQualificationItem.qualificationResult" }, "CheckServiceQualification_Update": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the serviceQualification" }, "effectiveQualificationDate": { "type": "string", "description": "Effective date to serviceQualification completion", "format": "date-time" }, "estimatedResponseDate": { "type": "string", "description": "Date when the requester expect to provide an answer for the qualification request.", "format": "date-time" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification response expires", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "provideAlternative": { "type": "boolean", "description": "When the value is TRUE means that alternative solutions should be provided", "default": false }, "provideUnavailabilityReason": { "type": "boolean", "description": "When the value is TRUE means that unavailability reason are expected for non available service.", "default": false }, "qualificationResult": { "type": "string", "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)" }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceQualificationItem": { "type": "array", "description": "A list of service qualification items.", "items": { "$ref": "#/components/schemas/CheckServiceQualificationItem" } }, "state": { "$ref": "#/components/schemas/TaskStateType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "CheckServiceQualification is used to perform a technical eligibility on service configuration(s). It allows to retrieve services that are technically available in the context of the interaction (place, party, service characteristics, ...).\nSkipped properties: id,href,checkServiceQualificationDate" }, "CheckServiceQualificationItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the Service Qualification Item" }, "expectedActivationDate": { "type": "string", "description": "The date when the service is expected to be activated", "format": "date-time" }, "expectedServiceAvailabilityDate": { "type": "string", "description": "Date when the requester looks for service availability", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification item response expires", "format": "date-time" }, "qualificationResult": { "type": "string", "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" }, "state": { "type": "string", "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" }, "alternateServiceProposal": { "type": "array", "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", "items": { "$ref": "#/components/schemas/AlternateServiceProposal" } }, "category": { "$ref": "#/components/schemas/ServiceCategoryRef" }, "eligibilityUnavailabilityReason": { "type": "array", "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", "items": { "$ref": "#/components/schemas/ServiceEligibilityUnavailabilityReason" } }, "qualificationItemRelationship": { "type": "array", "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", "items": { "$ref": "#/components/schemas/ServiceQualificationItemRelationship" } }, "qualificationRelationship": { "type": "array", "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", "items": { "$ref": "#/components/schemas/ServiceQualificationRelationship" } }, "service": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "terminationError": { "type": "array", "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", "items": { "$ref": "#/components/schemas/TerminationError" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation." }, "ConstraintRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "reference id to the target constraint" }, "href": { "type": "string", "description": "Hyperlink reference to the target constraint" }, "name": { "type": "string", "description": "Name given to the constraint" }, "version": { "type": "string", "description": "constraint version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The (class) type of the referred constraint" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "EntityRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Entity reference schema to be use for all entityRef class." }, "EntityValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Base entity value schema for use in TMForum Open-APIs" }, "Extensible": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "description": "Base Extensible schema for use in TMForum Open-APIs" }, "Feature": { "required": [ "featureCharacteristic", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "name": { "type": "string", "description": "This is the name for the feature." }, "constraint": { "type": "array", "description": "This is a list of feature constraints.", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "featureCharacteristic": { "minItems": 1, "type": "array", "description": "This is a list of Characteristics for a particular feature.", "items": { "$ref": "#/components/schemas/Characteristic" } }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRelationship" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Configuration feature." }, "FeatureRelationship": { "required": [ "name", "relationshipType" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the target feature." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Configuration feature" }, "MigrationIneligibleReason": { "type": "object", "properties": { "code": { "type": "string", "description": "CG Code for migration ineligible Reason" }, "description": { "type": "string", "description": "Description for migration ineligible Reason" } } }, "Note": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" }, "author": { "type": "string", "description": "Author of the note" }, "date": { "type": "string", "description": "Date of the note", "format": "date-time" }, "text": { "type": "string", "description": "Text of the note" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Extra information about a given entity" }, "OrderItemActionType": { "type": "string", "description": "action to be performed on the product", "enum": [ "add", "modify", "delete", "noChange" ] }, "Place": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Place reference. Place defines the places where the products are sold or delivered." }, "PlaceRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered." }, "ServiceQualificationDetails": { "type": "object", "properties": { "message": { "type": "string", "description": "Service Qualification Details status message" } } }, "QueryServiceQualification": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the serviceQualification resource" }, "href": { "type": "string", "description": "Hyperlink to access the serviceQualification" }, "description": { "type": "string", "description": "Description of the serviceQualification" }, "effectiveQualificationDate": { "type": "string", "description": "Effective date to serviceQualification completion", "format": "date-time" }, "estimatedResponseDate": { "type": "string", "description": "Date when the requester expect to provide an answer for the qualification request.", "format": "date-time" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification response expires", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "queryServiceQualificationDate": { "type": "string", "description": "Date when the serviceQualification was submitted", "format": "date-time", "example": "2021-09-16T15:35:09.574Z" }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "searchCriteria": { "$ref": "#/components/schemas/ServiceQualificationItem" }, "serviceQualificationItem": { "type": "array", "description": "A list of service qualification items.", "items": { "$ref": "#/components/schemas/ServiceQualificationItem" } }, "serviceInventory": { "type": "array", "description": "A list of existing services.", "items": { "$ref": "#/components/schemas/ServiceInventory" } }, "state": { "$ref": "#/components/schemas/TaskStateType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "QueryServiceQualification is used to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...)." }, "QueryServiceQualification_Create": { "required": [ "searchCriteria" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of the serviceQualification" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "searchCriteria": { "$ref": "#/components/schemas/ServiceQualificationItem" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "QueryServiceQualification is used to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).\nSkipped properties: id,href,serviceQualificationItem,state,effectiveQualificationDate,expirationDate,estimatedResponseDate,queryServiceQualificationDate" }, "QueryServiceQualification_Update": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the serviceQualification" }, "effectiveQualificationDate": { "type": "string", "description": "Effective date to serviceQualification completion", "format": "date-time" }, "estimatedResponseDate": { "type": "string", "description": "Date when the requester expect to provide an answer for the qualification request.", "format": "date-time" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification response expires", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "searchCriteria": { "$ref": "#/components/schemas/ServiceQualificationItem" }, "serviceQualificationItem": { "type": "array", "description": "A list of service qualification items.", "items": { "$ref": "#/components/schemas/ServiceQualificationItem" } }, "state": { "$ref": "#/components/schemas/TaskStateType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "QueryServiceQualification is used to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).\nSkipped properties: id,href,queryServiceQualificationDate" }, "RelatedEntityRefOrValue": { "required": [ "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself" }, "RelatedParty": { "required": [ "@referredType", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Related Entity reference. A related party defines party or party role linked to a specific entity." }, "RelatedPlaceRefOrValue": { "required": [ "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "RelatedServiceOrderItem": { "required": [ "itemId", "serviceOrderId" ], "type": "object", "properties": { "itemId": { "type": "string", "description": "Identifier of the order item where the service was managed" }, "role": { "type": "string", "description": "role of the service order item for this service" }, "serviceOrderHref": { "type": "string", "description": "Reference of the related entity." }, "serviceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "itemAction": { "$ref": "#/components/schemas/OrderItemActionType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination." }, "ResourceRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "Service": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "description": { "type": "string", "description": "Free-text description of the service" }, "endDate": { "type": "string", "description": "Date when the service ends", "format": "date-time" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierarchy. If false, the service is a 'atomic' service (hierarchy leaf)." }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "name": { "type": "string", "description": "Name of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "startDate": { "type": "string", "description": "Date when the service starts", "format": "date-time" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "feature": { "type": "array", "description": "A list of feature associated with this service ", "items": { "$ref": "#/components/schemas/Feature" } }, "note": { "type": "array", "description": "A list of notes made on this service", "items": { "$ref": "#/components/schemas/Note" } }, "place": { "type": "array", "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place where the service is installed)", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "relatedEntity": { "type": "array", "description": "A list of related entity in relationship with this service ", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "relatedParty": { "type": "array", "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceCharacteristic": { "type": "array", "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", "items": { "$ref": "#/components/schemas/Characteristic" } }, "serviceOrderItem": { "type": "array", "description": "A list of service order items related to this service", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceRelationship": { "type": "array", "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecificationRef" }, "state": { "$ref": "#/components/schemas/ServiceStateType" }, "supportingResource": { "type": "array", "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "supportingService": { "type": "array", "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService." }, "ServiceCategoryRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "Category version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories." }, "ServiceEligibilityUnavailabilityReason": { "type": "object", "properties": { "code": { "type": "string", "description": "Unavailability reason code" }, "label": { "type": "string", "description": "Unavailability reason label" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)" }, "ServiceQualification": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the serviceQualification resource" }, "href": { "type": "string", "description": "Hyperlink to access the serviceQualification" }, "description": { "type": "string", "description": "Description of the serviceQualification" }, "effectiveQualificationDate": { "type": "string", "description": "Effective date to serviceQualification completion", "format": "date-time" }, "estimatedResponseDate": { "type": "string", "description": "Date when the requester expect to provide an answer for the qualification request.", "format": "date-time" }, "expectedQualificationDate": { "type": "string", "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification response expires", "format": "date-time" }, "externalId": { "type": "string", "description": "Identifier provided by the requester" }, "instantSyncQualification": { "type": "boolean", "description": "An indicator which when the value is \"true\" means that requester expects to get qualification result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." }, "relatedParty": { "type": "array", "description": "A list of related party references, defines party or party role linked to this request.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "state": { "$ref": "#/components/schemas/TaskStateType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...)." }, "ServiceQualificationItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the Service Qualification Item" }, "expectedActivationDate": { "type": "string", "description": "The date when the service is expected to be activated", "format": "date-time" }, "expectedServiceAvailabilityDate": { "type": "string", "description": "Date when the requester looks for service availability", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Date when the qualification item response expires", "format": "date-time" }, "category": { "$ref": "#/components/schemas/ServiceCategoryRef" }, "service": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation." }, "ServiceQualificationItemRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." }, "relationshipType": { "type": "string", "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification." }, "ServiceQualificationRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the target qualification pointed to by this relationship" }, "relationshipType": { "type": "string", "description": "The type of relationship" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "ServiceInventory": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/ServiceCategoryRef" }, "service": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A ServiceInventory relates to a existing services at the specific address." }, "ServiceRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Service reference, for when Service is used by other entities" }, "ServiceRefOrValue": { "type": "object", "properties": { "accountDetails": { "type": "array", "description": "A list of accounts associated with the existing service", "items": { "$ref": "#/components/schemas/AccountDetails" } }, "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "description": { "type": "string", "description": "Free-text description of the service" }, "endDate": { "type": "string", "description": "Date when the service ends", "format": "date-time" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isAvailable": { "type": "boolean", "description": "If true, the service is an existing service at the address. If false, the service is not an existing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierarchy. If false, the service is a 'atomic' service (hierarchy leaf)." }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "name": { "type": "string", "description": "Name of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "startDate": { "type": "string", "description": "Date when the service starts", "format": "date-time" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "feature": { "type": "array", "description": "A list of feature associated with this service ", "items": { "$ref": "#/components/schemas/Feature" } }, "note": { "type": "array", "description": "A list of notes made on this service", "items": { "$ref": "#/components/schemas/Note" } }, "place": { "type": "array", "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place where the service is installed)", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "relatedEntity": { "type": "array", "description": "A list of related entity in relationship with this service ", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "relatedParty": { "type": "array", "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceCharacteristic": { "type": "array", "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", "items": { "$ref": "#/components/schemas/Characteristic" } }, "serviceOrderItem": { "type": "array", "description": "A list of service order items related to this service", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceRelationship": { "type": "array", "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecificationRef" }, "state": { "$ref": "#/components/schemas/ServiceStateType" }, "supportingResource": { "type": "array", "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "supportingService": { "type": "array", "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself" }, "ServiceRelationship": { "required": [ "relationshipType" ], "type": "object", "properties": { "relationshipType": { "type": "string" }, "service": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "serviceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "ServiceSpecificationRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "Service specification version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification." }, "ServiceStateType": { "type": "string", "description": "Valid values for the lifecycle state of the service", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ] }, "TaskStateType": { "type": "string", "description": "Possible values for the state of a task", "enum": [ "accepted", "terminatedWithError", "inProgress", "done" ] }, "TerminationError": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the termination error" }, "value": { "type": "string", "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "This indicates an error that caused a qualificationItem to be terminated." }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format", "format": "date-time", "example": "1985-04-12T23:20:50.52Z" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format", "format": "date-time", "example": "1985-04-12T23:20:50.52Z" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "CheckServiceQualificationCreateEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CheckServiceQualificationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "CheckServiceQualificationCreateEventPayload": { "type": "object", "properties": { "checkServiceQualification": { "$ref": "#/components/schemas/CheckServiceQualification" } }, "description": "The event data structure" }, "CheckServiceQualificationAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/CheckServiceQualificationAttributeValueChangeEventPayload" } }, "description": "The notification data structure" }, "CheckServiceQualificationAttributeValueChangeEventPayload": { "type": "object", "properties": { "checkServiceQualification": { "$ref": "#/components/schemas/CheckServiceQualification" } }, "description": "The event data structure" }, "CheckServiceQualificationStateChangeEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CheckServiceQualificationStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "CheckServiceQualificationStateChangeEventPayload": { "type": "object", "properties": { "checkServiceQualification": { "$ref": "#/components/schemas/CheckServiceQualification" } }, "description": "The event data structure" }, "CheckServiceQualificationDeleteEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CheckServiceQualificationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "CheckServiceQualificationDeleteEventPayload": { "type": "object", "properties": { "checkServiceQualification": { "$ref": "#/components/schemas/CheckServiceQualification" } }, "description": "The event data structure" }, "CheckServiceQualificationInformationRequiredEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/CheckServiceQualificationInformationRequiredEventPayload" } }, "description": "The notification data structure" }, "CheckServiceQualificationInformationRequiredEventPayload": { "type": "object", "properties": { "checkServiceQualification": { "$ref": "#/components/schemas/CheckServiceQualification" } }, "description": "The event data structure" }, "QueryServiceQualificationCreateEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/QueryServiceQualificationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "QueryServiceQualificationCreateEventPayload": { "type": "object", "properties": { "queryServiceQualification": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "description": "The event data structure" }, "QueryServiceQualificationStateChangeEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/QueryServiceQualificationStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "QueryServiceQualificationStateChangeEventPayload": { "type": "object", "properties": { "queryServiceQualification": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "description": "The event data structure" }, "QueryServiceQualificationDeleteEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/QueryServiceQualificationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "description": "Time of the event occurrence.", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "description": "The time the event occurred.", "format": "date-time" } }, "description": "The notification data structure" }, "QueryServiceQualificationDeleteEventPayload": { "type": "object", "properties": { "queryServiceQualification": { "$ref": "#/components/schemas/QueryServiceQualification" } }, "description": "The event data structure" }, "ServiceAvailabilityResponse": { "type": "object", "properties": { "content": { "type": "object", "properties": { "serviceQualificationItem": { "type": "array", "items": { "type": "object", "properties": { "service": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "serviceType": { "type": "string" }, "serviceCharacteristic": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "valueType": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } } }, "Error": { "type": "object", "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "referenceError": { "type": "string", "description": "URI of documentation describing the error.", "format": "uri" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." } }, "required": [ "code", "reason" ] } }, "examples": { "BSSEFiberResponse": { "value": [ { "externalId": "SF", "state": "done", "queryServiceQualificationDate": "2024-10-28T17:38:44.506Z", "searchCriteria": { "service": { "place": [ { "id": "00000SM7NA", "role": "Service Address", "@type": null } ], "serviceCharacteristic": [ { "name": "DwellingType", "valueType": "string", "value": "SFU General" }, { "name": "OrderTransactionType", "valueType": "string", "value": "New" }, { "name": "RateZoneBandCode", "valueType": "string", "value": "825" }, { "name": "InstantHSIAOnIndicator", "valueType": "boolean", "value": false } ] } }, "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Fiber", "displayName": "AT&T Fiber", "name": "FIBER", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 }, { "name": "TransportTypes", "valueType": "string", "value": "FTTP-GPON" }, { "name": "UversePendingOrder", "valueType": "boolean", "value": false }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": false }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": 5000 }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": 5000 }, { "name": "LightGig", "valueType": "boolean", "value": false }, { "name": "MultiGig", "valueType": "boolean", "value": true }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": true }, { "name": "UverseEligible", "valueType": "boolean", "value": true }, { "name": "AvailableForSell", "valueType": "boolean", "value": true }, { "name": "OpticType", "valueType": "string", "value": "Standard" }, { "name": "HomeBasedBusiness", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "description": "AT&T Internet Air", "displayName": "AT&T Internet Air", "name": "WBB", "serviceType": "WBB", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 2 }, { "name": "TransportTypes", "valueType": "string", "value": "WBB_5G,WBB_Basic" }, { "name": "UversePendingOrder", "valueType": "boolean", "value": false }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "description": "AT&T Internet", "displayName": "AT&T Internet", "name": "HSIA", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 3 }, { "name": "UversePendingOrder", "valueType": "boolean", "value": false }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": false }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": 0 }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": 0 }, { "name": "LightSpeedEligible", "valueType": "boolean", "value": true }, { "name": "UverseEligible", "valueType": "boolean", "value": true }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": true }, { "name": "InternetBandwidthEligible", "valueType": "boolean", "value": false }, { "name": "IpdslInternetEligible", "valueType": "boolean", "value": false }, { "name": "IpdslEligible", "valueType": "boolean", "value": false }, { "name": "IpdslamBondedPairEligible", "valueType": "boolean", "value": false }, { "name": "AvailableForSell", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "DTV", "description": "DirectTV", "displayName": "DirectTV", "name": "DTV", "serviceType": "DTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "description": "AT&T IPTV", "displayName": "AT&T IPTV", "name": "IPTV", "serviceType": "IPTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 2 } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "description": "VOIP", "displayName": "VOIP", "name": "VOIP", "serviceType": "VOIP", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "POTS", "description": "AT&T POTS", "displayName": "AT&T POTS", "name": "POTS", "serviceType": "POTS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 2 } ], "state": "feasibilityChecked" } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "description": "Wireless", "displayName": "Wireless", "name": "WIRELESS", "serviceType": "WIRELESS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "description": "AT&T Fixed Wireless", "displayName": "AT&T Fixed Wireless", "name": "WLL", "serviceType": "WLL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "BUSINESS FIBER", "serviceType": "BUSINESS FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "description": "AT&T DSL", "displayName": "AT&T DSL", "name": "ADSL", "serviceType": "ADSL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "AIA-B", "description": "AT&T Internet Air - Business", "displayName": "AT&T Internet Air - Business", "name": "AIA-B", "serviceType": "AIA-B", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "IPDSL Voice", "description": "IPDSL Voice", "displayName": "IPDSL Voice", "name": "IPDSL Voice", "serviceType": "IPDSL Voice", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "Wireless Home Phone", "description": "Wireless Home Phone", "displayName": "Wireless Home Phone", "name": "Wireless Home Phone", "serviceType": "Wireless Home Phone", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "HOME SECURITY", "displayName": "Home Security" }, "service": { "category": "Digital Life", "description": "Digital Life", "displayName": "Digital Life", "name": "Digital Life", "serviceType": "Digital Life", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } } ], "serviceInventory": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "description": "AT&T DSL", "displayName": "AT&T DSL", "name": "ADSL", "serviceType": "ADSL", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "description": "AT&T Internet", "displayName": "AT&T Internet", "name": "HSIA", "serviceType": "HSIA", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "BUSINESS FIBER", "serviceType": "BUSINESS FIBER", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "description": "Wireless", "displayName": "Wireless", "name": "WIRELESS", "serviceType": "WIRELESS", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "description": "AT&T Fixed Wireless", "displayName": "AT&T Fixed Wireless", "name": "WLL", "serviceType": "WLL", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "description": "AT&T Internet Air", "displayName": "AT&T Internet Air", "name": "WBB", "serviceType": "WBB", "state": "feasibilityChecked", "available": true, "accountDetails": [ { "billingAccountNumber": "552303786443", "accountStatusCode": "pendingclosed", "migrationIndicator": false }, { "billingAccountNumber": "554822809086", "accountStatusCode": "pendingclosed", "migrationIndicator": false }, { "billingAccountNumber": "553715881354", "accountStatusCode": "pendingclosed", "migrationIndicator": false }, { "billingAccountNumber": "557138259843", "accountStatusCode": "pendingclosed", "migrationIndicator": false } ] } }, { "category": { "name": "TV" }, "service": { "category": "DTV", "description": "DirectTV", "displayName": "DirectTV", "name": "DTV", "serviceType": "DTV", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "UVERSE", "description": "AT&T Uverse", "displayName": "AT&T Uverse", "name": "UVERSE", "serviceType": "UVERSE", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "description": "VOIP", "displayName": "VOIP", "name": "VOIP", "serviceType": "VOIP", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "description": "AT&T IPTV", "displayName": "AT&T IPTV", "name": "IPTV", "serviceType": "IPTV", "state": "feasibilityChecked", "available": false } } ] } ] }, "queryServiceQualificationResponse-200": { "value": [ { "externalId": "WEB", "queryServiceQualificationDate": "2021-09-16T15:35:09.574Z", "relatedParty": [ { "id": "456", "href": "http://serverlocation:port/partyManagement/v4/party/456", "name": "John Smith", "role": "Buyer contact", "@type": "RelatedParty", "@referredType": "Individual" } ], "searchCriteria": { "service": { "place": [ { "id": "100001", "role": "Installation Place", "@type": "GeographicAddress" } ] } }, "serviceQualificationItem": [ { "category": { "name": "INTERNET" }, "service": { "category": "WBB", "description": "Wireless Broad Band", "name": "WBB", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "WLL", "description": "Wireless Local Loop", "name": "WLL", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" }, { "name": "priority", "valueType": "number", "value": "2" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV" }, "service": { "category": "LIGHTSPEED-CATEGORY", "description": "lightspeed", "name": "LIGHTSPEED", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "3" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV" }, "service": { "category": "IPTV", "description": "iptv", "name": "IPTV", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "QUALIFIED" }, { "name": "priority", "valueType": "number", "value": "4" } ], "state": "feasibilityChecked" } }, { "category": { "name": "VOIP" }, "service": { "category": "VOIP", "description": "Voice Over Internet Protocol", "name": "VOIP", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "UNQUALIFIED" }, { "name": "priority", "valueType": "number", "value": "5" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "HSIA", "description": "High Speed Internet Access", "name": "HSIA", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "6" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "ADSL", "description": "ADSL", "name": "ADSL", "serviceType": "string", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" }, { "name": "priority", "valueType": "number", "value": "7" } ], "state": "feasibilityChecked" } } ], "serviceInventory": [ { "category": { "name": "INTERNET" }, "service": { "category": "ADSL", "description": "ADSL", "name": "ADSL", "serviceType": "ADSL", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "8980980", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "HSIA", "description": "High Speed Internet Access", "name": "HSIA", "serviceType": "HSIA", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "UVERSE", "description": "AT&T Uverse", "name": "UVERSE", "serviceType": "UVERSE", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "148703536", "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": false, "migrationIneligibleReasons": [ { "code": "FIBER_AVAILABLE", "description": "Fiber available at location." }, { "code": "PENDING_DISCONNECT", "description": "Customer has pending disconnect.." } ] } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "WBB", "description": "Wireless BroadBand", "name": "WBB", "serviceType": "WBB", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "23986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET" }, "service": { "category": "WLL", "description": "Wireless Local Loop", "name": "WLL", "serviceType": "WLL", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "1423986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV" }, "service": { "category": "DTV", "description": "DTV", "name": "DTV", "serviceType": "DTV", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "51423986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV" }, "service": { "category": "IPTV", "description": "IPTV", "name": "IPTV", "serviceType": "IPTV", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "81423986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE" }, "service": { "category": "VOIP", "description": "VOIP", "name": "VOIP", "serviceType": "VOIP", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "91423986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } }, { "category": { "name": "WLS" }, "service": { "category": "WIRELESS", "description": "WIRELESS", "name": "WIRELESS", "serviceType": "WIRELESS", "isAvailable": true, "accountDetails": [ { "billingAccountNumber": "10423986576", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ], "state": "feasibilityChecked" } } ], "state": "accepted", "@baseType": "string", "@schemaLocation": "http://uri", "@type": "string" } ] }, "saveQualificationDetailsResponse-200": { "value": { "message": "Service Qualification Details Successfully Saved into Cassandra" } }, "saveQualificationDetailsResponse-200-1": { "value": { "qualificationId": "8e7f9eac-7126-4417-95b1-df1d4ba7eebb", "expiresAt": "2024-01-06T23:42:55Z" } }, "queryServiceQualificationResponse-400": { "value": { "code": "SQ-B40000", "reason": "Address Id Not Found", "message": "Address Id Not Found", "status": "400" } }, "ServiceQualificationDetailsResponse-400": { "value": { "code": "ServiceQualificationDetails-1003", "reason": "Qualification ID is null or invalid", "message": "Qualification ID is null or invalid", "status": "400" } }, "ServiceQualificationDetailsResponse-400-1": { "value": { "code": "SQ-V100001", "reason": "BAD REQUEST", "message": "Qualification Id is required", "status": "400" } }, "saveQualificationDetailsResponse-400": { "value": { "code": "SQ-B40000", "reason": "Address Id and Cart ID Not Found", "message": "Address Id and Cart ID Not Found", "status": "400" } }, "queryServiceQualificationResponse-500": { "value": { "code": "SQ-E50000", "reason": "Could not reach downstream system", "message": "Could not reach downstream system", "status": "500" } }, "ServiceQualificationByProductCategoryResponse-400": { "value": { "code": "SQ-V100001", "reason": "BAD REQUEST", "message": "ProductCategory is required", "status": "400" } }, "queryServiceQualificationBusinessResponse-200": { "value": [ { "externalId": "INLAP~APSQ~00012", "queryServiceQualificationDate": "2021-09-16T15:35:09.574Z", "relatedParty": [ { "id": "456", "href": "http://serverlocation:port/partyManagement/v4/party/456", "name": "John Smith", "role": "Buyer contact", "@type": "RelatedParty", "@referredType": "Individual" } ], "searchCriteria": { "service": { "place": [ { "id": "00ADDRESSID01", "role": "Installation Place", "@type": "GeographicAddress", "state": "WA", "city": "Bothell", "zipCode": 98011 } ], "serviceCharacteristic": [ { "name": "NetworkProvider", "valueType": "string", "value": "FiberCo" }, { "name": "DwellingType", "valueType": "string", "value": "SFU General" }, { "name": "AbfQualificationStatus", "valueType": "string", "value": "LG" }, { "name": "LastTransport", "valueType": "string", "value": "FTTP-EGPON" }, { "name": "RateZoneBandCode", "valueType": "string", "value": "807" }, { "name": "TitanExistingIndicator", "valueType": "boolean", "value": false }, { "name": "TitanPendingOrder", "valueType": "boolean", "value": false }, { "name": "InstantHSIAOnIndicator", "valueType": "boolean", "value": false }, { "name": "LivingUnitStatus", "valueType": "String", "value": "UNOCCUPIED" } ] } }, "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Fiber", "displayName": "AT&T Fiber", "name": "FIBER", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 }, { "name": "TransportTypes", "valueType": "String", "value": "FTTP-GPON" }, { "name": "NetworkTransportTypes", "valueType": "String", "value": "FTTP-GPON" }, { "name": "PreferredNetworkType", "valueType": "String", "value": "FTTP-GPON" }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": true }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": 5000 }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": 5000 }, { "name": "MultiGig", "valueType": "boolean", "value": true }, { "name": "OpticType", "valueType": "String", "value": "Standard" }, { "name": "OntCategory", "valueType": "String", "value": "INTERNAL" }, { "name": "UverseEligible", "valueType": "boolean", "value": true }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": true }, { "name": "AvailableForSell", "valueType": "boolean", "value": true }, { "name": "HomeBasedBusiness", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "description": "AT&T Internet Air", "displayName": "AT&T Internet Air", "name": "WBB", "serviceType": "WBB", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 2 }, { "name": "TransportTypes", "valueType": "object", "value": "WBB_5G,WBB_BASIC" }, { "name": "NetworkTransportTypes", "valueType": "String", "value": "WBB_5G,WBB_BASIC" }, { "name": "PreferredNetworkType", "valueType": "String", "value": "WBB_5G" }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "description": "AT&T Internet", "displayName": "AT&T Internet", "name": "HSIA", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 3 }, { "name": "TransportTypes", "valueType": "String", "value": "IT-RT,IP-RT_BP,FTTN,FTTN-BP" }, { "name": "NetworkTransportTypes", "valueType": "String", "value": "IT-RT,IP-RT_BP,FTTN,FTTN-BP" }, { "name": "PreferredNetworkType", "valueType": "String", "value": "FTTN" }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": true }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": 50 }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": 0 }, { "name": "LightSpeeedEligible", "valueType": "boolean", "value": true }, { "name": "UverseEligible", "valueType": "boolean", "value": true }, { "name": "GFastDeviceWireType", "valueType": "String", "value": "G.FAST.106.CX" }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": true }, { "name": "UversePendingOrder", "valueType": "String", "value": "Y" }, { "name": "InternetBandwidthEligible", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "description": "AT&T Fixed Wireless", "displayName": "AT&T Fixed Wireless", "name": "WLL", "serviceType": "WLL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 4 }, { "name": "WLLDataEligible", "valueType": "boolean", "value": true }, { "name": "WLLVoiceligible", "valueType": "boolean", "value": true } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "AIA-B", "description": "AT&T Internet Air - Business", "displayName": "AT&T Internet Air - Business", "name": "AIA-B", "serviceType": "AIA-B", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "TransportTypes", "valueType": "string", "value": "AIA-B 5G" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "DTV", "description": "DirectTV", "displayName": "DirectTV", "name": "DTV", "serviceType": "DTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "description": "VOIP", "displayName": "VOIP", "name": "VOIP", "serviceType": "VOIP", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "description": "Wireless", "displayName": "Wireless", "name": "WIRELESS", "serviceType": "WIRELESS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": 1 } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "BUSINESS FIBER", "serviceType": "BUSINESS FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "description": "AT&T DSL", "displayName": "AT&T DSL", "name": "ADSL", "serviceType": "ADSL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "description": "AT&T IPTV", "displayName": "AT&T IPTV", "name": "IPTV", "serviceType": "IPTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "POTS", "description": "AT&T POTS", "displayName": "AT&T POTS", "name": "POTS", "serviceType": "POTS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "WirelessHomePhone", "description": "Wireless Home Phone", "displayName": "Wireless Home Phone", "name": "WirelessHomePhone", "serviceType": "WirelessHomePhone", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "IPDSL Voice", "description": "IPDSL Voice", "displayName": "IPDSL Voice", "name": "IPDSL Voice", "serviceType": "IPDSL Voice", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "HOME SECURITY", "displayName": "Home Security" }, "service": { "category": "Digital Life", "description": "Digital Life", "displayName": "Digital Life", "name": "Digital Life", "serviceType": "Digital Life", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } } ], "serviceInventory": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "description": "AT&T DSL", "displayName": "AT&T DSL", "name": "ADSL", "serviceType": "ADSL", "state": "feasibilityChecked", "available": true, "transportType": "FTTP-GPON", "accountDetails": [ { "billingAccountNumber": "8172950907478", "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": true } ] } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "description": "Wireless", "displayName": "Wireless", "name": "WIRELESS", "serviceType": "WIRELESS", "state": "feasibilityChecked", "available": true, "transportType": "FTTP-GPON", "accountDetails": [ { "billingAccountNumber": "302352016", "accountStatusCode": "O", "customerTypeCode": "R", "migrationIndicator": false } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "description": "AT&T Internet", "displayName": "AT&T Internet", "name": "HSIA", "serviceType": "HSIA", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "description": "AT&T Fixed Wireless", "displayName": "AT&T Fixed Wireless", "name": "WLL", "serviceType": "WLL", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "WBB", "serviceType": "WBB", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "DTV", "description": "DirectTV", "displayName": "DirectTV", "name": "DTV", "serviceType": "DTV", "state": "feasibilityChecked", "available": true, "accountDetails": [ { "billingAccountNumber": "263212112", "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": false } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "Business Fiber", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "Business Fiber", "serviceType": "Business Fiber", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "description": "AT&T IPTV", "displayName": "AT&T IPTV", "name": "IPTV", "serviceType": "IPTV", "state": "feasibilityChecked", "available": false } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "description": "VOIP", "displayName": "VOIP", "name": "VOIP", "serviceType": "VOIP", "state": "feasibilityChecked", "available": false } } ], "state": "accepted", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ] } } } }