GET api/calendars/{Id}

Get a calendar by the id

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
Id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Calendar
NameDescriptionTypeAdditional information
CalendarId

Calendar Id. Primary key of the calendars table.

 integer

None.
PropertyId

Property Id. See the GET api/properties/{propertyId} route to get the property data.

 integer

None.
CalendarName

Calendar Name.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CalendarId": 1,
  "PropertyId": 2,
  "CalendarName": "sample string 3"
}

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)