Service Qualification ​

An API that provides Service Qualification results for provided carrier/carrier ID pairs

Performing a Service Qualification ​

Take the carrier/carrier ID pair(s) that have been obtained via the Geographic Address API and pass them in a POST request to the Service Qualification endpoint.

This will then asynchronously query each carriers own Service Qualification API, normalise, format, and return the results.

Request ​

{
	"description": "Query Service Qualification POST Illustration", 
	"expectedQualificationDate": "2020-04-13T13:51:41.218Z", 
	"instantSyncQualification": true,
	"externalId": "QSQ-456", 
	"searchCriteria": { 
		"service": {
			"place": [
				{
                    "@type": "UnitiGeographicAddress",
                    "identifiers": [
                        {
                            "name": "OC",
                            "value": "OPC100000209087",
                            "type": "carrier"
                        },
                        {
                            "name": "NB",
                            "value": "LOC000057539959",
                            "type": "carrier"
                        }
                    ]
	            } 
			]
		},
		"@type": "SearchCriteria" 
	},
	"@type": "QueryServiceQualification" 
}

Response ​

The resulting response can be downloaded here as it is too large to display meaningfully here.

Importantly a result for each carrier will appear under the serviceQualificationItem key IF one is returned from the carrier. This means if no result is returned from the carrier then this array will be empty and the service qualification for that premise has failed.

Each Service Qualification Item will also have a list of characteristics that are used to convey meta information regarding that result. See below for a reference of characteristics.

Characteristic Reference ​

Not all characteristics listed here are guaranteed to appear on a service qualification item as some data points may not be available from the carrier in question or are specific to the technology at that specific premise.