addAppointmentImage

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/rs/addAppointmentImage/{appointmentId}

POST

Uploads an image for the specified appointment.
The image data is based on the HTML5 canvas.toDataURL and FileReader API that return a url string with protocol:type;encoding,data format eg.
data:image/gif;base64,iVBORw0KGgoAAAA... or data:image/jpg;base64,GgoAAAAiVBORw0K...

Currently images from mobiles are scaled down to approx VGA size due to offline storage requirements.  

The 'newname' attribute is to allow renaming from mobiles where image names are often just date stamps and sequential numbers.

acceptable request representations:

• application/json

{
    "filename" : "test.gif",
    "image" : "data:image/gif;base64,iVBORw0KGgoAAAA...",
    "scaled" : "true",
    "scale" : "0.75",
    "rotated" : "false",
    "newname" : "test_99.gif"
}

success response representation:

• application/json

{
    "result" : "success",
    "result_msg" : "",
}

error response representation:

• application/json

{
    "result" : "fail",
    "result_msg" : "<Oneserve error code>",
    "result_error_msg" : "<Oneserve error details>"

}

Notes

See the Resource Scheduler API matrix for the full list of endpoints in this category.