maf-tlgapi-sys

Summary

maf-tlgapi-sys is created for the MVNO Modernization project by calling the CSI TLGAPI maf adapter to retrieve customer information from the TELEGENCE backend system. This system api will accept a json request, transform it to the appropriate xml soap request for the downstream maf TELEGENCE adapter method, and return the TELEGENCE response as a json response to the calling api.

Requirements

Following are the operations in the maf-tlgapi-sys API.

accountByEquipmentByImei

-GET: - retrieve Account information by IMEI

accountByEquipmentBySim

-GET: - retrieve account information by SIM

activationStatus

-POST: - enable the client to determine the status of a previously submitted AddPort request. With this interaction, the partner can assess whether the previously submitted AddPort request has succeeded to the point at which subsequent steps to activate the new subscriber(s) may proceed

availableSubscriberNumber

-POST: - provides the capability to request a list of available numbers that can be assigned to the subscriber. Client is required to pass the Market and Service Area (among other data elements). Client can indicate the number of available numbers to be returned and the numbers returned will remain available for activation for some period of time (dependent upon the billing system).

creditCheckNeededVerify

-POST: - returns results of whether credit check is needed for a given subscriberNumber, accountNumber or accountType

crossMarketSearchByDevice

-POST: search for subscriber information by equipment type and serial number

deviceUpdate

-POST: updates subscribers device

equipmentSwap

-POST: - Change IMEI and/or ICCID for a subscriber

imeiInfoByImei

-GET: - retrieve device attributes for a given IMEI

imeiInfoByType

-GET: - retrieve device attributes for a given IMEI Type

marketAndAccountByAccountNumber

-GET: - retrieves market and optional fields subMarket, accountNumber and subscriberNumber from TELEGENCE, depending on what is in request

marketAndAccountBySubscriberNumber

-GET: - retrieves market and optional fields subMarket, accountNumber and subscriberNumber from TELEGENCE, depending on what is in request

newPortEligibility

-POST: - retrieves port eligibility by mdn and account type

portEligibility

-POST: - retrieves port eligibility by mdn or Npa,Nxx,line range

port

-PATCH: - enables the client to change information associated with a currently active Port request.

-DELETE: - enables the client to cancel a previously submitted request to “port in” an existing subscriber from another service provider.

-POST: - enables the client to initiate the process for “porting in” a subscriber number from another service provider.

portByNumber

-GET: - enables the client to retrieve all information related to a previously submitted POST /port (AddPort)request passing port number.

portBySubscriberNumber

-GET: - enables the client to retrieve all information related to a previously submitted POST /port (AddPort) request passing subscriberNumber.

portWorkList

-GET: - retrieves port work list for a given date range

randomSubscriberNumberReserve

-POST: - provides the capability to reserve a block of subscriber numbers for a predetermined time period

sessionBasedPricingOfferingHistory

-GET: - retrieves session based pricing history

statusAndCommissionsForSubscriberNumber

-POST: - invoked as part of reserving a mobile number. Returns subscriber status and commission information

subscriber

-GET - retrieves subscriber details

subscriberActivate

-POST: - activates a subscriber

subscriberActivationResend

-POST: - activates a subscriber

subscriberCancel

-DELETE: - cancel/terminate subscriber

subscriberMove

-POST: - enables the subscribers to change the account types and technology of their subscriptions while retaining their mobile number and existing services

subscriberNumberChange

-POST: changes the subscriber number

subscriberNumberRelease

-DELETE: - interaction enables clients to release previously reserved subscriber number(s).

subscriberNumberReserve

-POST: - provides the capability to reserve a block of subscriber numbers for a predetermined time period –30 days for TLG markets (except SAN and HOU TDMA 120 days) & 180 days for CARE markets – from a list of available numbers. Clients 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). Clients 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.

subscriberRestore

-POST: - restore/unsuspend subscriber

subscriberResume

-POST: - resume/reconnect subscriber

subscriberSuspend

-DELETE: - suspend/disconnect subscriber

subscriberUpdate

-PATCH: - update subscribers provisioning

subStatus

-GET: returns 'true' or 'false' indicating if reseller is authorized for subscriber

switchTransactionStatus

-GET: - Check if a new activation has been established in switch control and is active on the network

Notes

Connection Information