GET api/calllogs/{id}
Get a call log by the id
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
(Required) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CallCenterActivityLog| Name | Description | Type | Additional information |
|---|---|---|---|
| LogId |
Log Id. Primary key of the callcenter activity log table. |
integer |
None. |
| PropertyId |
Property Id. See the GET api/properties/{propertyId} route to get the property data. |
integer |
None. |
| UnitId |
Unit Id. See the GET api/units/{unitId} route to get the unit data. |
integer |
None. |
| ResidentId |
Resident Id. See the GET api/residents/{Id} route to get resident data. |
integer |
None. |
| CallFrom |
Calls can be from a unit/resident or from other source. "Call From" will be populated with the resident name in case UnitId and ResidentId are not null or with the user's input in case the call is not linked to a unit/resident. |
string |
None. |
| ModuleStatusId |
Module Status Id. See the GET api/modulestatus/{id} route to get the arch mod status. |
integer |
None. |
| Subject |
Subject. |
string |
None. |
| Notes |
Notes. |
string |
None. |
| LogReasons |
Id list of all the call log reasons related to the call. See api/calllogreasons route to get all call log reasons. |
Collection of integer |
None. |
| Takenby |
Taken By. |
string |
None. |
| OldComments |
Old comments to show as Read Only information. To add new comments use NewComment property |
Collection of CallCenterActivityLogComment |
None. |
| NewComments |
NewComment property allows to add a new comment when modifying an existing call log |
string |
None. |
| CreatedOn |
This is the contact date or date of the call |
date |
None. |
Response Formats
application/json, text/json
{
"LogId": 1,
"PropertyId": 1,
"UnitId": 1,
"ResidentId": 1,
"CallFrom": "sample string 2",
"ModuleStatusId": 3,
"Subject": "sample string 4",
"Notes": "sample string 5",
"LogReasons": [
1,
2
],
"Takenby": "sample string 6",
"OldComments": [
{
"Comment": "sample string 1",
"Date": "sample string 2",
"User": "sample string 3",
"Status": "sample string 4"
},
{
"Comment": "sample string 1",
"Date": "sample string 2",
"User": "sample string 3",
"Status": "sample string 4"
}
],
"NewComments": "sample string 7",
"CreatedOn": "2025-12-24T05:22:34.8614583-05:00"
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)