Request Information

URI Parameters

Name	Description	Type	Additional information
id	Address Id	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Address

Addresses

Name	Type	Additional information
Account	globally unique identifier	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
City	string	None.
ContactPerson	globally unique identifier	None.
Country	string	None.
County	string	None.
datefield1	date	None.
datefield2	date	None.
datefield3	date	None.
datefield4	date	None.
datefield5	date	None.
Fax	string	None.
ID	globally unique identifier	None.
Main	byte	None.
IsUserDefined	boolean	None.
KeepSameAsVisit	boolean	None.
numberfield1	decimal number	None.
numberfield2	decimal number	None.
numberfield3	decimal number	None.
numberfield4	decimal number	None.
numberfield5	decimal number	None.
Phone	string	None.
PostCode	string	None.
StateCode	string	None.
syscreated	date	None.
syscreator	integer	None.
sysmodified	date	None.
textfield1	string	None.
textfield2	string	None.
textfield3	string	None.
textfield4	string	None.
textfield5	string	None.
Type	string	None.
YesNofield1	byte	None.
YesNofield2	byte	None.
YesNofield3	byte	None.
YesNofield4	byte	None.
YesNofield5	byte	None.
TransactionKey	string	None.
Action	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Account": "25fc91d0-9a1d-4229-8495-ac10cd7a3d14",
  "AddressLine1": "sample string 2",
  "AddressLine2": "sample string 3",
  "AddressLine3": "sample string 4",
  "City": "sample string 5",
  "ContactPerson": "87797730-5b43-4422-ad2d-125b6b124727",
  "Country": "sample string 7",
  "County": "sample string 8",
  "datefield1": "2025-12-06T05:12:12.2005138+01:00",
  "datefield2": "2025-12-06T05:12:12.2005138+01:00",
  "datefield3": "2025-12-06T05:12:12.2005138+01:00",
  "datefield4": "2025-12-06T05:12:12.2005138+01:00",
  "datefield5": "2025-12-06T05:12:12.2005138+01:00",
  "Fax": "sample string 9",
  "ID": "690f2745-d4b9-452a-b2bd-97d2d26831ed",
  "Main": 64,
  "IsUserDefined": true,
  "KeepSameAsVisit": true,
  "numberfield1": 12.1,
  "numberfield2": 13.1,
  "numberfield3": 14.1,
  "numberfield4": 15.1,
  "numberfield5": 16.1,
  "Phone": "sample string 17",
  "PostCode": "sample string 18",
  "StateCode": "sample string 19",
  "syscreated": "2025-12-06T05:12:12.2005138+01:00",
  "syscreator": 21,
  "sysmodified": "2025-12-06T05:12:12.2005138+01:00",
  "textfield1": "sample string 23",
  "textfield2": "sample string 24",
  "textfield3": "sample string 25",
  "textfield4": "sample string 26",
  "textfield5": "sample string 27",
  "Type": "sample string 28",
  "YesNofield1": 64,
  "YesNofield2": 64,
  "YesNofield3": 64,
  "YesNofield4": 64,
  "YesNofield5": 64,
  "TransactionKey": "sample string 34",
  "Action": "sample string 35"
}

application/xml, text/xml

Sample:

<Addresses xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TransactionKey>sample string 34</TransactionKey>
  <Action>sample string 35</Action>
  <Account>25fc91d0-9a1d-4229-8495-ac10cd7a3d14</Account>
  <AddressLine1>sample string 2</AddressLine1>
  <AddressLine2>sample string 3</AddressLine2>
  <AddressLine3>sample string 4</AddressLine3>
  <City>sample string 5</City>
  <ContactPerson>87797730-5b43-4422-ad2d-125b6b124727</ContactPerson>
  <Country>sample string 7</Country>
  <County>sample string 8</County>
  <datefield1>2025-12-06T05:12:12.2005138+01:00</datefield1>
  <datefield2>2025-12-06T05:12:12.2005138+01:00</datefield2>
  <datefield3>2025-12-06T05:12:12.2005138+01:00</datefield3>
  <datefield4>2025-12-06T05:12:12.2005138+01:00</datefield4>
  <datefield5>2025-12-06T05:12:12.2005138+01:00</datefield5>
  <Fax>sample string 9</Fax>
  <ID>690f2745-d4b9-452a-b2bd-97d2d26831ed</ID>
  <Main>64</Main>
  <IsUserDefined>true</IsUserDefined>
  <KeepSameAsVisit>true</KeepSameAsVisit>
  <numberfield1>12.1</numberfield1>
  <numberfield2>13.1</numberfield2>
  <numberfield3>14.1</numberfield3>
  <numberfield4>15.1</numberfield4>
  <numberfield5>16.1</numberfield5>
  <Phone>sample string 17</Phone>
  <PostCode>sample string 18</PostCode>
  <StateCode>sample string 19</StateCode>
  <syscreated>2025-12-06T05:12:12.2005138+01:00</syscreated>
  <syscreator>21</syscreator>
  <sysmodified>2025-12-06T05:12:12.2005138+01:00</sysmodified>
  <textfield1>sample string 23</textfield1>
  <textfield2>sample string 24</textfield2>
  <textfield3>sample string 25</textfield3>
  <textfield4>sample string 26</textfield4>
  <textfield5>sample string 27</textfield5>
  <Type>sample string 28</Type>
  <YesNofield1>64</YesNofield1>
  <YesNofield2>64</YesNofield2>
  <YesNofield3>64</YesNofield3>
  <YesNofield4>64</YesNofield4>
  <YesNofield5>64</YesNofield5>
</Addresses>