GET api/moduleprogresscodes/{id}

Get a module progress code 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

ModuleProgressCode
NameDescriptionTypeAdditional information
ModuleProgressCodeId

Module Progress Code Id. Primary key of the module progress code table.

 integer

None.
ModuleProgressCodeDescription

Module Progress Code Description.

 string

None.
ModuleStatusId

Module Status Id. See the GET api/modulestatus/{id} route to get the arch mod status.

 integer

None.

Response Formats

application/json, text/json

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