POST api/contacts/{id}/contactaddresses

Insert a new ContactAddress.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The primary key of the parent Contact record in the Hobsons database.

 integer

Required

Body Parameters

The ContactAddress object which is passed in via the request body.

ContactAddressDto
NameDescriptionTypeAdditional information
CrmNumber

A reference to the primary key of the Contact record that is associated with the ContactAddress. Ignored for PUT (except bulk updates) and POST (except bulk inserts) requests sent to the API.

 integer

None.
AddressTypeId

A reference to the primary key of the AddressType record that is binded to the ContactAddress. Ignored for PUT (except bulk updates) requests sent to the API.

 integer

Required

Range: inclusive between 1 and 99999999
AddressTypeName

The name of the AddressType record that is binded to the ContactAddress. Ignored for PUT and POST requests sent to the API.

 string

None.
StreetAddressLine1

The address of the ContactAddress (i.e. Unit Number, Street Number, Street Name).

 string

String length: inclusive between 0 and 200
StreetAddressLine2

Further information that may not fit on Address Line 1.

 string

String length: inclusive between 0 and 200
StreetAddressLine3

Further information that may not fit on Address Line 1 and 2.

 string

String length: inclusive between 0 and 200
TownSuburb

string

String length: inclusive between 0 and 120
StateCity

string

String length: inclusive between 0 and 120
Postcode

string

String length: inclusive between 0 and 15
CountryId

A reference to the primary key of the Country record that is binded to the ContactAddress.

 integer

Range: inclusive between 1 and 99999999
CountryName

The name of the Country record that is binded to the ContactAddress. Ignored for PUT and POST requests sent to the API.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CrmNumber": 1,
  "AddressTypeId": 2,
  "AddressTypeName": "sample string 3",
  "StreetAddressLine1": "sample string 4",
  "StreetAddressLine2": "sample string 5",
  "StreetAddressLine3": "sample string 6",
  "TownSuburb": "sample string 7",
  "StateCity": "sample string 8",
  "Postcode": "sample string 9",
  "CountryId": 1,
  "CountryName": "sample string 10"
}

Response Information

Resource Description

The type of ContactAddress inserted in the Hobsons database.

integer

Response Formats

application/json, text/json

Sample: 
1