Applies to integrated customers using the RecoveryConnect APIAdd Recovery Photos
Description: This endpoint uploads and associates photos with a recovery record. Photos may include images of the vehicle, damage, or other relevant recovery evidence.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/photos
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| file_name | Original name of the uploaded file | Yes | name |
| image_name | Display name or caption for the image | Yes | New Picture |
| picture_time | Date and time when the photo was taken (YYYY-MM-DD HH:mm:ss) | Yes | 2019-10-17 23:23:00 |
| data | Base64-encoded string of the image file | Yes | iVBORw0KGgoAAAANSUhEUg… |
| type | Numeric code representing photo type (e.g., 2 = AR General Photo, 3 = Front: Driver side) | Yes | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/photos |
Request Body:
{ "image_name": "New Picture", "picture_time": "2019-10-17 23:23:00", "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "type": 2 } |
Response:
{ "data": { "order_id": 2528012, "type": 0, "case_attachment_type_id": 1, "recovery_has_damage_type_location_id": null, "attachment_id": 6928626, "recovery_id": 805792 } } |
View Recovery Photos
Description: This endpoint retrieves photos associated with a recovery record. Photos may include images of the vehicle, damage, or other relevant recovery evidence.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/photos
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/photos |
Request Body: NA
Response:
{ "data": [ { "id": 6928626, "type": { "id": 1, "name": "Default", "always_show": 0, "is_required": 0, "type": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "deleted_at": "2014-10-29 19:01:18" }, "order_attachment_type_id": 1, "recovery_has_damage_type_location_id": null, "order_id": 2528012, "name": "New Picture", "photo_url": "https://dev-myrecovery.s3.us-east-2.amazonaws.com/orders/original/10001/86038/2020/07/22/DVKuwczUP2Cg/86038_name.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARNJXFDAYINFZWO2G%2F20200722%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20200722T122152Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=6c15e1d74ae10e1325b1f9de39181629daafda4d203b1334903d4dac7b07c6fe", "filename": "86038_name.png", "uploaded_by": { "id": 2423767, "firstname": "Neelima", "lastname": "Maheshwari" }, "created_at": "2020-07-22", "meta": { "lat": "10.00000000", "long": "-10.00000000", "generated_at": "2019-10-17 23:23:00", "created_at": "2020-07-22T06:28:49.000000Z" } } ], "meta": { "standard_photos": [ "string" ], "damage_locations": [ "string" ], "required_photos": [ "string" ], "total": 3 } } |
Add Personal Property Photos
Description: This endpoint uploads and associates personal property photos with a recovery record. These photos may include items removed from the vehicle, personal effects, or other relevant recovery evidence.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/personals/photos
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| file_name | Original name of the uploaded file | Yes | name |
| image_name | Display name or caption for the image | Yes | New Picture |
| picture_time | Date and time when the photo was taken (YYYY-MM-DD HH:mm:ss) | Yes | 2019-10-17 23:23:00 |
| data | Base64-encoded string of the image file | Yes | iVBORw0KGgoAAAANSUhEUg… |
| type | Numeric code representing photo type (e.g., 2 = AR General Photo) | Yes | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/personals/photos |
Request Body:
{ "file_name": "name", "image_name": "New Picture", "picture_time": "2019-10-17 23:23:00", "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "type": 2 } |
Response:
{ "data": { "order_id": 2528012, "type": 0, "case_attachment_type_id": 20, "attachment_id": 6929010, "recovery_id": 123123, "recovery_has_damage_type_location_id": null } } |
View Personal Property Photos
Description: This endpoint retrieves personal property photos associated with a recovery record. These photos may include items removed from the vehicle, personal effects, or other relevant recovery evidence.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/personals/photos
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/personals/photos |
Request Body: NA
Response:
{ "data": [ { "id": 6928626, "type": { "id": 1, "name": "Default", "always_show": 0, "is_required": 0, "type": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "deleted_at": "2014-10-29 19:01:18" }, "order_attachment_type_id": 1, "recovery_has_damage_type_location_id": null, "order_id": 2528012, "name": "New Picture", "photo_url": "https://dev-myrecovery.s3.us-east-2.amazonaws.com/orders/original/10001/86038/2020/07/22/DVKuwczUP2Cg/86038_name.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARNJXFDAYINFZWO2G%2F20200722%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20200722T122152Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=6c15e1d74ae10e1325b1f9de39181629daafda4d203b1334903d4dac7b07c6fe", "filename": "86038_name.png", "uploaded_by": { "id": 2423767, "firstname": "Neelima", "lastname": "Maheshwari", "company_id": 10001 }, "created_at": "2014-10-29 19:01:18", "meta": { "lat": "10.00000000", "long": "-10.00000000", "generated_at": "2019-10-17 23:23:00", "created_at": "2020-07-22T06:28:49.000000Z" } } ] } |