POST api/addresses

Request Information

URI Parameters

None.

Body Parameters

Name	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": "f7023da2-bfed-4b4a-9f0d-1ab687de41e1",
  "AddressName": "sample string 2",
  "CreationDate": "2026-01-10T18:54:08.9293742+00:00",
  "CreatorUserId": "c53c8367-9ce0-4419-8756-d6c28f5a61d9",
  "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": "5765fb29-d9fb-4810-a384-d680b972c287",
  "ProfileId": "1f72ae75-8ff3-45c5-900c-9f7a342ec2d4",
  "AddressProperties": [
    {
      "Id": "b6502ec7-b4cc-474a-ac58-391f86e43871",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-10T18:54:08.9293742+00:00",
      "AddressId": "d9c7057a-4b96-496a-bd8d-c55e4189a1c5"
    },
    {
      "Id": "b6502ec7-b4cc-474a-ac58-391f86e43871",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-10T18:54:08.9293742+00:00",
      "AddressId": "d9c7057a-4b96-496a-bd8d-c55e4189a1c5"
    }
  ]
}

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>d9c7057a-4b96-496a-bd8d-c55e4189a1c5</AddressId>
      <CreationDate>2026-01-10T18:54:08.9293742+00:00</CreationDate>
      <Id>b6502ec7-b4cc-474a-ac58-391f86e43871</Id>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </AddressPropertyDto>
    <AddressPropertyDto>
      <AddressId>d9c7057a-4b96-496a-bd8d-c55e4189a1c5</AddressId>
      <CreationDate>2026-01-10T18:54:08.9293742+00:00</CreationDate>
      <Id>b6502ec7-b4cc-474a-ac58-391f86e43871</Id>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </AddressPropertyDto>
  </AddressProperties>
  <City>sample string 10</City>
  <CountryCode>sample string 13</CountryCode>
  <CreationDate>2026-01-10T18:54:08.9293742+00:00</CreationDate>
  <CreatorUserId>c53c8367-9ce0-4419-8756-d6c28f5a61d9</CreatorUserId>
  <EmailAddress>sample string 15</EmailAddress>
  <Id>f7023da2-bfed-4b4a-9f0d-1ab687de41e1</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>5765fb29-d9fb-4810-a384-d680b972c287</OrganisationId>
  <PostCode>sample string 12</PostCode>
  <ProfileId>1f72ae75-8ff3-45c5-900c-9f7a342ec2d4</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

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.