GET api/images?filePath={filePath}&size={size}

Returns an image given the encoded file path. This route can not be called unless the prerequisite route that contains the file path is called first. The prerequisite route will contain an encoded file path named PathToFile. This PathToFile value should be passed as the filePath query string value when calling this route.

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
filePath

string

Required
size

(Optional) Values can be: normal or thumbnail

 string

normal

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

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)
  • 115: MissingRequiredQueryParameter
    (Invalid request format. A required query parameter was not specified for this request., BadRequest)
  • 107: ImageNotFound
    (There was an issue retrieving the requested image file., NotFound)
  • 119: ImageTypeNotSupported
    (Image type not supported, BadRequest)