Qodex.ai

Service Qualification Management

Number of APIs: 20

TMF API Reference: TMF645 - Service Qualification

Version 4.0

Service Qualification API is one of Pre-Ordering Management API Family. Service Qualification API goal is to provide service technical eligibility. Since v4 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 ).

CheckServiceQualification Resource

This resource is use to check a configured service eligibility (or a list of service). A qualification result is provided in response. Requested could ask for unavailability reason and/or for alternate proposal

TMF645 performs the following operations on the check service qualification resource :

  • Retrieve a checkServiceQualification or a collection of checkServiceQualification depending on filter criteria
  • Partial update of a checkServiceQualification
  • Create a checkServiceQualification (including default values and creation rules)
  • Delete a checkServiceQualification (for administration purposes)
  • Manage notification on checkServiceQualification

Query Service Qualification resource

Query Service Qualification is used to retrieve a list of service eligible in a given request provided by requester (via searchCriteria).

TMF645 performs the following operations on a query service qualification resource:

  • Retrieval a queryServiceQualification or a list of queryServiceQualification
  • Partial update of a queryServiceQualification
  • Creation of a queryServiceQualification
  • Deletion of a queryServiceQualification
  • Notification on queryServiceQualification

Copyright (c) TM Forum 2019. All Rights Reserved

  1. check Service Qualification-{id} - Retrieves a CheckServiceQualification by ID GET {{baseUrl}}/checkServiceQualification/:id?fields=deserunt ipsum culpa ea quis

  2. check Service Qualification-{id} - Deletes a CheckServiceQualification DELETE {{baseUrl}}/checkServiceQualification/:id

  3. check Service Qualification - Creates a CheckServiceQualification POST {{baseUrl}}/checkServiceQualification

  4. query Service Qualification-{id} - Retrieves a QueryServiceQualification by ID GET {{baseUrl}}/queryServiceQualification/:id?fields=deserunt ipsum culpa ea quis

  5. query Service Qualification-{id} - Updates partially a QueryServiceQualification PATCH {{baseUrl}}/queryServiceQualification/:id

  6. query Service Qualification-{id} - Deletes a QueryServiceQualification DELETE {{baseUrl}}/queryServiceQualification/:id

  7. query Service Qualification - List or find QueryServiceQualification objects GET {{baseUrl}}/queryServiceQualification?fields=deserunt ipsum culpa ea quis&offset=-75047166&limit=-75047166

  8. query Service Qualification - Creates a QueryServiceQualification POST {{baseUrl}}/queryServiceQualification

  9. hub - Register a listener POST {{baseUrl}}/hub

  10. hub - Unregister a listener DELETE {{baseUrl}}/hub/:id