Adds an AddressRecommendedDistance.
| Name | Description | Additional information |
|---|---|---|
| request | The AddressRecommendedDistance to add.
When adding a new AddressRecommendedDistance through the API, the following properties are required:
Id: Must be set to 0, or the add will throw an error.
AddressAId: Must be the ID of a valid Address.
AddressBId: Must be the ID of a valid Address. |
Define this parameter in the request body. |
{
"Id": 1,
"AddressAId": 2,
"AddressBId": 3,
"RecommendedDistance": 4.0
}
<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>
Sample not available.
{
"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
}
]
}
}
<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>