GET api/violationlettersequence/{id}

Gets the violation letter sequence object given the provided ID

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

ViolationLetterSequence
NameDescriptionTypeAdditional information
Id

Sequence Id. Primary key of the violation letter sequence table.

 integer

None.
PropertyId

PropertyId. See the GET api/properties/{propertyId} route to get the property data. PropertyId will be null if the sequence is a company default.

 integer

None.
CategoryId

Category Id. See the GET api/violationcategories/{Id} route to get the violation category data. If Category Id is null then it means that the sequence is for all categories.

 integer

None.
SubCategoryId

Sub Category Id. See the GET api/violationsubcategories route to get the violation sub-category data. If sub-category Id is null then it means that the sequence is for all sub-categories inside a category.

 integer

None.
ActionId

Action Id. See the GET api/violationactions/{id} route to get the violation action data. This represents the violation action Id that corresponds to a particular sequence step.

 integer

None.
Step

Step inside the sequence.

 integer

None.
FineAmount

Fine Amount. The amount to be charged. This value is expressed in cents.

 integer

None.
FineIncrement

Fine Increment will be applied over the last fine imposed in a violation. This value is expressed in cents.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "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)