POST api/addresses
Request Information
URI Parameters
None.
Body Parameters
AddressDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| AddressName | string |
None. |
|
| CreationDate | date |
None. |
|
| CreatorUserId | globally unique identifier |
None. |
|
| Line1 | string |
None. |
|
| Line2 | string |
None. |
|
| Line3 | string |
None. |
|
| Line4 | string |
None. |
|
| Line5 | string |
None. |
|
| City | string |
None. |
|
| Locality | string |
None. |
|
| PostCode | string |
None. |
|
| CountryCode | string |
None. |
|
| Telephone | string |
None. |
|
| EmailAddress | string |
None. |
|
| VatNumber | string |
String length: inclusive between 0 and 20 |
|
| IsDeleted | boolean |
None. |
|
| OrganisationId | globally unique identifier |
None. |
|
| ProfileId | globally unique identifier |
None. |
|
| AddressProperties | Collection of AddressPropertyDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "ee07d92d-77ef-4605-ad6a-25be7c165f08",
"AddressName": "sample string 2",
"CreationDate": "2025-12-06T04:48:10.2771433+00:00",
"CreatorUserId": "f67ae6c5-e65c-45b2-9be5-0a188ffee347",
"Line1": "sample string 5",
"Line2": "sample string 6",
"Line3": "sample string 7",
"Line4": "sample string 8",
"Line5": "sample string 9",
"City": "sample string 10",
"Locality": "sample string 11",
"PostCode": "sample string 12",
"CountryCode": "sample string 13",
"Telephone": "sample string 14",
"EmailAddress": "sample string 15",
"VatNumber": "sample string 16",
"IsDeleted": true,
"OrganisationId": "c35b8980-03c3-4d4e-80c6-f018b079c95e",
"ProfileId": "1850bc3b-bb0c-4ded-8aa1-0185ea2de70a",
"AddressProperties": [
{
"Id": "e6d4aa34-da83-48d9-8a5f-81c3d1c37b30",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-06T04:48:10.2771433+00:00",
"AddressId": "8c0d26fe-dfc4-4027-b890-3b8152ea5043"
},
{
"Id": "e6d4aa34-da83-48d9-8a5f-81c3d1c37b30",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-06T04:48:10.2771433+00:00",
"AddressId": "8c0d26fe-dfc4-4027-b890-3b8152ea5043"
}
]
}
application/xml, text/xml
Sample:
<AddressDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Profile.Models">
<AddressName>sample string 2</AddressName>
<AddressProperties>
<AddressPropertyDto>
<AddressId>8c0d26fe-dfc4-4027-b890-3b8152ea5043</AddressId>
<CreationDate>2025-12-06T04:48:10.2771433+00:00</CreationDate>
<Id>e6d4aa34-da83-48d9-8a5f-81c3d1c37b30</Id>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</AddressPropertyDto>
<AddressPropertyDto>
<AddressId>8c0d26fe-dfc4-4027-b890-3b8152ea5043</AddressId>
<CreationDate>2025-12-06T04:48:10.2771433+00:00</CreationDate>
<Id>e6d4aa34-da83-48d9-8a5f-81c3d1c37b30</Id>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</AddressPropertyDto>
</AddressProperties>
<City>sample string 10</City>
<CountryCode>sample string 13</CountryCode>
<CreationDate>2025-12-06T04:48:10.2771433+00:00</CreationDate>
<CreatorUserId>f67ae6c5-e65c-45b2-9be5-0a188ffee347</CreatorUserId>
<EmailAddress>sample string 15</EmailAddress>
<Id>ee07d92d-77ef-4605-ad6a-25be7c165f08</Id>
<IsDeleted>true</IsDeleted>
<Line1>sample string 5</Line1>
<Line2>sample string 6</Line2>
<Line3>sample string 7</Line3>
<Line4>sample string 8</Line4>
<Line5>sample string 9</Line5>
<Locality>sample string 11</Locality>
<OrganisationId>c35b8980-03c3-4d4e-80c6-f018b079c95e</OrganisationId>
<PostCode>sample string 12</PostCode>
<ProfileId>1850bc3b-bb0c-4ded-8aa1-0185ea2de70a</ProfileId>
<Telephone>sample string 14</Telephone>
<VatNumber>sample string 16</VatNumber>
</AddressDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.