Get Subscriber Labels

This API is used to retrieve a list of User labels attached to a subscriber (SIM).

HTTP URL
GET	/api/v2/subscriber/{type}/{value}/label

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to request User-label information attached to a single subscriber (SIM) of:

Its own customer (sub-account)
One of its customers’ sub-customers

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
id	UUID	M	Label instance attached to the subscriber
name	String	M	Label name
creationTime	DateTime	M	Label creation timestamp

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1029	Failed to retrieve subscriber label details

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "id": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
      "name": "label1",
      "creationTime": "2020-11-11 08:47:46"
    },
    {
      "id": "b2fccb33-5c03-41dd-9e33-662f7d6f47b2",
      "name": "label2",
      "creationTime": "2020-11-11 08:47:50"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1029",
  "errorMessage": "Failed to retrieve subscriber label details",
  "content": "",
  "pageable": ""
}