PUT api/people/{id}/addaddress

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

AddPersonAddressCommandDataContract
NameDescriptionTypeAdditional information
ContactOrder

integer

None.

AddressType

EnumDataContract

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

AddressSource

EnumDataContract

None.

SourceId

string

None.

OrganizationName

string

None.

Number

string

None.

BuildingName

string

None.

Street

string

None.

Town

string

None.

Locality

string

None.

County

string

None.

Postcode

string

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ContactOrder": 1,
  "AddressType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Latitude": 2.1,
  "Longitude": 3.1,
  "AddressSource": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SourceId": "sample string 4",
  "OrganizationName": "sample string 5",
  "Number": "sample string 6",
  "BuildingName": "sample string 7",
  "Street": "sample string 8",
  "Town": "sample string 9",
  "Locality": "sample string 10",
  "County": "sample string 11",
  "Postcode": "sample string 12",
  "CreatedDate": "2018-11-16T09:16:34.0781354Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 14
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddPersonAddressCommandDataContract'.

Response Information

Resource Description

ContactAddressDataContract
NameDescriptionTypeAdditional information
AddressType

EnumDataContract

None.

ContactOrder

integer

None.

Location

LocationDataContract

None.

AddressSource

EnumDataContract

None.

SourceId

string

None.

OrganizationName

string

None.

Number

string

None.

BuildingName

string

None.

Street

string

None.

Town

string

None.

Locality

string

None.

County

string

None.

Postcode

string

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "AddressType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ContactOrder": 1,
  "Location": {
    "CenterPoint": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Altitude": 3.1,
      "Order": 4,
      "Id": 5
    },
    "Extent": [
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      },
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      }
    ],
    "ViewPoints": [
      {
        "Point": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Pitch": 1.1,
        "Heading": 2.1,
        "FieldOfVision": 3.1,
        "Zoom": 4.1,
        "Label": "sample string 5",
        "Id": 6
      },
      {
        "Point": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Pitch": 1.1,
        "Heading": 2.1,
        "FieldOfVision": 3.1,
        "Zoom": 4.1,
        "Label": "sample string 5",
        "Id": 6
      }
    ],
    "Id": 1
  },
  "AddressSource": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SourceId": "sample string 2",
  "OrganizationName": "sample string 3",
  "Number": "sample string 4",
  "BuildingName": "sample string 5",
  "Street": "sample string 6",
  "Town": "sample string 7",
  "Locality": "sample string 8",
  "County": "sample string 9",
  "Postcode": "sample string 10",
  "CreatedDate": "2018-11-16T09:16:34.0938094Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 12
}