Help Page Home

GET api/users/{id}/terminals

Gets all the terminals belonging to the specified user.

Required Scopes

ReferenceData.System

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique ID of the user.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A list of terminals.

Collection of Terminal
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

MasterList_SiteId

Site

None.

MasterList_CustomerNumber

MasterList_CustomerNumber

None.

AudaMailName

string

None.

HexId

string

None.

IsAudaMailAddress

boolean

None.

TerminalId

string

None.

Response Formats

[
  {
    "Id": "326f6c04-535a-45b0-bf7b-8e8be63c9d1f",
    "MasterList_SiteId": {
      "ID": "1b769d07-fd02-41f8-9d64-dc44c62952c4",
      "Contact": {
        "ContactType": "sample string 1",
        "AbleToAuthorise": "sample string 2",
        "Name": "sample string 3",
        "Title": "sample string 4",
        "Forename": "sample string 5",
        "Surname": "sample string 6",
        "EMailAddress": "sample string 7",
        "Line01": "sample string 8",
        "Line02": "sample string 9",
        "Line03": "sample string 10",
        "Line04": "sample string 11",
        "Line05": "sample string 12",
        "PostCode": "sample string 13",
        "TelHome": "sample string 14",
        "TelBusiness": "sample string 15",
        "TelMobile": "sample string 16",
        "TelOther": "sample string 17",
        "Fax": "sample string 18"
      },
      "Address": {
        "ID": "e0d420d8-1d27-40d4-8702-2dd7de6453b1",
        "AddressLine1": "sample string 2",
        "AddressLine2": "sample string 3",
        "AddressLine3": "sample string 4",
        "AddressLine4": "sample string 5",
        "AddressLine5": "sample string 6",
        "PostCode": "sample string 7"
      },
      "AKAName": "sample string 2",
      "CompanyName": "sample string 3",
      "SiteId": "sample string 4",
      "ExternalCode": "sample string 5"
    },
    "MasterList_CustomerNumber": {
      "ID": "3f4ba2b4-f52c-4616-9c77-e143128333d6",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "AddressLine3": "sample string 4",
      "AddressLine4": "sample string 5",
      "CustomerNumber": "sample string 6"
    },
    "AudaMailName": "sample string 2",
    "HexId": "sample string 3",
    "IsAudaMailAddress": true,
    "TerminalId": "sample string 5"
  },
  {
    "Id": "326f6c04-535a-45b0-bf7b-8e8be63c9d1f",
    "MasterList_SiteId": {
      "ID": "1b769d07-fd02-41f8-9d64-dc44c62952c4",
      "Contact": {
        "ContactType": "sample string 1",
        "AbleToAuthorise": "sample string 2",
        "Name": "sample string 3",
        "Title": "sample string 4",
        "Forename": "sample string 5",
        "Surname": "sample string 6",
        "EMailAddress": "sample string 7",
        "Line01": "sample string 8",
        "Line02": "sample string 9",
        "Line03": "sample string 10",
        "Line04": "sample string 11",
        "Line05": "sample string 12",
        "PostCode": "sample string 13",
        "TelHome": "sample string 14",
        "TelBusiness": "sample string 15",
        "TelMobile": "sample string 16",
        "TelOther": "sample string 17",
        "Fax": "sample string 18"
      },
      "Address": {
        "ID": "e0d420d8-1d27-40d4-8702-2dd7de6453b1",
        "AddressLine1": "sample string 2",
        "AddressLine2": "sample string 3",
        "AddressLine3": "sample string 4",
        "AddressLine4": "sample string 5",
        "AddressLine5": "sample string 6",
        "PostCode": "sample string 7"
      },
      "AKAName": "sample string 2",
      "CompanyName": "sample string 3",
      "SiteId": "sample string 4",
      "ExternalCode": "sample string 5"
    },
    "MasterList_CustomerNumber": {
      "ID": "3f4ba2b4-f52c-4616-9c77-e143128333d6",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "AddressLine3": "sample string 4",
      "AddressLine4": "sample string 5",
      "CustomerNumber": "sample string 6"
    },
    "AudaMailName": "sample string 2",
    "HexId": "sample string 3",
    "IsAudaMailAddress": true,
    "TerminalId": "sample string 5"
  }
]
<ArrayOfTerminal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <Terminal>
    <AudaMailName>sample string 2</AudaMailName>
    <HexId>sample string 3</HexId>
    <Id>326f6c04-535a-45b0-bf7b-8e8be63c9d1f</Id>
    <IsAudaMailAddress>true</IsAudaMailAddress>
    <MasterList_CustomerNumber>
      <AddressLine1>sample string 2</AddressLine1>
      <AddressLine2>sample string 3</AddressLine2>
      <AddressLine3>sample string 4</AddressLine3>
      <AddressLine4>sample string 5</AddressLine4>
      <CustomerNumber>sample string 6</CustomerNumber>
      <ID>3f4ba2b4-f52c-4616-9c77-e143128333d6</ID>
    </MasterList_CustomerNumber>
    <MasterList_SiteId>
      <AKAName>sample string 2</AKAName>
      <Address>
        <AddressLine1>sample string 2</AddressLine1>
        <AddressLine2>sample string 3</AddressLine2>
        <AddressLine3>sample string 4</AddressLine3>
        <AddressLine4>sample string 5</AddressLine4>
        <AddressLine5>sample string 6</AddressLine5>
        <ID>e0d420d8-1d27-40d4-8702-2dd7de6453b1</ID>
        <PostCode>sample string 7</PostCode>
      </Address>
      <CompanyName>sample string 3</CompanyName>
      <Contact>
        <AbleToAuthorise>sample string 2</AbleToAuthorise>
        <ContactType>sample string 1</ContactType>
        <EMailAddress>sample string 7</EMailAddress>
        <Fax>sample string 18</Fax>
        <Forename>sample string 5</Forename>
        <Line01>sample string 8</Line01>
        <Line02>sample string 9</Line02>
        <Line03>sample string 10</Line03>
        <Line04>sample string 11</Line04>
        <Line05>sample string 12</Line05>
        <Name>sample string 3</Name>
        <PostCode>sample string 13</PostCode>
        <Surname>sample string 6</Surname>
        <TelBusiness>sample string 15</TelBusiness>
        <TelHome>sample string 14</TelHome>
        <TelMobile>sample string 16</TelMobile>
        <TelOther>sample string 17</TelOther>
        <Title>sample string 4</Title>
      </Contact>
      <ExternalCode>sample string 5</ExternalCode>
      <ID>1b769d07-fd02-41f8-9d64-dc44c62952c4</ID>
      <SiteId>sample string 4</SiteId>
    </MasterList_SiteId>
    <TerminalId>sample string 5</TerminalId>
  </Terminal>
  <Terminal>
    <AudaMailName>sample string 2</AudaMailName>
    <HexId>sample string 3</HexId>
    <Id>326f6c04-535a-45b0-bf7b-8e8be63c9d1f</Id>
    <IsAudaMailAddress>true</IsAudaMailAddress>
    <MasterList_CustomerNumber>
      <AddressLine1>sample string 2</AddressLine1>
      <AddressLine2>sample string 3</AddressLine2>
      <AddressLine3>sample string 4</AddressLine3>
      <AddressLine4>sample string 5</AddressLine4>
      <CustomerNumber>sample string 6</CustomerNumber>
      <ID>3f4ba2b4-f52c-4616-9c77-e143128333d6</ID>
    </MasterList_CustomerNumber>
    <MasterList_SiteId>
      <AKAName>sample string 2</AKAName>
      <Address>
        <AddressLine1>sample string 2</AddressLine1>
        <AddressLine2>sample string 3</AddressLine2>
        <AddressLine3>sample string 4</AddressLine3>
        <AddressLine4>sample string 5</AddressLine4>
        <AddressLine5>sample string 6</AddressLine5>
        <ID>e0d420d8-1d27-40d4-8702-2dd7de6453b1</ID>
        <PostCode>sample string 7</PostCode>
      </Address>
      <CompanyName>sample string 3</CompanyName>
      <Contact>
        <AbleToAuthorise>sample string 2</AbleToAuthorise>
        <ContactType>sample string 1</ContactType>
        <EMailAddress>sample string 7</EMailAddress>
        <Fax>sample string 18</Fax>
        <Forename>sample string 5</Forename>
        <Line01>sample string 8</Line01>
        <Line02>sample string 9</Line02>
        <Line03>sample string 10</Line03>
        <Line04>sample string 11</Line04>
        <Line05>sample string 12</Line05>
        <Name>sample string 3</Name>
        <PostCode>sample string 13</PostCode>
        <Surname>sample string 6</Surname>
        <TelBusiness>sample string 15</TelBusiness>
        <TelHome>sample string 14</TelHome>
        <TelMobile>sample string 16</TelMobile>
        <TelOther>sample string 17</TelOther>
        <Title>sample string 4</Title>
      </Contact>
      <ExternalCode>sample string 5</ExternalCode>
      <ID>1b769d07-fd02-41f8-9d64-dc44c62952c4</ID>
      <SiteId>sample string 4</SiteId>
    </MasterList_SiteId>
    <TerminalId>sample string 5</TerminalId>
  </Terminal>
</ArrayOfTerminal>