Create a new Usage Session

Create a new Usage Session

If patient is null in the request, the patient id will be read from the device entity

Custom attributes can be specified in the request body

The below table describes the request parameters:

ParameterTypeMandatoryDescription
deviceIdStringtrue
_startTimeLocalDateTimetrueA UTC date-time in the ISO-8601 format
_endTimeLocalDateTimefalseA UTC date-time in the ISO-8601 format
_stateStringtrueSupported values are: ACTIVE, DONE, PAUSED, ACTIVATING, PAUSING, RESUMING, STOPPING
_templateIdUUIDtrueThe id of a Usage Session template that is configured in the settings service.
_configuration.{configurationCustomAttribute1}{configurationCustomAttributes1Type}falseconfiguration custom attribute 1 value
_configuration.{configurationCustomAttributeN}{configurationCustomAttributesNType}falseconfiguration custom attribute N value
_summary._stopReasonStringfalse
_summary._stopReasonCodeStringfalseSupported values are: COMPLETION, GENERAL_DEVICE_ERROR, TIMEOUT
_summary.{summaryCustomAttribute1}{summaryCustomAttributes1Type}falsesummary custom attribute 1 value
_summary.{summaryCustomAttributeN}{summaryCustomAttributesNType}falsesummary custom attribute N value
_patient.idUUIDtrue
<customAttributes1><customAttributes1Type>falseCustom attribute 1 value
<customAttributesN><customAttributesNType>falseCustom attribute N value
Language
Authentication
Bearer
JWT
Click Try It! to start a request and see the response here!