GET api/address/{id}

Get an address by its Id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the address to get. Pass 0 to be returned an empty data contract.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The address or null if it does not exist

Dezrez.Core.DataContracts.External.Api.Location.Query.AddressDataContract

Name	Type	Additional information
Location	Dezrez.Core.DataContracts.External.Api.Location.Query.LocationDataContract	None.
AddressSource	Dezrez.Core.DataContracts.External.Api.System.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	Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "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 1",
  "OrganizationName": "sample string 2",
  "Number": "sample string 3",
  "BuildingName": "sample string 4",
  "Street": "sample string 5",
  "Town": "sample string 6",
  "Locality": "sample string 7",
  "County": "sample string 8",
  "Postcode": "sample string 9",
  "CreatedDate": "2024-11-21T09:52:07.9721158Z",
  "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": 11
}