Get Addressable

User Guide > Resources > Get Addressable

This request returns extended information of an addressable. All object fields are read except the image of the object. The icon of the addressable is a separate resource.
When a Person object is linked to an user, the user object is included in the result.

Process addressable telecom addresses for contacting

If this request is used to get the telecom addresses of an Addressable for dialing / sms / email. Show this to the end user in the following order:
Person
1. Show the employment telecom addresses ordered by (1) lastUsedOn and (2) orderNumber
2. Show the employment organisation telecom addresses ordered by (1) lastUsedOn and (2) orderNumber
3. Show the private telecom addresses ordered by (1) lastUsedOn and (2) orderNumber
Organisation / X1Object
1. Show the telecom addresses ordered by (1) lastUsedOn and (2) orderNumber
Note: the last used on could be empty!

The object ID (OID) of the addressable is a part of the resource URL. This OID is typically retrieved by a search request. Such a search request, or other requests that contain objects in their output, includes an HATEOAS link to the resource URL.

Resource

GET /addressables/<OID>

Where OID is the object ID of the addressable (see comments above).

Parameters

Name Type Description

include

[String]

Include fields to the result. The field status/icon/busy supported: include=status

Payload

None

Response

Object Response < Addressable >

Context

Authorization

User

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/addressables/1557367
Response
{
  "object": {
    "initials": "A.",
    "givenName": "Arnon",
    "namePrefix": "",
    "familyName": "Ron",
    "nameSuffix": "",
    "additionalName": "",
    "communicationLanguage": "natDutch",
    "employments": [
      {
        "commonName": "Xelion B.V.",
        "orderNumber": 1,
        "jobTitle": "Programmer",
        "organisation": {
          "name": "Xelion B.V.",
          "telecomAddresses": [
            {
              "commonName": "+31 15 2511 411",
              "addressType": "Telephone",
              "address": "+31 15 2511 411",
              "label": "",
              "orderNumber": 1,
              "lastUsedOn": "2020-05-25 16:19:59",
              "oid": "1041869",
              "objectType": "TelecomAddress"
            },
            {
              "commonName": "www.xelion.nl",
              "addressType": "URL",
              "address": "www.xelion.nl",
              "label": "",
              "orderNumber": 2,
              "lastUsedOn": "2020-05-25 16:19:59",
              "oid": "1322361",
              "objectType": "TelecomAddress"
            },
            {
              "commonName": "info@xelion.nl",
              "addressType": "Email",
              "address": "info@xelion.nl",
              "label": "",
              "orderNumber": 3,
              "oid": "1322363",
              "objectType": "TelecomAddress"
            }
          ],
          "addresses": [
            {
              "commonName": "Staalweg 40, 2612 KK, Delft (Bezoekadres)",
              "street": "Staalweg",
              "streetNumber": "40",
              "additionalInformation": "",
              "zipCode": "2612 KK",
              "city": "Delft",
              "state": "",
              "country": "Netherlands",
              "comments": "",
              "addressType": "visitingAddress",
              "oid": "1041874",
              "objectType": "DeliveryAddress"
            }
          ],
          "fieldOfBusiness": "ICT",
          "btwNumber": "NL009509045B01",
          "kvkNumber": "27228063",
          "permissions": "ReadWriteRemove",
          "commonName": "Xelion B.V.",
          "oid": "1041861",
          "objectType": "Organisation"
        },
        "telecomAddresses": [
          {
            "commonName": "arnon.ron@xelion.nl",
            "addressType": "Email",
            "address": "arnon.ron@xelion.nl",
            "label": "",
            "orderNumber": 1,
            "oid": "1563204",
            "objectType": "TelecomAddress"
          }
        ],
        "oid": "1563203",
        "objectType": "Employee"
      }
    ],
    "telecomAddresses": [
      {
        "commonName": "0152511418",
        "addressType": "Telephone",
        "address": "0152511418",
        "label": "",
        "orderNumber": 1,
        "lastUsedOn": "2020-05-26 16:19:59",
        "oid": "1566467",
        "objectType": "TelecomAddress"
      },
      {
        "commonName": "0646762966",
        "addressType": "Telephone_and_SMS",
        "address": "06246762966",
        "label": "",
        "orderNumber": 2,
        "oid": "1587807",
        "objectType": "TelecomAddress"
      }
    ],
    "status": "available",
    "busy": false,
    "X1Keys": [
      {
        "key": "Arnon",
        "keyType": "system",
        "oid": "1651005",
        "objectType": "X1AddressableKey"
      },
      {
        "key": "Ron",
        "keyType": "system",
        "oid": "1651008",
        "objectType": "X1AddressableKey"
      },
      {
        "key": "special",
        "keyType": "user",
        "oid": "2045302",
        "objectType": "X1AddressableKey"
      }
    ],
    "permissions": "ReadWriteRemove",
    "commonName": "Arnon Ron",
    "oid": "1556377",
    "objectType": "Person"
  },
  "links": [
    {
      "rel": "self",
      "href": "http://xelion.nl/api/v1/master/addressables/1556377",
      "method": "GET"
    }
  ]
}