Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Gets all translation domains assigned to a company. This is commonly used with supplier companies to track which type of content the supplier can provideperson. For example: Marketing content, Technical content, Legal content etc.

This is most commonly used with internal users but also works with any user whether external suppliers or clients.

The list of domains can be freely customized by the platform administrator: Translation Domains 

To obtain the list of all domains by API: settings/domains/codes

URL

(GET) /api/companiespersons/{ciduid}/domains

PARAMETERS

The URL parameters are:

ciduid

The company person ID. This can be a client, a supplier or the master company ("My company"an internal or internal person (user)

int, Mandatory


RESULTS

The result is a JSON array.  Each element has these properties:

id

The numeric unique ID of the domain

int
nameThe title of the domainstring

Domains are optional and companies persons may have no domains assigned. In this case an empty JSON array is returned.

EXAMPLES

A list may look like:

Code Block
[
    {
        "id": 6781,
        "name": "Finance and economy/Accounting"
    },
    {
        "id": 6789,
        "name": "Finance and economy/Insurance"
    },
    {
        "id": 6795,
        "name": "Legal/General law"
    }
]

...