Skip to main content

ProGlove Documentation

Photo Reporting Status event

Photo Reporting status is an event that is sent during a photo session.

Fields

Name

Type

Description

Accepted values

Constraints

Required

api_version

String

The API version in which this request is valid.

1.0

Yes

event_type

String

The type of event.

button_pressed

Yes

event_id

String

The unique identifier (UUID) of the event that can be used as reference.

Any

UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Yes

time_created

Integer

The timestamp in milliseconds.

Any

1546300800000 <= value <= 99999999999999

Yes

gateway_serial

String

The serial number of the Gateway Plus.

Any

1 <= length <= 128

No

device_serial

String

The serial number of the connected ProGlove scanners.

Any

1 <= length <= 128

Yes

report_status

String

The status of the report. It will have one of the two following values:

  • report_requested - Indicates that a Photo Reporting session was triggered and a creation of a Photo report was requested.

  • report_created - Indicated the end of the Photo Reporting session, where at least one photo was captured and processed, and the Photo report is ready to be sent to the INSIGHT webportal.

  • report_requested

  • report_created

Yes

report_id

String

The unique Photo report ID that will also be displayed in INSIGHT.

Any

UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Yes

report_title

String

The Photo report title, as specified by the user during the photo session. If not specified, a default title will be assigned.

Any

1 <= length <= 128

Yes

report_description

String

The description of the Photo report, as specified by the user during the photo session. If not specified, the value will be null.

Any

1 <= length <= 4000

No

report_summary

String

The Photo report summary, as specified by the user during the photo session. If not specified, the value will be null.

Any

1 <= length <= 500

No

Examples

Photo Reporting session initiated:

{
  "api_version": "3.0", 
  "event_type": "photo_report_status", 
  "event_id": "7666d25e-1e74-48fe-ac28-2ed3aa7ae5c8", 
  "time_created": 1726230454885, 
  "gateway_serial": "PGGP101203662", 
  "report_status": "report_requested", 
  "report_id": "", 
  "report_title": "photo report from M2MR111101051", 
  "report_description": null, 
  "report_summary": null, 
  "device_serial": "M2MR111101051"
}

Note

The report_id field will initially be blank/empty, as it will not have an ID assigned until the first image is captured.

Photo report created:

{
  "api_version": "3.0", 
  "event_type": "photo_report_status", 
  "event_id": "9f6e7c9d-2370-4c79-9583-355e104ca139", 
  "time_created": 1726231509523, 
  "gateway_serial": "PGGP101203662", 
  "report_status": "report_created", 
  "report_id": "b3fe0b4b-c4a2-47ca-90ba-b6a82a3a838f", 
  "report_title": "photo report from M2MR111101051", 
  "report_description": null, 
  "report_summary": null, 
  "device_serial": "M2MR111101051"
}

See below for examples of a Photo report being requested and created, and where the user has specified the title, description and summary:

{
  "api_version": "3.0", 
  "event_type": "photo_report_status", 
  "event_id": "7666d25e-1e74-48fe-ac28-2ed3aa7ae5c8", 
  "time_created": 1726230454885, 
  "gateway_serial": "PGGP101203662", 
  "report_status": "report_requested", 
  "report_id": "", 
  "report_title": "My Custom Report", 
  "report_description": "A very detailed description of my photo report", 
  "report_summary": "A brief summary of my photo report", 
  "device_serial": "M2MR111101051"
}
{
  "api_version": "3.0", 
  "event_type": "photo_report_status", 
  "event_id": "7666d25e-1e74-48fe-ac28-2ed3aa7ae5c8", 
  "time_created": 1726230454885, 
  "gateway_serial": "PGGP101203662", 
  "report_status": "report_created", 
  "report_id": "b3fe0b4b-c4a2-47ca-90ba-b6a82a3a838f", 
  "report_title": "My Custom Report", 
  "report_description": "A very detailed description of my photo report", 
  "report_summary": "A brief summary of my photo report", 
  "device_serial": "M2MR111101051"
}
In this section: