GET api/modulestatuses/{id}

Get a module status 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

ModuleStatus
NameDescriptionTypeAdditional information
ModuleStatusId

Module Status Id. Primary key of the module status table.

 integer

None.
ModuleStatusName

Module Status Name.

 string

None.
ModuleId

Module Id. See GET api/modules/{id} to get the module

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "ModuleStatusId": 1,
  "ModuleStatusName": "sample string 2",
  "ModuleId": 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)