api:customer:get-names
Table of Contents
API : Customer Get names
Introduction
This request will return the the id and name of a list of customers. This is typically used when a list of objects contains a customer id and we wish to add the name of the customer to the objects.
Request
| URL | https://api.telecomx.dk/customer/names/list | |
|---|---|---|
| Method | POST | |
| Access level | RESELLER, RESELLER_ADMIN or ADMIN. | |
| Body | customers | Array of customer ids (24 hex-char strings). Min 1, max 10000 ids. |
Query example
{ "customers": [ "650000000000000000000101", "650000000000000000000102" ] }
Response
| Json object | ||
|---|---|---|
| key | Id | Unique customer id |
| value | String | Name of the customer |
Ids that do not exist are omitted from the response.
Example
{ "650000000000000000000101": "Example Company East", "650000000000000000000102": "Example Company North" }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | customers | Customers list is missing |
| 422 | customers | Customers list is invalid |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/customer/get-names.txt · Last modified: by Mikkel Meerwaldt Jørgensen