GET AddressRecommendedDistances/ByAddress/{id}

Gets all AddressRecommendedDistances for the given Address Id.


Parameters

NameDescriptionAdditional information
id
The Id of the Address to fetch the distances for.

Define this parameter in the request URI.

Response body formats

A GetAddressRecommendedDistancesResponse containing any matching AddressRecommendedDistances

application/json, text/json

Sample:
{
  "List": [
    {
      "Id": 1,
      "AddressAId": 2,
      "AddressBId": 3,
      "RecommendedDistance": 4.0
    },
    {
      "Id": 1,
      "AddressAId": 2,
      "AddressBId": 3,
      "RecommendedDistance": 4.0
    },
    {
      "Id": 1,
      "AddressAId": 2,
      "AddressBId": 3,
      "RecommendedDistance": 4.0
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetAddressRecommendedDistancesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:AddressRecommendedDistance>
      <d2p1:AddressAId>2</d2p1:AddressAId>
      <d2p1:AddressBId>3</d2p1:AddressBId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:RecommendedDistance>4</d2p1:RecommendedDistance>
    </d2p1:AddressRecommendedDistance>
    <d2p1:AddressRecommendedDistance>
      <d2p1:AddressAId>2</d2p1:AddressAId>
      <d2p1:AddressBId>3</d2p1:AddressBId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:RecommendedDistance>4</d2p1:RecommendedDistance>
    </d2p1:AddressRecommendedDistance>
    <d2p1:AddressRecommendedDistance>
      <d2p1:AddressAId>2</d2p1:AddressAId>
      <d2p1:AddressBId>3</d2p1:AddressBId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:RecommendedDistance>4</d2p1:RecommendedDistance>
    </d2p1:AddressRecommendedDistance>
  </List>
</GetAddressRecommendedDistancesResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body