GET api/violationactions/{id}

Get the violation action by the Id (primary key)

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

ViolationAction
NameDescriptionTypeAdditional information
ActionId

Violation Action Id. Primary key of the violations actions table.

 integer

None.
ActionName

Violation Action Name.

 string

None.
ActionViolationStatus

Violation Action Status. Status can be "open" or "closed"

 string

None.
IsRescindable

If true the violation action is rescindable

 boolean

None.
DisplayOrder

Violation Action Display Order. The order in which violation actions should be displayed.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "ActionId": 1,
  "ActionName": "sample string 2",
  "ActionViolationStatus": "sample string 3",
  "IsRescindable": true,
  "DisplayOrder": 1
}

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)