POST /images/{rowType}/{rowId}/{documentTypeId}
Stores the uploaded image into imaging. Some providers may simply stage the
uploaded image and later pick it up with a batch process whereas others may
immediately store it, making it ready for immediate retrieval.
Roles that can access this endpoint are Users, Drivers, Carriers, Carrier Drivers.
Parameters
| name |
description |
type |
default |
type |
| rowType |
the type of object to which the image is associated
- O - Order
- M - Movement
- C - Customer
- L - Location
- P - Payee
- D - Driver
- T - Tractor
- E - Trailer
- U - User
|
path
|
|
String
|
| rowId |
the ID of the type (most likely the primary key of the row) |
path
|
|
String
|
| documentTypeId |
the document type ID; this value must be one of the values
returned in the GET /{rowType}/{rowId}/documentTypes method |
path
|
|
String
|
| movementId |
the ID of the movement associated with the row (optional) |
query
|
|
String
|
| image |
a single image sent in the body of the request |
body of type: image/jpeg image/gif image/tiff image/png image/bmp application/pdf
|
|
InputStream
|
Result
String
a String containing the batch ID (if staged for later batch pickup) or
the ID of the record stored in the database.
Try It Out
Request