Table of Contents

API : Customer Address Get

Introduction

This request will return the the specified address on the customer.

Request

URL https://api.telecomx.dk/customer/CUSTOMER_ID/address/ADDRESS_ID
Method GET
Access level VIEWER, MANAGER or OWNER if user belongs to the customer.
RESELLER if customer belongs to the reseller or a sub reseller.
RESELLER_ADMIN.
ADMIN.
Param CUSTOMER_ID Id of the customer (24 hex-char string)
Param ADDRESS_ID Id of the address (24 hex-char string)

Query example

https://api.telecomx.dk/customer/1234567890ABCDEF12345678/address/1234567890ABCDEF12345678

Response

Json object
_id Id Id of address
primary Boolean True if this is the primary address
alternativeName String Alternative name for this address
address String Street, number etc.
zip String Zip code
city String City
state String State
country String Country
fixedNumber String Fixed phone number on this address, if it differs from the primary
faxNumber String Fax number on this address, if it differs from the primary
municipalityCode Integer Municipality code, automatically set by the system

Note that properties holding no value may be omitted from the object.

Example

{
  "_id": "650000000000000000000301",
  "primary": true,
  "alternativeName": "",
  "address": "Eksempelvej 23",
  "zip": "4000",
  "city": "Roskilde",
  "country": "DK",
  "municipalityCode": 265
}

Errors

Error code Message Description
422 customer Customer id is invalid
422 id Address id is invalid
403 access_denied Insufficient access level
404 address Address not found
500 internal_error <Unspecified>