GET api/properties/{PropertyId}/residentalert

Get Resident Alert by Property ID

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
PropertyId

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

ResidentAlert
NameDescriptionTypeAdditional information
AccountNumber

string

None.
Phone

string

None.
EmergencyHours

string

None.
NonEmergencyHours

string

None.
Instructions

string

None.
FAQ

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "AccountNumber": "sample string 1",
  "Phone": "sample string 2",
  "EmergencyHours": "sample string 3",
  "NonEmergencyHours": "sample string 4",
  "Instructions": "sample string 5",
  "FAQ": "sample string 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)