POST api/Address
Create an address
Request Information
URI Parameters
None.
Body Parameters
Address to create
Addresses| Name | Description | 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. |
Request Formats
application/json, text/json
Sample:
{
"Account": "7a0c285a-66e4-4cda-99bd-82f462a188b4",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"City": "sample string 5",
"ContactPerson": "c3cdb165-c58d-40c0-bcbc-15d4841e33b0",
"Country": "sample string 7",
"County": "sample string 8",
"datefield1": "2021-04-15T07:08:54.7672614+02:00",
"datefield2": "2021-04-15T07:08:54.7672614+02:00",
"datefield3": "2021-04-15T07:08:54.7672614+02:00",
"datefield4": "2021-04-15T07:08:54.7672614+02:00",
"datefield5": "2021-04-15T07:08:54.7672614+02:00",
"Fax": "sample string 9",
"ID": "d2a00c35-d8d3-4c41-b2d6-805daa9fec24",
"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": "2021-04-15T07:08:54.7672614+02:00",
"syscreator": 21,
"sysmodified": "2021-04-15T07:08:54.7672614+02: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>7a0c285a-66e4-4cda-99bd-82f462a188b4</Account> <AddressLine1>sample string 2</AddressLine1> <AddressLine2>sample string 3</AddressLine2> <AddressLine3>sample string 4</AddressLine3> <City>sample string 5</City> <ContactPerson>c3cdb165-c58d-40c0-bcbc-15d4841e33b0</ContactPerson> <Country>sample string 7</Country> <County>sample string 8</County> <datefield1>2021-04-15T07:08:54.7672614+02:00</datefield1> <datefield2>2021-04-15T07:08:54.7672614+02:00</datefield2> <datefield3>2021-04-15T07:08:54.7672614+02:00</datefield3> <datefield4>2021-04-15T07:08:54.7672614+02:00</datefield4> <datefield5>2021-04-15T07:08:54.7672614+02:00</datefield5> <Fax>sample string 9</Fax> <ID>d2a00c35-d8d3-4c41-b2d6-805daa9fec24</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>2021-04-15T07:08:54.7672614+02:00</syscreated> <syscreator>21</syscreator> <sysmodified>2021-04-15T07:08:54.7672614+02: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>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The created address
Addresses| Name | Description | 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": "fdb6c590-8527-4c66-bcad-455b94e6e964",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"City": "sample string 5",
"ContactPerson": "fadb9ab3-10c6-4437-91f6-9ab6b5b2563a",
"Country": "sample string 7",
"County": "sample string 8",
"datefield1": "2021-04-15T07:08:54.7828339+02:00",
"datefield2": "2021-04-15T07:08:54.7828339+02:00",
"datefield3": "2021-04-15T07:08:54.7828339+02:00",
"datefield4": "2021-04-15T07:08:54.7828339+02:00",
"datefield5": "2021-04-15T07:08:54.7828339+02:00",
"Fax": "sample string 9",
"ID": "dac38202-d92e-4d38-8b57-fc7aee46b6d7",
"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": "2021-04-15T07:08:54.7828339+02:00",
"syscreator": 21,
"sysmodified": "2021-04-15T07:08:54.7828339+02: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>fdb6c590-8527-4c66-bcad-455b94e6e964</Account> <AddressLine1>sample string 2</AddressLine1> <AddressLine2>sample string 3</AddressLine2> <AddressLine3>sample string 4</AddressLine3> <City>sample string 5</City> <ContactPerson>fadb9ab3-10c6-4437-91f6-9ab6b5b2563a</ContactPerson> <Country>sample string 7</Country> <County>sample string 8</County> <datefield1>2021-04-15T07:08:54.7828339+02:00</datefield1> <datefield2>2021-04-15T07:08:54.7828339+02:00</datefield2> <datefield3>2021-04-15T07:08:54.7828339+02:00</datefield3> <datefield4>2021-04-15T07:08:54.7828339+02:00</datefield4> <datefield5>2021-04-15T07:08:54.7828339+02:00</datefield5> <Fax>sample string 9</Fax> <ID>dac38202-d92e-4d38-8b57-fc7aee46b6d7</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>2021-04-15T07:08:54.7828339+02:00</syscreated> <syscreator>21</syscreator> <sysmodified>2021-04-15T07:08:54.7828339+02: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>