Links an Address to an Employee as a HOME address. This is achieved by creating a HomeAddressLinkage, which will be visible on the Employee. Note that rather than edit an existing linkage, you should remove the existing linkage and recreate it.
| Name | Description | Additional information |
|---|---|---|
| request | The linkage data, which defines extra information about the user's relationship with the address. |
Define this parameter in the request body. |
{
"Id": 0,
"StartDate": "2014-02-20T00:00:00",
"EndDate": "2014-08-25T00:00:00",
"EmployeeId": 1,
"AddressId": 1
}
<HomeAddressLinkage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types"> <AddressId>1</AddressId> <EmployeeId>1</EmployeeId> <EndDate>2014-08-25T00:00:00</EndDate> <Id>0</Id> <StartDate>2014-02-20T00:00:00</StartDate> </HomeAddressLinkage>
Sample not available.
{
"Item": {
"Id": 1,
"StartDate": "2025-01-26T07:12:12.1710366+00:00",
"EndDate": "2025-01-26T07:12:12.1710366+00:00",
"EmployeeId": 2,
"AddressId": 3
},
"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
}
]
}
}
<HomeAddressLinkageResponse 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:AddressId>3</d2p1:AddressId>
<d2p1:EmployeeId>2</d2p1:EmployeeId>
<d2p1:EndDate>2025-01-26T07:12:12.1710366+00:00</d2p1:EndDate>
<d2p1:Id>1</d2p1:Id>
<d2p1:StartDate>2025-01-26T07:12:12.1710366+00:00</d2p1:StartDate>
</Item>
</HomeAddressLinkageResponse>