Table of Contents

API : Integration : ALSO Validate Customer

Introduction

This request checks whether a set of ALSO credentials can access a given ALSO customer.

The customer is identified by its customer id in ALSO, not by its Telecom X id.

Request

URL https://api.telecomx.dk/integration/also/validate/customer/:id
Method POST
Access level VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN or ADMIN.
Params id String The customer's id in ALSO, digits only, max. 20 digits
Body alsoUsername String Username in ALSO, max. 512 characters
alsoPassword String Password in ALSO, max. 512 characters

Query example

POST https://api.telecomx.dk/integration/also/validate/customer/123456

Body example

{
  "alsoUsername": "<USERNAME>",
  "alsoPassword": "<PASSWORD>"
}

Response

Json object
success Boolean True when the credentials can access the ALSO customer

Example

{
  "success": true
}

Errors

Error code Message Description
422 <property> Invalid input for the named property - the request body, query or URL parameter failed validation
400 bad data ALSO rejected the request, e.g. missing or wrong credentials - the description is the message from ALSO, e.g. Invalid arguments. Username is required
403 access_denied Insufficient access level
500 unavailable Cannot reach ALSO service, try again later.
500 internal_error <Unspecified>