GET api/Address?cmp_wwn={cmp_wwn}&ContactId={ContactId}

Gets a list of addresses (one of the parameters must be given)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cmp_wwn

company ID (optional)

globally unique identifier

None.

ContactId

Contact ID (optional)

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

list of addresses

Collection of Addresses
NameDescriptionTypeAdditional 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.

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.

Response Formats

application/json, text/json

Sample:
[
  {
    "Account": "944d2109-ce75-4c00-baec-e6d7eab5440c",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "City": "sample string 5",
    "ContactPerson": "9f93153d-a4b4-4084-99de-3af018746d08",
    "Country": "sample string 7",
    "County": "sample string 8",
    "datefield1": "2019-04-20T22:14:12.248009+02:00",
    "datefield2": "2019-04-20T22:14:12.248009+02:00",
    "datefield3": "2019-04-20T22:14:12.248009+02:00",
    "datefield4": "2019-04-20T22:14:12.248009+02:00",
    "datefield5": "2019-04-20T22:14:12.248009+02:00",
    "Fax": "sample string 9",
    "ID": "0ceb0c3d-1288-4a49-868f-e6abd9f4f242",
    "Main": 64,
    "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": "2019-04-20T22:14:12.248009+02:00",
    "syscreator": 21,
    "sysmodified": "2019-04-20T22:14:12.248009+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"
  },
  {
    "Account": "944d2109-ce75-4c00-baec-e6d7eab5440c",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "City": "sample string 5",
    "ContactPerson": "9f93153d-a4b4-4084-99de-3af018746d08",
    "Country": "sample string 7",
    "County": "sample string 8",
    "datefield1": "2019-04-20T22:14:12.248009+02:00",
    "datefield2": "2019-04-20T22:14:12.248009+02:00",
    "datefield3": "2019-04-20T22:14:12.248009+02:00",
    "datefield4": "2019-04-20T22:14:12.248009+02:00",
    "datefield5": "2019-04-20T22:14:12.248009+02:00",
    "Fax": "sample string 9",
    "ID": "0ceb0c3d-1288-4a49-868f-e6abd9f4f242",
    "Main": 64,
    "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": "2019-04-20T22:14:12.248009+02:00",
    "syscreator": 21,
    "sysmodified": "2019-04-20T22:14:12.248009+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"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAddresses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Time.Common.Exact.Models">
  <Addresses>
    <TransactionKey>sample string 34</TransactionKey>
    <Account>944d2109-ce75-4c00-baec-e6d7eab5440c</Account>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <City>sample string 5</City>
    <ContactPerson>9f93153d-a4b4-4084-99de-3af018746d08</ContactPerson>
    <Country>sample string 7</Country>
    <County>sample string 8</County>
    <Fax>sample string 9</Fax>
    <ID>0ceb0c3d-1288-4a49-868f-e6abd9f4f242</ID>
    <KeepSameAsVisit>true</KeepSameAsVisit>
    <Main>64</Main>
    <Phone>sample string 17</Phone>
    <PostCode>sample string 18</PostCode>
    <StateCode>sample string 19</StateCode>
    <Type>sample string 28</Type>
    <YesNofield1>64</YesNofield1>
    <YesNofield2>64</YesNofield2>
    <YesNofield3>64</YesNofield3>
    <YesNofield4>64</YesNofield4>
    <YesNofield5>64</YesNofield5>
    <datefield1>2019-04-20T22:14:12.248009+02:00</datefield1>
    <datefield2>2019-04-20T22:14:12.248009+02:00</datefield2>
    <datefield3>2019-04-20T22:14:12.248009+02:00</datefield3>
    <datefield4>2019-04-20T22:14:12.248009+02:00</datefield4>
    <datefield5>2019-04-20T22:14:12.248009+02:00</datefield5>
    <numberfield1>12.1</numberfield1>
    <numberfield2>13.1</numberfield2>
    <numberfield3>14.1</numberfield3>
    <numberfield4>15.1</numberfield4>
    <numberfield5>16.1</numberfield5>
    <syscreated>2019-04-20T22:14:12.248009+02:00</syscreated>
    <syscreator>21</syscreator>
    <sysmodified>2019-04-20T22:14:12.248009+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>
  </Addresses>
  <Addresses>
    <TransactionKey>sample string 34</TransactionKey>
    <Account>944d2109-ce75-4c00-baec-e6d7eab5440c</Account>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <City>sample string 5</City>
    <ContactPerson>9f93153d-a4b4-4084-99de-3af018746d08</ContactPerson>
    <Country>sample string 7</Country>
    <County>sample string 8</County>
    <Fax>sample string 9</Fax>
    <ID>0ceb0c3d-1288-4a49-868f-e6abd9f4f242</ID>
    <KeepSameAsVisit>true</KeepSameAsVisit>
    <Main>64</Main>
    <Phone>sample string 17</Phone>
    <PostCode>sample string 18</PostCode>
    <StateCode>sample string 19</StateCode>
    <Type>sample string 28</Type>
    <YesNofield1>64</YesNofield1>
    <YesNofield2>64</YesNofield2>
    <YesNofield3>64</YesNofield3>
    <YesNofield4>64</YesNofield4>
    <YesNofield5>64</YesNofield5>
    <datefield1>2019-04-20T22:14:12.248009+02:00</datefield1>
    <datefield2>2019-04-20T22:14:12.248009+02:00</datefield2>
    <datefield3>2019-04-20T22:14:12.248009+02:00</datefield3>
    <datefield4>2019-04-20T22:14:12.248009+02:00</datefield4>
    <datefield5>2019-04-20T22:14:12.248009+02:00</datefield5>
    <numberfield1>12.1</numberfield1>
    <numberfield2>13.1</numberfield2>
    <numberfield3>14.1</numberfield3>
    <numberfield4>15.1</numberfield4>
    <numberfield5>16.1</numberfield5>
    <syscreated>2019-04-20T22:14:12.248009+02:00</syscreated>
    <syscreator>21</syscreator>
    <sysmodified>2019-04-20T22:14:12.248009+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>
  </Addresses>
</ArrayOfAddresses>