PUT AddressRecommendedDistances/{id}

Edits an AddressRecommendedDistance.
When editing an existing AddressRecommendedDistance through the API, the following properties are required:
Id: Must be set to the Id of a valid AddressRecommendedDistance.
RecommendedDistance: This can change.
Note: You cannot edit the two address Ids using this method. In order to do this, create another recommended distance and delete the original.


Parameters

NameDescriptionAdditional information
id 
The Id of the Item to edit.

Define this parameter in the request URI.
request 
The Item to edit.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "AddressAId": 2,
  "AddressBId": 3,
  "RecommendedDistance": 4.0
}

application/xml, text/xml

Sample: 
<AddressRecommendedDistance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <AddressAId>2</AddressAId>
  <AddressBId>3</AddressBId>
  <Id>1</Id>
  <RecommendedDistance>4</RecommendedDistance>
</AddressRecommendedDistance>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

The edited AddressRecommendedDistance in an AddressRecommendedDistanceResponse.

application/json, text/json

Sample: 
{
  "Item": {
    "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: 
<AddressRecommendedDistanceResponse 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>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:AddressAId>2</d2p1:AddressAId>
    <d2p1:AddressBId>3</d2p1:AddressBId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:RecommendedDistance>4</d2p1:RecommendedDistance>
  </Item>
</AddressRecommendedDistanceResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body