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 or ADMIN. | |
| Body | customers | Array of customer ids (24 hex-char string) |
Query example
{
customers: [
'1234567890ABCDEF12345678',
'1234567890ABCDEF12345679',
'1234567890ABCDEF12345680'
]
}
Response
| Json object | ||
|---|---|---|
| key | Id | Unique customer id |
| value | String | Name of the customer |
Example
{ '1234567890ABCDEF12345678': 'Northwind industries', '1234567890ABCDEF12345679': 'ACME soap and ketchup', '1234567890ABCDEF12345680': 'Alvin and the Chipmunks' }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/customer/get-names.txt · Last modified: 2014/06/01 09:43 by Per Møller