List or find Customer objects
This operation list or find Customer entities
Request
- Base URLhttps://serverRoot/tmf-api/customerManagement/v4
- Auth
- API key in header X-API-Key
- or OAuth 2Client credentialsToken URLhttps://api.mtn.com/v1/oauth/access_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Comma-separated properties to be provided in response.The field names should be from the first level of property names as defined in Customer schema.
It is logged in csr id and it is mandatory when List of VIP and Enterprise is fetched.
To sort the response based on sortkeys. Possible values name. Values will be retrieved from RT perestapi.imp.cust.SORT_KEY
To sort the response based on sort order. Possible value ascending, descending
Type of retrieval of data. 1 -> retrieves the list of all object keys along with the number of object details mentioned in retrievalLimit, 2 -> retrieves the list of all object keys, 3 -> retrieves object details for the keys mentioned in objKeys
Limit to the number of objects retrieved. Mandatory when retrievalType is 1
Comma-separated object keys for which details to be retrieved. Mandatory when retrievalType is 3
To retrieve the customers by type - SV_MAPPING:Cust_Acct_Type.DisplayName_X - RT api.imp.ALL_CC_CUSTOMER_TYPE. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue
It tells if VIP list of customers are needed to be retrieved. Possible Value: VIP. Can be used together with retrievalType parameter
It tells if list of enterprise customers are needed to be retrieved. Possible Value: 1. Can be used together with retrievalType parameter
Search Keys on which data needs to be filtered. Valid Values: Name | MSISDN | IMSI | National ID | Account Number | Company Number | Passport ID. These values will be retrieved from RT perestapi.imp.cust.GlobalSrchFilters. Can be used together with retrievalType parameter
Value of the searchKey passed. Mandatory when searchKey is use.
To retrieve the customers by root customer node id - SV_MAPPING: Cust_Acct.RootCustAcct_R. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue.
To retrieve the customers by parent customer node id - SV_MAPPING: Cust_Acct.ParentCustAcct_R. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue.
To retrieve customer by Individual Id - SV_MAPPING:CustAcct_Contact.Contact.XSID. Can be used together with retrievalType parameter or with additional parameter customerType, rootNodeId or parentNodeId.
The reason for which API is called. Valid values: BalanceTransfer. This value will be retrieved from RT perestapi.REASON. It is used with searchKey is Account Number
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.