GET api/workorderphotos/{id}

Get a work order photo data by the ID (primary key). To retrieve the actual image file, the api/files?filePath={filePath} route must be called where the filePath parameter is the PathToFile value that is being returned by this resource.

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

WorkOrderPhoto
NameDescriptionTypeAdditional information
WorkorderId

Work Order Id. See the GET api/workorders/{id} route to get the work order data.

 integer

None.
PhotoId

Photo Id. Primary key of the child model table.

 integer

None.
Pic

Photo Name. The actual name of the image file.

 string

None.
Caption

Photo Caption.

 string

None.
CreationDate

Photo Creation Date.

 date

None.
PathToFile

The path to the actual location of the file.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "WorkorderId": 1,
  "PhotoId": 1,
  "Pic": "sample string 2",
  "Caption": "sample string 3",
  "CreationDate": "2025-12-24T05:25:28.410947-05:00",
  "PathToFile": "sample string 4"
}

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)