GET api/properties/{propertyId}/violationlettersequence?page={page}&pageSize={pageSize}

Get all the violation letter sequences for a property The list will contain property specific sequence and company default(only the ones that don't match any property specific rules). Company default sequence will have the propertyId set to null inside the object

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
propertyId

(Required)

integer

Required

page

(Optional)The page number of returned records based on the page size

integer

0

pageSize

(Optional)The number of records to return per page

integer

0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfViolationLetterSequence
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of ViolationLetterSequence

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Elements": [
    {
      "Id": 1,
      "PropertyId": 2,
      "CategoryId": 1,
      "SubCategoryId": 1,
      "ActionId": 1,
      "Step": 3,
      "FineAmount": 4,
      "FineIncrement": 5
    },
    {
      "Id": 1,
      "PropertyId": 2,
      "CategoryId": 1,
      "SubCategoryId": 1,
      "ActionId": 1,
      "Step": 3,
      "FineAmount": 4,
      "FineIncrement": 5
    }
  ]
}

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)