InquirePortEligibility
Version 4.0.0
Endpoint
POST
undefined/checkResourceQualification
Copy
Checks whether a given MSISDN (subscriberNumber) is eligible for porting into the AT&T network. (TMF 761)
Query Parameters
- @typestringEnum: [CheckMSISDNPortEligibilityQualification]
Header Parameters
- AuthorizationstringRequiredJWT Bearer Token. Token URL:
- Content-LengthintMatches the count of bytes in the request body so the server can know whether it has read the correct number of bytes.
- AcceptstringRequiredSpecifies the media type as "application/json".
- X-ATT-ConversationIdstring32 hexadecimal characters grouped as 8-4-4-4-12 and separated by four hyphens (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) for a total length of 36 characters.
- X-ATT-CorrelationIdstring32 hexadecimal characters grouped as 8-4-4-4-12 and separated by four hyphens (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) for a total length of 36 characters.
- X-ATT-ClientIdstringID derived from the JSON Web Token which represents the ClientId of the API Consumer who initiated the call flow at the Mule Gateway. This is used by downstream APIs to log data about the entity which initiated the call flow.
Body Parameters
- Required
- @typestringWhen sub-classing, this defines the sub-class Extensible name
- @baseTypestringWhen sub-classing, this defines the super-class
- externalIdstringIdentifier provided by the requester
- descriptionstringDescription of the serviceQualification
- relatedPartyarray of objects
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- provideAlternativebooleanWhen the value is TRUE means that alternative solutions should be provided
- instantSyncQualificationbooleanAn indicator which when the value is "true" means that requester expects to get qualifcation 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.
- serviceQualificationItemarray of objects
- expectedQualificationDatestringA date (DateTime). Deadline date when the requester expected a qualification answer.
- provideUnavailabilityReasonbooleanWhen the value is TRUE means that unavailability reason are expected for non available service.
- CheckResourceQualificationDatestringDate when the serviceQualification was submitted
- schema#1The CheckResourceQualification to be created. For MSISDN port eligibility check, the only required fields are @type, which must have a value of "CheckMSISDNPortEligibilityQualification", and serviceQualificationItems, which should be a one-element array of type MSISDNPortEligibilityQualificationItem. All other fields are ignored, including ones from the base CheckResourceQualification_Create type.
Responses
Success -- the result of the eligibility check will be found in the
qualificationResult element of the response: "qualified" or "unqualified"
Body
application/json
- object
- idstringunique identifier
- hrefstringHyperlink reference
- statestringEnum: [accepted, terminatedWithError, inProgress, done]Possible values for the state of a task
- @typestringWhen sub-classing, this defines the sub-class Extensible name
- @baseTypestringWhen sub-classing, this defines the super-class
- externalIdstringIdentifier provided by the requester
- descriptionstringDescription of the serviceQualification
- relatedPartyarray of objects
- expirationDatestringDate when the qualification response expires
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- provideAlternativebooleanWhen the value is TRUE means that alternative solutions should be provided
- qualificationResultstringQualification 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)
- estimatedResponseDatestringDate when the requester expect to provide an answer for the qualification request.
- instantSyncQualificationbooleanAn indicator which when the value is "true" means that requester expects to get qualifcation 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.
- serviceQualificationItemarray of objectsRequired
- expectedQualificationDatestringA date (DateTime). Deadline date when the requester expected a qualification answer.
- effectiveQualificationDatestringEffective date to serviceQualification completion
- provideUnavailabilityReasonbooleanWhen the value is TRUE means that unavailability reason are expected for non available service.
- CheckResourceQualificationDatestringDate when the serviceQualification was submitted