GET api/buildings/{buildingId}/collectionsagentbuildinglinks?active={active}
Gets all agents that are currently assigned to the building
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| buildingId |
|
integer |
Required |
| active |
|
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
BuildingCollectionAgentViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
|
integer |
None. |
| BuildingId |
|
integer |
None. |
| AgentId |
|
integer |
None. |
| StartDate |
|
string |
None. |
| EndDate |
|
string |
None. |
| IsExpired |
|
boolean |
None. |
| Description |
|
string |
None. |
| Agent |
|
DetailedCollectionsAgentViewModel |
None. |
Response Formats
application/json, text/json
{
"id": 1,
"buildingId": 2,
"agentId": 3,
"startDate": "sample string 4",
"endDate": "sample string 5",
"isExpired": false,
"description": "sample string 6",
"agent": {
"agentId": 1,
"contactName": "sample string 2",
"phone": "sample string 3",
"email": "sample string 4",
"notes": "sample string 5",
"createdBy": 6,
"createdOn": "2025-10-29T04:40:44.777805-04:00",
"modifiedBy": 1,
"modifiedOn": "2025-10-29T04:40:44.777805-04:00",
"agencyId": 8,
"agencyName": "sample string 9",
"agencyPhone": "sample string 10",
"agencyEmail": "sample string 11",
"addressId": 12,
"address1": "sample string 13",
"address2": "sample string 14",
"city": "sample string 15",
"state": "sample string 16",
"zipCode": "sample string 17",
"country": "sample string 18",
"addressTypeId": 19
}
}
application/xml, text/xml
<BuildingCollectionAgentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Buildings">
<Agent xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
<d2p1:Address1>sample string 13</d2p1:Address1>
<d2p1:Address2>sample string 14</d2p1:Address2>
<d2p1:AddressId>12</d2p1:AddressId>
<d2p1:AddressTypeId>19</d2p1:AddressTypeId>
<d2p1:AgencyEmail>sample string 11</d2p1:AgencyEmail>
<d2p1:AgencyId>8</d2p1:AgencyId>
<d2p1:AgencyName>sample string 9</d2p1:AgencyName>
<d2p1:AgencyPhone>sample string 10</d2p1:AgencyPhone>
<d2p1:AgentId>1</d2p1:AgentId>
<d2p1:City>sample string 15</d2p1:City>
<d2p1:ContactName>sample string 2</d2p1:ContactName>
<d2p1:Country>sample string 18</d2p1:Country>
<d2p1:CreatedBy>6</d2p1:CreatedBy>
<d2p1:CreatedOn>2025-10-29T04:40:44.777805-04:00</d2p1:CreatedOn>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:ModifiedOn>2025-10-29T04:40:44.777805-04:00</d2p1:ModifiedOn>
<d2p1:Notes>sample string 5</d2p1:Notes>
<d2p1:Phone>sample string 3</d2p1:Phone>
<d2p1:State>sample string 16</d2p1:State>
<d2p1:ZipCode>sample string 17</d2p1:ZipCode>
</Agent>
<AgentId>3</AgentId>
<BuildingId>2</BuildingId>
<Description>sample string 6</Description>
<EndDate>sample string 5</EndDate>
<Id>1</Id>
<StartDate>sample string 4</StartDate>
</BuildingCollectionAgentViewModel>