Image Stamps
GET /ImageStampList
Routes key: GetImageStamps
GET http://localhost:3000/ImageStampList
Successful Response:
200 OK
Content-Type: application/json
{
imageStamps : [
{ id: "ZmlsZTEuZ2lm", displayName: "file1.gif" },
{ id: "ZmlsZTIucG5n", displayName: "file2.png" }
]
}
GET /ImageStamp/{imageStampId}/q?format={formatStr}
Routes key: GetImageStamp
Gets the image data from the server. The query string parameter format
defined the format of the response, and supports the following values:
Base64
: Returns a JSON object containing the image as a base64 encoded string, as well as a hash of the original image.Image
: Returns the raw image file itself.
Getting Base64 data:
GET http://localhost:3000/ImageStamp/ZmlsZTIucG5n/q?format=Base64
Successful Response:
200 OK
Content-Type: application/json
{
"dataHash": "1ca8d2e80b6f8f2774f3bc0e6422bc653b0e4d80",
"dataUrl": "data:image/png;base64,..."
}
Getting the image data:
GET http://localhost:3000/ImageStamp/ZmlsZTIucG5n/q?format=Image
Successful Response:
200 OK
Content-Type: {the correct content type for the image}
{binary image data}
Errored Responses:
When an invalid imageStampId
is requested:
400 Bad Request
Content-Type: application/json
{
"errorCode": "BadRequest"
}
When a valid imageStampId
is requested but it does not exist:
404 Not Found
Content-Type: application/json
{
"errorCode": "NotFound"
}