Delete Usage Session

Parameter	Type	Mandatory	Description	Example
deleteOrphanSessionsEnum	string	true	null

The below table describes the response parameters:

Parameter	Type	Description	Example
deletedSessions	array
deletedSessions[index]	array
deletedSessions[index]._id	string	Session ID	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._patient	object
deletedSessions[index]._patient.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._patient.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._patient.parentEntityId	string	The id of the parent entity (appears only for child entities)
deletedSessions[index]._patient.templateName	string	The name of the referenced entity template
deletedSessions[index]._patient.template	object
deletedSessions[index]._patient.template.name	string	The name of the template
deletedSessions[index]._patient.template.displayName	string	The display name of the template
deletedSessions[index]._patient.template.parentTemplate	object
deletedSessions[index]._patient.template.parentTemplate.id	string
deletedSessions[index]._patient.template.parentTemplate.displayName	string
deletedSessions[index]._patient.template.parentTemplate.name	string
deletedSessions[index]._patient.template.id	string	The id of the template
deletedSessions[index]._patient.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._patient.name	string	The caption of the referenced entity
deletedSessions[index]._device	object
deletedSessions[index]._device.id	string
deletedSessions[index]._device.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._device.parentEntityId	string	The id of the parent entity (appears only for child entities)
deletedSessions[index]._device.templateName	string	The name of the referenced entity template
deletedSessions[index]._device.template	object
deletedSessions[index]._device.template.name	string	The name of the template
deletedSessions[index]._device.template.displayName	string	The display name of the template
deletedSessions[index]._device.template.parentTemplate	object
deletedSessions[index]._device.template.parentTemplate.id	string
deletedSessions[index]._device.template.parentTemplate.displayName	string
deletedSessions[index]._device.template.parentTemplate.name	string
deletedSessions[index]._device.template.id	string	The id of the template
deletedSessions[index]._device.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._device.name	string	The caption of the referenced entity
deletedSessions[index]._ownerOrganization	object
deletedSessions[index]._ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
deletedSessions[index]._ownerOrganization.templateName	string	The name of the referenced entity template
deletedSessions[index]._ownerOrganization.template	object
deletedSessions[index]._ownerOrganization.template.name	string	The name of the template
deletedSessions[index]._ownerOrganization.template.displayName	string	The display name of the template
deletedSessions[index]._ownerOrganization.template.parentTemplate	object
deletedSessions[index]._ownerOrganization.template.parentTemplate.id	string
deletedSessions[index]._ownerOrganization.template.parentTemplate.displayName	string
deletedSessions[index]._ownerOrganization.template.parentTemplate.name	string
deletedSessions[index]._ownerOrganization.template.id	string	The id of the template
deletedSessions[index]._ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
deletedSessions[index]._ownerOrganization.name	string	The caption of the referenced entity
deletedSessions[index]._startTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
deletedSessions[index]._endTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
deletedSessions[index]._state	string	The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING	ACTIVE
deletedSessions[index]._initiator	string	What API initiated the session Values:REMOTE_CONTROL,EXTERNAL	EXTERNAL
deletedSessions[index]._requiredMeasurementIntervalMilliseconds	integer	The interval between measurements in milliseconds	1000
deletedSessions[index]._template	object
deletedSessions[index]._template.name	string	The name of the template
deletedSessions[index]._template.displayName	string	The display name of the template
deletedSessions[index]._template.parentTemplate	object
deletedSessions[index]._template.parentTemplate.id	string
deletedSessions[index]._template.parentTemplate.displayName	string
deletedSessions[index]._template.parentTemplate.name	string
deletedSessions[index]._template.id	string	The id of the template
deletedSessions[index]._referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
deletedSessions[index]._configuration	object	An object that holds the entity configuration attributes
deletedSessions[index]._summary	object
deletedSessions[index]._summary._stopReason	string	The reason the session was stopped	Manual Stop
deletedSessions[index]._summary._stopReasonCode	string	The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT	COMPLETION
deletedSessions[index]._lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
deletedSessions[index]._creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
deletedSessions[index]._name	string	The name of the session
deletedSessions[index]._sessionContext	string	The context that is linked to the current session and should be sent in a measurement message
deletedSessions[index]._caption	string

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []