Device Mailbox
Associates a
- : Login
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox/_export HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}- : Login
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox/{id}/_export HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.
- : Login
The offet of the first result to return
The count of items to return in this result set
True if the server should count the matching results. May reduce performance
Instructs the result set to be ordered (in format: property:(asc|desc))
The query state identifier. This allows the client to get a stable result set.
When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
OPTIONS /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
There is not response for this method
No content
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
HEAD /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*
No content
This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}
- : Login
The identifier of the object which should be retrieved
True if the server should send related objects to the caller in a bundle
When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the
The identifier of the resource to be deleted
When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
There is a conflict in the update request (version mismatch)
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
DELETE /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.
The identifier of the resource to be retrieved
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
There is not response for this method
No content
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
HEAD /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*
No content
This method returns a barcode which explicitly points at the specified resource in the specified authority.
The barcode is generated using the server's configuration, and is signed by the server's signing key.
For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api- : Login
The identifier of the resource for which a VRP should be generated
The format of the barcode (santedb-vrp, code39, etc.)
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox/{id}/_code HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return the structured contents of that code so the client can best determine how to represent the data.
For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api- : Login
The identifier of the object for which the pointer should be created
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
A query parameter which references itself - this is for query filters which pass the original data in
Gets a tag which changes whenever the object is updated
Operation was completed successfully
Associates a
Gets the target of the association
Gets or sets the flags
Gets or sets the time of the alert.
Get the modification date
Gets or sets the source entity's key (where the relationship is FROM)
Gets or sets the primary identifying UUID of this object
Gets or sets the operation
Gets the type registration of this object
The provided resource was in an incorrect format
The principal is unauthorized and needs to either elevate or authenticate themselves
The principal is not permitted (cannot elevate) to perform the operation
The requested object does not exist
The specified object did exist however is no-longer present
The client is submitting an invalid object
There was a business rule violation executing the operation
The server rejected the request due to a throttling constraint
The server encountered an error processing the result
The service is not available (starting up or shutting down)
GET /hdsi/DeviceMailbox/{id}/_ptr HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "123e4567-e89b-12d3-a456-426614174000",
"flags": "u",
"time": "text",
"modifiedOn": "2026-01-01",
"source": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"operation": "Auto",
"$type": "text"
}Last updated
Was this helpful?