--- title: Technical Service Qualification Open API description: The Technical Service Qualification Open API provides endpoints to check the availability of resources and services before submitting orders for fulfillment.Retrieves a technical qualification request that is associated with a given customer order ID.Retrieves a list of all technical qualification requests.Creates a technical service qualification request entity containing a list of qualification items.Processes a technical service qualification result sent to the Technical Service Qualification Open API. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/api-reference/rest-apis/ts-qualification-api.html release: australia product: REST APIs classification: rest-apis topic_type: concept last_updated: "2026-03-12" reading_time_minutes: 50 breadcrumb: [REST API reference, API reference, API implementation and reference] --- # Technical Service Qualification Open API The Technical Service Qualification Open API provides endpoints to check the availability of resources and services before submitting orders for fulfillment. This API is a ServiceNow implementation of the TMF645 Service Qualification API REST Specification. For more information about service qualification requests, see [Service qualification requests](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/order-management/order-mgt-tsq-about.md). The Technical Service Qualification Open API is provided within the `sn_ord_qual_mgmt` namespace and requires the following plugins: - Product Catalog Management Core \[com.sn\_prd\_pm\] - Product Catalog Advanced \[com.sn\_prd\_pm\_adv\] - Order Qualification Management \[com.sn\_ord\_qual\_mgmt\] - Order Management for Telecom, Media & Tech \[com.sn\_tmt\_core\] - Telecom Core \[com.sn\_tmt\_core\] The sn\_ind\_tmt\_orm.order\_integrator role is required to use this API. **Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md) ## Technical Service Qualification Open API - GET sn\_ord\_qual\_mgmt/qualification/checkServiceQualification/\{id\} Retrieves a technical qualification request that is associated with a given customer order ID. This endpoint retrieves order information from the following tables: - Customer Order \[sn\_ind\_tmt\_orm\_order\] - Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] ### URL format Default URL: `/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}` ### Supported request parameters
| Name | Description |
|---|---|
| id | Sys\_id of the qualification customer order to retrieve.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Name | Description |
|---|---|
| id | Sys\_id of the qualification customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| href | Relative link to the qualification order record. Data type: String |
| description | Description of the qualification request which is fetched from the short\_description field of the customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| externalId | External ID of the customer order. Data type: String Table: in the external\_id field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table. |
| qualificationResult | Qualification status of the result field of the customer order. Possible values: - alternate - none - pending - qualified - unqualified Data type: String |
| state | State of customer order from the status field of customer order.Data type: String |
| @type | Part of TMF Open API standard. Annotation for the qualification. This value is always `CheckServiceQualification`. This information is not stored.Data type: String |
| checkServiceQualificationDate | Date and time the qualification request that was created from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| effectiveQualificationDate | Effective qualification date fetched from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| expectedQualificationDate | Stores the expected qualification date. Persisted in expected\_end\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| relatedParty | List of contacts for the qualification request. Each contact is an object in the array.Data type: Array of Objects ``` "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] ``` |
| relatedParty.id | Sys\_id or external\_id of the account, customer contact, or consumer associated with the order.Data type: String Table: Account \[customer\_account\] table, Contact \[customer\_contact\] table, or Consumer \[csm\_consumer\] |
| relatedParty.name | Name of the account, customer, or consumer.Data type: String |
| relatedParty.@type | Part of TMF Open API standard. Annotation for the order line item contact. This value is always `RelatedParty`. This information is not stored.Data type: String |
| relatedParty.@referredType | Type of related party.Possible values: - Consumer - Customer - CustomerContact Data type: String |
| serviceQualificationItem | List of service qualification items containing information about location, service information, and service characteristics. Stored as order line items for the customer order. Data type: Array of Objects ``` "serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ] ``` |
| serviceQualificationItem.id | ID of the qualification item.Data type: String Stored in: The external\_id field of customer order line item in the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. |
| serviceQualificationItem.qualificationResult | Result of qualification item. Stored in the ‘result’ field of customer order line item. Possible values: - alternate - none - pending - qualified - unqualified Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.state | State of qualification item derived from the ‘status’ field of customer order line item. Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.quantity | Quantity of qualification item derived from the ‘quantity’ field of customer order line item.Data type: Number Table:Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.@type | Part of TMF Open API standard. Annotation for the qualification item. This value is always ServiceQualificationItem. This information is not stored.Data type: String |
| serviceQualificationItem.service | Service information which includes details about location \(place\), service specifications, and service characteristics.Data type: Object ``` "service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} } ``` |
| serviceQualificationItem.service.@type | Part of TMF Open API standard. Annotation for the service. This value is always `Service`. This information is not stored. Data type: String |
| serviceQualificationItem.service.place | Location information for the service qualification item.Data type: Array of Objects **Note:** This array can contain only one location. ``` "place": [ { "id": "String", "name": "String", "@referredType": "String" } ] ``` |
| serviceQualificationItem.service.place.id | Sys\_id of the location.Data type: String Table: Location \[cmn\_location\] |
| serviceQualificationItem.service.place.name | Name of the location. Not verified against an entry in the Location \[cmn\_location\] table.Data type: String |
| serviceQualificationItem.service.place.@type | Part of TMF Open API standard. Annotation for Service. This value is always `GeographicSite`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceSpecification | Service specification details for the qualification item.Data type: Array of Objects ``` "serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", } ``` |
| serviceQualificationItem.service.serviceSpecification.id | External ID or initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.name | Name of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.version | External version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.internalVersion | Internal version of the service specification.Data type: Number |
| serviceQualificationItem.service.serviceSpecification.internalId | Initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic | List of service characteristics.Data type: Array of objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem.service.serviceCharacteristic.valueType | Value type of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.name | Name of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.value | Value of the characteristic.Data type: String |
| ServiceQualificationItem.alternateServiceProposal | Alternate service proposal for the qualification order.Data type: String Stored in: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.id | Sys\_id of the alternate proposal record.Data type: String Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | The available\_date field value of the alternate proposal entry in the Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table.Data type: String |
| serviceQualificationItem.alternateServiceProposal.alternateService | Service information represented by the alternate proposal.Data type: Object |
| serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification | Service specification of the alternate proposal persisted in specification.Data type: Object Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id | External ID or initial version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name | Name of the alternate service specification. Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version | External version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion | Internal version of the alternate service specification.Data type: Number |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId | Initial version of the alternate service specification.Data type: String |
| ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic | List of service characteristics for the alternate service proposal.Data type: Array of Objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType | Value type of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name | Name of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value | Value of the alternate service characteristic.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason | List of service eligibility unavailability reasons to explain why the service is not available. Data type: Array Stored in: The unavailability\_reason field of the Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\] table. |
| serviceQualificationItem.eligibilityUnavailabilityReason.code | Service eligibility unavailability reason code.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason.label | Service eligibility unavailability reason label.Data type: String |
| Parameter | Description |
|---|---|
| description | Filters qualification orders by the 'short\_description' field of the customer order. Only orders with a short description matching the value of this parameter are returned in the response.Data type: String |
| fields | List of field names to return in the response. Invalid fields are ignored. If this parameter is not provided in the request, all fields are returned.Data type: String, comma separated |
| limit | Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval.Default: 20 Maximum: 100 Data type: Number |
| qualificationResult | Filters qualification orders by result. Only orders with a result matching the value of this parameter are returned in the response.Data type: String |
| state | Filters qualification orders by state. Only orders with a state matching the value of this parameter are returned in the response.Data type: String |
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Status code | Description |
|---|---|
| 200 | Request successfully processed. Full resource returned in response \(no pagination\). |
| 206 | Partial resource returned in response \(with pagination\). |
| 400 | Bad request. Possible reasons:- Invalid path parameter - Invalid URI |
| 404 | No record found for the filter criteria. |
| Name | Description |
|---|---|
| id | Sys\_id of the qualification customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| href | Relative link to the qualification order record. Data type: String |
| description | Description of the qualification request which is fetched from the short\_description field of the customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| externalId | External ID of the customer order. Data type: String Table: in the external\_id field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table. |
| qualificationResult | Qualification status of the result field of the customer order. Possible values: - alternate - none - pending - qualified - unqualified Data type: String |
| state | State of customer order from the status field of customer order.Data type: String |
| @type | Part of TMF Open API standard. Annotation for the qualification. This value is always `CheckServiceQualification`. This information is not stored.Data type: String |
| checkServiceQualificationDate | Date and time the qualification request that was created from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| effectiveQualificationDate | Effective qualification date fetched from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| expectedQualificationDate | Stores the expected qualification date. Persisted in expected\_end\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| relatedParty | List of contacts for the qualification request. Each contact is an object in the array.Data type: Array of Objects ``` "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] ``` |
| relatedParty.id | Sys\_id or external\_id of the account, customer contact, or consumer associated with the order.Data type: String Table: Account \[customer\_account\] table, Contact \[customer\_contact\] table, or Consumer \[csm\_consumer\] |
| relatedParty.name | Name of the account, customer, or consumer.Data type: String |
| relatedParty.@type | Part of TMF Open API standard. Annotation for the order line item contact. This value is always `RelatedParty`. This information is not stored.Data type: String |
| relatedParty.@referredType | Type of related party.Possible values: - Consumer - Customer - CustomerContact Data type: String |
| serviceQualificationItem | List of service qualification items containing information about location, service information, and service characteristics. Stored as order line items for the customer order. Data type: Array of Objects ``` "serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ] ``` |
| serviceQualificationItem.id | ID of the qualification item.Data type: String Stored in: The external\_id field of customer order line item in the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. |
| serviceQualificationItem.qualificationResult | Result of qualification item. Stored in the ‘result’ field of customer order line item. Possible values: - alternate - none - pending - qualified - unqualified Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.state | State of qualification item derived from the ‘status’ field of customer order line item. Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.quantity | Quantity of qualification item derived from the ‘quantity’ field of customer order line item.Data type: Number Table:Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.@type | Part of TMF Open API standard. Annotation for the qualification item. This value is always ServiceQualificationItem. This information is not stored.Data type: String |
| serviceQualificationItem.service | Service information which includes details about location \(place\), service specifications, and service characteristics.Data type: Object ``` "service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} } ``` |
| serviceQualificationItem.service.@type | Part of TMF Open API standard. Annotation for the service. This value is always `Service`. This information is not stored. Data type: String |
| serviceQualificationItem.service.place | Location information for the service qualification item.Data type: Array of Objects **Note:** This array can contain only one location. ``` "place": [ { "id": "String", "name": "String", "@referredType": "String" } ] ``` |
| serviceQualificationItem.service.place.id | Sys\_id of the location.Data type: String Table: Location \[cmn\_location\] |
| serviceQualificationItem.service.place.name | Name of the location. Not verified against an entry in the Location \[cmn\_location\] table.Data type: String |
| serviceQualificationItem.service.place.@type | Part of TMF Open API standard. Annotation for Service. This value is always `GeographicSite`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceSpecification | Service specification details for the qualification item.Data type: Array of Objects ``` "serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", } ``` |
| serviceQualificationItem.service.serviceSpecification.id | External ID or initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.name | Name of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.version | External version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.internalVersion | Internal version of the service specification.Data type: Number |
| serviceQualificationItem.service.serviceSpecification.internalId | Initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic | List of service characteristics.Data type: Array of objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem.service.serviceCharacteristic.valueType | Value type of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.name | Name of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.value | Value of the characteristic.Data type: String |
| ServiceQualificationItem.alternateServiceProposal | Alternate service proposal for the qualification order.Data type: String Stored in: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.id | Sys\_id of the alternate proposal record.Data type: String Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | The available\_date field value of the alternate proposal entry in the Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table.Data type: String |
| serviceQualificationItem.alternateServiceProposal.alternateService | Service information represented by the alternate proposal.Data type: Object |
| serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification | Service specification of the alternate proposal persisted in specification.Data type: Object Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id | External ID or initial version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name | Name of the alternate service specification. Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version | External version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion | Internal version of the alternate service specification.Data type: Number |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId | Initial version of the alternate service specification.Data type: String |
| ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic | List of service characteristics for the alternate service proposal.Data type: Array of Objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType | Value type of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name | Name of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value | Value of the alternate service characteristic.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason | List of service eligibility unavailability reasons to explain why the service is not available. Data type: Array Stored in: The unavailability\_reason field of the Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\] table. |
| serviceQualificationItem.eligibilityUnavailabilityReason.code | Service eligibility unavailability reason code.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason.label | Service eligibility unavailability reason label.Data type: String |
| Parameter | Description |
|---|---|
| @type | Optional. Part of TMF Open API standard. Annotation for the qualification. This value is always `CheckServiceQualification`. This information is not stored.Data type: String |
| checkServiceQualificationDate | Optional. The date and time the qualification request was created. Located in the order\_date field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table. If not specified, order\_date is set to the current date and time. Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ |
| description | Optional. The description of the qualification request. Located in the ‘short\_description’ field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table.Data type: String Maximum character length: 100 |
| effectiveQualificationDate | Optional. The date that the qualification is effective. Persisted in ‘actual\_end\_date’ field of the customer order of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ |
| expectedQualificationDate | Optional. The expected qualification date. Persisted in expected\_end\_date’ field of the customer order. Located in the Customer Order \[sn\_ind\_tmt\_orm\_order\] table.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ |
| externalId | Optional. External ID assigned of the customer order. Persisted in the external\_id field of the customer order of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table.Data type: String |
| relatedParty | List of contacts for the qualification request. Each contact is an object in the array. Must list at least one item which contains customer account, customer contact, or consumer account information.Data type: Array of Objects ``` "relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ] ``` |
| relatedParty.@referredType | Type of related party.Possible values: - consumer - customer - customerContact Data type: String |
| relatedParty.@type | Optional. Part of TMF Open API standard. Annotation for the order line item contact. This value is always `RelatedParty`. This information is not stored.Data type: String |
| relatedParty.id | The sys\_id or external\_id, if applicable, of the related party. Located in the Account \[customer\_account\] table, Contact \[customer\_contact\] table, or Consumer \[csm\_consumer\] table.Data type: String |
| relatedParty.name | Name of the account, customer, or consumer.Data type: String |
| serviceQualificationItem | List of service qualification items with location, service information, and characteristics. Stored as order line items for the customer order. Must include at least one service qualification item in the list.Data type: Array of objects ``` "serviceQualificationItem": [{ "@type": "String", "id": "String", "qualificationResult": "String", "quantity": "Number", "service": {Object}, "state": "String" ] ``` |
| serviceQualificationItem.@type | Optional. Part of TMF Open API standard. Annotation for qualification item. This value is always `ServiceQualificationItem`. This information is not stored.Data Type: String |
| serviceQualificationItem.qualificationItemRelationship | Optional. List of relationships with other service qualification items in the same request. This information helps to create order line items with a parent order line item.Data type: Array of objects ``` "qualificationItemRelationship": [ { "id": "String" "relationshipType": "String" } ] ``` |
| serviceQualificationItem.qualificationItemRelationship.id | Required. The ID of the target qualification item in the relationship.Data Type: String |
| serviceQualificationItem.qualificationItemRelationship.relationshipType | Required. The type of line item relationship.Valid values: - HasChild: indicates the child item. - HasParent:indicates the parent item. Data Type: String |
| serviceQualificationItem.quantity | Optional. Quantity of the qualification item. Persisted in the ‘quantity’ field of customer order line item.Data type: Number Default if not specified: 1 |
| serviceQualificationItem.service | Required. Service information which can include such variables as place, service specification, and service characteristics.Data Type: Object ``` "service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} } ``` |
| serviceQualificationItem.service.@type | Optional. Part of TMF Open API standard. Annotation for Service information for qualification item. This value is always `Service`. This information is not stored.Data Type: String |
| serviceQualificationItem.service.place | Optional. The requested location information for the service qualification item. Located in the Location \[cmn\_location\] table.**Note:** Even though array is supported, it must contain only one location. Data Type: Array of objects ``` "place": [ { "@type": "String" "id": "String", "name": "String" } ] ``` |
| serviceQualificationItem.service.place.@type | Optional. Part of TMF Open API standard. Annotation for Service. This value is always `GeographicSite`. This information is not stored.Data Type: String |
| serviceQualificationItem.service.place.id | Required. Sys\_id of a location in the Location \[cmn\_location\] table. This location ID should be a valid entry in the Location \[cmn\_location\] table. Data Type: String |
| serviceQualificationItem.service.place.name | Optional. Name of the location. This value is not verified against entries in the Location \[cmn\_location\] table.Data Type: String |
| serviceQualificationItem.service.referenceServiceInventory | Required. Valid service inventory entity which refers to an active service for the required location. The location information for the qualification order is obtained from this service inventory's location. **Important:** Use the **referenceServiceInventory** object to qualify a new service at the same location of an existing and active Access service. To do so, you must also omit the **place** array and **serviceInventory** object from your request, otherwise the API returns an error. Data type: Object ``` "referenceServiceInventory": { "id": "String" } ``` |
| serviceQualificationItem.service.referenceServiceInventory.id | Required if using **serviceQualificationItem.service.referenceServiceInventory** in the request. The sys\_id of a valid service inventory entity which refers to an active service for the required location. This information is mentioned only in the order work notes.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic | Optional. Array of service characteristics.Data Type: Array of objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String", } ] ``` |
| serviceQualificationItem.service.serviceCharacteristic.name | Required. Name of the characteristic.Data Type: String |
| serviceQualificationItem.service.serviceCharacteristic.value | Optional. Value of the characteristic. Part of TMF Open API standard. Annotation for Qualification item. This value is always `ServiceQualificationItem`. This information is not stored.Data Type: String |
| serviceQualificationItem.service.serviceCharacteristic.valueType | Optional. Value type of the characteristic. Data Type: String |
| serviceQualificationItem.service.serviceInventory | Optional. Valid service inventory entity which refers to an active service needing an upgrade or downgrade. **Important:** Use the **serviceInventory** object for service upgrades or downgrades. To do so, you must omit the place **array** and **referenceServiceInventory** object from your request, otherwise the API returns an error. Data type: Object ``` "serviceInventory": { "id": "String" } ``` |
| serviceQualificationItem.service.serviceSpecification | Required. Service specification for the qualification item. Stored in the service\_specification field of the customer order line item in the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. Service specifications for a qualification item can't be resource-facing.Data Type: Object ``` "serviceSpecification": { “@type”: ”String”, "id": "String", "name": "String" } ``` |
| serviceQualificationItem.service.serviceSpecification.@type | Optional. Part of TMF Open API standard. Annotation for the service specification. This value is always `ServiceSpecification`. This information is not stored.Data Type: String |
| serviceQualificationItem.service.serviceSpecification.id | Required. External ID or initial version of the service specification.Data Type: String |
| serviceQualificationItem.service.serviceSpecification.internalVersion | Optional. Internal version of the service specification.Data Type: Number |
| serviceQualificationItem.service.serviceSpecification.name | Required. Name of the service specification.Data Type: String |
| serviceQualificationItem.service.serviceSpecification.version | Optional. External version of the service specification.Data Type: String |
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Content-Type | Data format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Status code | Description |
|---|---|
| 201 | Request successfully processed.**Note:** If there are any issues with the characteristics or characteristics option information, the endpoint stores the following comments in the work notes fields of the associated Customer Order Line Item record similar to existing delivery orders |
| 400 | Bad Request. Could be any of the following reasons: - Empty payload. - Invalid payload: Mandatory field missing: <field name> - Invalid payload: Request body missing - Payload was not passed in the request body. - Invalid payload: relatedParty is missing. - Invalid payload: serviceQualificationItem is missing. - Invalid payload: serviceQualificationItem id is missing. - Invalid payload: serviceQualificationItem service is missing. - Invalid payload: The location information is missing. Please provide place, serviceInventory or referenceServiceInventory. - Invalid payload: The specification information is missing, please provide serviceSpecification or serviceInventory. - Invalid payload: Service Specification does not exist. - Invalid payload: Customer Account does not exist. - Invalid payload: Consumer does not exist. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
| Element | Description |
|---|---|
| id | Sys\_id of the qualification customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| href | Relative link to the qualification order record. Data type: String |
| description | Description of the qualification request which is fetched from the short\_description field of the customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| externalId | External ID of the customer order. Data type: String Table: in the external\_id field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table. |
| qualificationResult | Qualification status of the result field of the customer order. Possible values: - alternate - none - pending - qualified - unqualified Data type: String |
| state | State of customer order from the status field of customer order.Data type: String |
| @type | Part of TMF Open API standard. Annotation for the qualification. This value is always `CheckServiceQualification`. This information is not stored.Data type: String |
| checkServiceQualificationDate | Date and time the qualification request that was created from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| effectiveQualificationDate | Effective qualification date fetched from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| expectedQualificationDate | Stores the expected qualification date. Persisted in expected\_end\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| relatedParty | List of contacts for the qualification request. Each contact is an object in the array.Data type: Array of Objects ``` "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] ``` |
| relatedParty.id | Sys\_id or external\_id of the account, customer contact, or consumer associated with the order.Data type: String Table: Account \[customer\_account\] table, Contact \[customer\_contact\] table, or Consumer \[csm\_consumer\] |
| relatedParty.name | Name of the account, customer, or consumer.Data type: String |
| relatedParty.@type | Part of TMF Open API standard. Annotation for the order line item contact. This value is always `RelatedParty`. This information is not stored.Data type: String |
| relatedParty.@referredType | Type of related party.Possible values: - Consumer - Customer - CustomerContact Data type: String |
| serviceQualificationItem | List of service qualification items containing information about location, service information, and service characteristics. Stored as order line items for the customer order. Data type: Array of Objects ``` "serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ] ``` |
| serviceQualificationItem.id | ID of the qualification item.Data type: String Stored in: The external\_id field of customer order line item in the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. |
| serviceQualificationItem.qualificationResult | Result of qualification item. Stored in the ‘result’ field of customer order line item. Possible values: - alternate - none - pending - qualified - unqualified Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.state | State of qualification item derived from the ‘status’ field of customer order line item. Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.quantity | Quantity of qualification item derived from the ‘quantity’ field of customer order line item.Data type: Number Table:Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.@type | Part of TMF Open API standard. Annotation for the qualification item. This value is always ServiceQualificationItem. This information is not stored.Data type: String |
| serviceQualificationItem.service | Service information which includes details about location \(place\), service specifications, and service characteristics.Data type: Object ``` "service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} } ``` |
| serviceQualificationItem.service.@type | Part of TMF Open API standard. Annotation for the service. This value is always `Service`. This information is not stored. Data type: String |
| serviceQualificationItem.service.place | Location information for the service qualification item.Data type: Array of Objects **Note:** This array can contain only one location. ``` "place": [ { "id": "String", "name": "String", "@referredType": "String" } ] ``` |
| serviceQualificationItem.service.place.id | Sys\_id of the location.Data type: String Table: Location \[cmn\_location\] |
| serviceQualificationItem.service.place.name | Name of the location. Not verified against an entry in the Location \[cmn\_location\] table.Data type: String |
| serviceQualificationItem.service.place.@type | Part of TMF Open API standard. Annotation for Service. This value is always `GeographicSite`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceSpecification | Service specification details for the qualification item.Data type: Array of Objects ``` "serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", } ``` |
| serviceQualificationItem.service.serviceSpecification.id | External ID or initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.name | Name of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.version | External version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.internalVersion | Internal version of the service specification.Data type: Number |
| serviceQualificationItem.service.serviceSpecification.internalId | Initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic | List of service characteristics.Data type: Array of objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem.service.serviceCharacteristic.valueType | Value type of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.name | Name of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.value | Value of the characteristic.Data type: String |
| Parameter | Description |
|---|---|
| serviceQualificationItem | Required. List of Service Qualification Items each representing a domain order in the Service Order table \[sn\_ind\_tmt\_orm\_service\_order\] for the requested top order line item. All domain orders represented by each of the service qualification items must belong to the same top order line item.Data type: Array of Objects ``` "serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ] ``` |
| serviceQualificationItem.@type | Optional. Part of TMF Open API standard. Annotation for qualification item. This value is always `ServiceQualificationItem`. This information is not stored.Data Type: String |
| serviceQualificationItem.alternateProposal | Alternate Proposals provided for the qualification item.Data type: Array of Objects ``` "alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ] ``` Stored in: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| serviceQualificationItem.alternateProposal.@type | Part of TMF Open API standard. Annotation for Service information for the qualification item. This value is always `Service`. This information is not stored.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService | Required. Service information for the alternate proposal containing service specifications and characteristics.Data type: Object ``` "alternateService": { "@type": "String", "serviceSpecification": {Object}, "serviceCharacteristic": [Array] } ``` |
| serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType | Value type of the characteristic under the alternate service proposal. Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic | Service characteristics for the alternate service proposal.Data type: Array of Objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` Stored in: The order\_characteristics field of the Alternate proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table. |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name | Required. Name of the characteristic belonging to the alternate service proposal. Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value | Value of the characteristic belonging to the alternate service proposal.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.valueType | Type of characteristic.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService .serviceSpecification | Required. Service Specification for the alternate proposal.Data type: Object ``` "serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" } ``` Stored in: The specification field of the alternate proposal entry of the Alternate proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table. |
| serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type | Part of TMF Open API standard. Annotation for the Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id | Required. External ID or initial version of the service specification.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion | Internal version of the service specification.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name | Name of the service specification.Data type: String |
| serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version | External version of the service specification.Data type: String |
| serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate | Alternate service availability date. Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: In the available\_date field of the Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table, where the domain order information belongs to the domain order represented by the current service qualification item. |
| serviceQualificationItem.alternateProposal.id | User-defined ID for the alternate proposal. This data is not persisted.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason | Reason for why the service qualification is not eligible.Data type: Object ``` "eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ] ``` Stored in: The entire list of reasons is persisted with their label fields as a string in the unavailability\_reason field of the Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\] table. |
| serviceQualificationItem.eligibilityUnavailabilityReason.code | Code for the eligibility unavailability reason. This information is not persisted.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason.label | Required. Label for the eligibility unavailability reason. If there are multiple ineligibility reasons, the labels are separated by a comma.Data type: String Stored in: The unavailability\_reason field of the Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\] table. |
| serviceQualificationItem.id | Required. Sys\_id of the domain order represented by the qualification item. Data type: String Stored in: Sys\_id field of the Domain Order \[sn\_ind\_tmt\_orm\_service\_order\] table. |
| serviceQualificationItem.qualificationResult | Required. Qualification Result for each service qualification item. Data type: String Stored in: The result field of the Domain Order table \[sn\_ind\_tmt\_orm\_service\_order\]. |
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Status code | Description |
|---|---|
| 201 | Successful. The request was successfully processed. |
| 400 | Bad Request. Could be any of the following reasons: - Invalid payload: Qualification Result should be one of \[alternate, pending, qualified, unqualified\]. - Invalid payload: Qualification Item id does not exist. - All Qualification Items must belong to same Top Order Line Item. - Invalid payload: serviceQualificationItem qualificationResult is missing. - Invalid payload: Consumer does not exist. |
| Name | Description |
|---|---|
| id | Sys\_id of the qualification customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| href | Relative link to the qualification order record. Data type: String |
| description | Description of the qualification request which is fetched from the short\_description field of the customer order.Data type: String Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| externalId | External ID of the customer order. Data type: String Table: in the external\_id field of the Customer Order \[sn\_ind\_tmt\_orm\_order\] table. |
| qualificationResult | Qualification status of the result field of the customer order. Possible values: - alternate - none - pending - qualified - unqualified Data type: String |
| state | State of customer order from the status field of customer order.Data type: String |
| @type | Part of TMF Open API standard. Annotation for the qualification. This value is always `CheckServiceQualification`. This information is not stored.Data type: String |
| checkServiceQualificationDate | Date and time the qualification request that was created from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| effectiveQualificationDate | Effective qualification date fetched from the order\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| expectedQualificationDate | Stores the expected qualification date. Persisted in expected\_end\_date field of the customer order.Data type: String Format: YYYY-MM-DDTHH:MM:SS.SSSZ Table: Customer Order \[sn\_ind\_tmt\_orm\_order\] |
| relatedParty | List of contacts for the qualification request. Each contact is an object in the array.Data type: Array of Objects ``` "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] ``` |
| relatedParty.id | Sys\_id or external\_id of the account, customer contact, or consumer associated with the order.Data type: String Table: Account \[customer\_account\] table, Contact \[customer\_contact\] table, or Consumer \[csm\_consumer\] |
| relatedParty.name | Name of the account, customer, or consumer.Data type: String |
| relatedParty.@type | Part of TMF Open API standard. Annotation for the order line item contact. This value is always `RelatedParty`. This information is not stored.Data type: String |
| relatedParty.@referredType | Type of related party.Possible values: - Consumer - Customer - CustomerContact Data type: String |
| serviceQualificationItem | List of service qualification items containing information about location, service information, and service characteristics. Stored as order line items for the customer order. Data type: Array of Objects ``` "serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ] ``` |
| serviceQualificationItem.id | ID of the qualification item.Data type: String Stored in: The external\_id field of customer order line item in the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. |
| serviceQualificationItem.qualificationResult | Result of qualification item. Stored in the ‘result’ field of customer order line item. Possible values: - alternate - none - pending - qualified - unqualified Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.state | State of qualification item derived from the ‘status’ field of customer order line item. Data type: String Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.quantity | Quantity of qualification item derived from the ‘quantity’ field of customer order line item.Data type: Number Table:Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] |
| serviceQualificationItem.@type | Part of TMF Open API standard. Annotation for the qualification item. This value is always ServiceQualificationItem. This information is not stored.Data type: String |
| serviceQualificationItem.service | Service information which includes details about location \(place\), service specifications, and service characteristics.Data type: Object ``` "service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} } ``` |
| serviceQualificationItem.service.@type | Part of TMF Open API standard. Annotation for the service. This value is always `Service`. This information is not stored. Data type: String |
| serviceQualificationItem.service.place | Location information for the service qualification item.Data type: Array of Objects **Note:** This array can contain only one location. ``` "place": [ { "id": "String", "name": "String", "@referredType": "String" } ] ``` |
| serviceQualificationItem.service.place.id | Sys\_id of the location.Data type: String Table: Location \[cmn\_location\] |
| serviceQualificationItem.service.place.name | Name of the location. Not verified against an entry in the Location \[cmn\_location\] table.Data type: String |
| serviceQualificationItem.service.place.@type | Part of TMF Open API standard. Annotation for Service. This value is always `GeographicSite`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceSpecification | Service specification details for the qualification item.Data type: Array of Objects ``` "serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", } ``` |
| serviceQualificationItem.service.serviceSpecification.id | External ID or initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.name | Name of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.version | External version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.internalVersion | Internal version of the service specification.Data type: Number |
| serviceQualificationItem.service.serviceSpecification.internalId | Initial version of the service specification.Data type: String |
| serviceQualificationItem.service.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic | List of service characteristics.Data type: Array of objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem.service.serviceCharacteristic.valueType | Value type of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.name | Name of the characteristic.Data type: String |
| serviceQualificationItem.service.serviceCharacteristic.value | Value of the characteristic.Data type: String |
| ServiceQualificationItem.alternateServiceProposal | Alternate service proposal for the qualification order.Data type: String Stored in: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.id | Sys\_id of the alternate proposal record.Data type: String Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | The available\_date field value of the alternate proposal entry in the Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] table.Data type: String |
| serviceQualificationItem.alternateServiceProposal.alternateService | Service information represented by the alternate proposal.Data type: Object |
| serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification | Service specification of the alternate proposal persisted in specification.Data type: Object Table: Alternate Proposal \[sn\_ord\_qual\_mgmt\_alternate\_proposal\] |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id | External ID or initial version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name | Name of the alternate service specification. Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version | External version of the alternate service specification.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion | Internal version of the alternate service specification.Data type: Number |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId | Initial version of the alternate service specification.Data type: String |
| ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type | Part of TMF Open API standard. Annotation for Service Specification. This value is always `ServiceSpecification`. This information is not stored.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic | List of service characteristics for the alternate service proposal.Data type: Array of Objects ``` "serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ] ``` |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType | Value type of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name | Name of the alternate service characteristic.Data type: String |
| serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value | Value of the alternate service characteristic.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason | List of service eligibility unavailability reasons to explain why the service is not available. Data type: Array Stored in: The unavailability\_reason field of the Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\] table. |
| serviceQualificationItem.eligibilityUnavailabilityReason.code | Service eligibility unavailability reason code.Data type: String |
| serviceQualificationItem.eligibilityUnavailabilityReason.label | Service eligibility unavailability reason label.Data type: String |