Uploads a picture for personnel by person ID to OMS/IPS. The body of the request is the base-64 encoded string of image data. The body should be formatted as a JSON object with the following schema where the value in imageData is the base-64 encoded string of the image data.
| Code Block |
|---|
{
"image": {
"imageData": "0f00aabcd70ef..."
}
} |
Panel
| borderColor | #ccc |
|---|---|
| bgColor | #FCFCFC |
| titleColor | #FFFFFF |
| titleBGColor | #a0a0a0 |
| borderStyle | solid |
| title | Appointments API |
| Code Block |
|---|
{
"image": {
"imageData": "0f00aabcd70ef..."
}
} |
...
URL
PUT https://base.url.org/api/picture/{personId}/upload?scaleDimension=648
Parameters
Parameter Name | Required | Description | Default |
|---|---|---|---|
personId | required | the numeric ID of the person record | — |
scaleDimension | optional | an optional list of integers to save scaled versions of the image | — |
Examples
https://base.url.org/api/picture/0/upload?scaleDimension=648
Saves a new image for person ID 0 with an additional image scaled to 648 by 648.
Responses
200 OK | Returns the database record of the new image object along with the remote file name. |
401 Unauthorized | The current account in the request header does not have access to the API |
403 Forbidden | The current account in the request header does not have access to the person record requested in the request URL |
404 Not Found | Returned if NO person record with the specifed ID was found that matched the parameter value |
500 Internal Server Error | One or more request string parameters are invalid or an error was encountered by the server while processing the request |