tmf716-resourceReservation-msisdn
This API specification is used as guideline based on TMF716 specs for InquireAvailableSubscriberNumbers, ReserveSubscriberNumber and ReleaseSubscriberNumber CSI legacy APIs for MSISDN resource.
home
Summary
Resource Reservation does three operations namely QUERY, RESERVE and RELEASE. All three operations require service zip code or billing market, submarket, serviceArea amongst other required data elements in the input request body.
- Query via POST resourceReservation does a query of available subscriber number(s) and holds them for 24 hours period.
- This interface provides the capability to request a list of available numbers that can be assigned to the subscriber. MVNO is required to pass the Market and Service Area (among other data elements). MVNO can indicate the number of available numbers to be returned and the numbers returned will remain available for activation for some period (dependent upon the billing system).
- Reserve also does the same via POST resourceReservation but reserves them for about 30 days period in general.
- MVNOs can request to reserve one or multiple subscriber numbers within the same market in one request. (Multiple Numbers must be requested in the same market but may have different service areas). MVNOs may also perform a reservation against specific subscriber numbers by supplying the subscriber number to be reserved in the request or have random numbers reserved.
- Release enables clients via PATCH resourceReservation/{id} to release a previously reserved/ pre-activated number.
- This interaction enables MVNOs to release previously reserved subscriber number. One subscriber number can be released in one request. Subscriber number must be in a pre-activation/reserved state, or else an error will be returned to the MVNO.