GET api/units/{unitId}/unitsummary

Get the unit summary given the unit ID

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
unitId

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

UnitSummary
NameDescriptionTypeAdditional information
UnitId

Unit Id. See the GET api/units/{unitId} route to get the unit data.

 integer

None.
AccountBalance

Account Balance.

 decimal number

None.
WorkOrders

The count of work orders for a given property or unit.

 integer

None.
Violations

The count of violations for a given property or unit.

 integer

None.
CallLogs

The count of call logs for a given property or unit.

 integer

None.
ArchMods

The count of arch mods for a given property or unit.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "UnitId": 1,
  "AccountBalance": 2.1,
  "WorkOrders": 3,
  "Violations": 4,
  "CallLogs": 5,
  "ArchMods": 6
}

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)