Get group inbox search results
/20241001/groupInboxes
Retrieves the group inbox search results based on the provided name or ID.
A group inbox is a shared inbox that multiple personnel join to view and manage messages. Responses return group inboxes based on the name or ID provided. The search result that contains the ID and name of the group inbox is generally used to build out reference data with routing rules.
The following information applies to responses returned for group inbox search results:
- If neither the name or ID is provided, or an asterisk (*) or empty spaces are provided for the name, the response returns all group inbox results.
- If both the name and ID are provided, the response returns a
400
(Bad Request) status code. - If part of the ID list provided is invalid, the response returns results from the valid IDs, or an empty array if all provided IDs are invalid.
Request
-
id: array[string]
Collection Format:
multi
List of unique identifiers of the group inbox being searched. -
limit: integer
Minimum Value:
1000
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List request.Default Value:1000
-
name: string
The name of the group inbox being searched. The name can contain any type and number of characters.
-
page: string
Minimum Length:
1
For list pagination. The value of the opc-next-page response header from the previous List request.
-
accept: string
Specifies which media types are acceptable for the response. Defaults to
application/json
.Default Value:application/json
-
accept-charset: string
Specifies which character sets are acceptable for the response. Defaults to
UTF-8
.Default Value:UTF-8
-
authorization(required): string
Contains the credentials to authenticate a consumer to the service.
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Response
- application/json
200 Response
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain.
-
opc-prev-page: string
For list pagination. When this header appears in the response, additional pages of results remain.
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
items(required):
array items
List of group inboxes. Can be empty.
array
-
Array of:
object GroupInboxSummary
Summary of the group inbox sender.
object
-
groupInboxName(required):
string
The name of the group inbox.
-
personnelSender:
object PersonSimple
A simple representation of the individual person that was retrieved.
The individual could be a personnel member (provider), a patient, or a non-patient person.
object
A simple representation of the individual person that was retrieved.
The individual could be a personnel member (provider), a patient, or a non-patient person.
-
id(required):
string
The unique identifier for the individual.
-
name:
object PersonNameSummary
A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
object
-
firstName:
string
The person's first given name.
-
fullName:
string
The fully formatted name.
-
lastName:
string
The person's family last name.
400 Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.
401 Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.
404 Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.
429 Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.
500 Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.
Default Response
-
opc-request-id: string
Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array pointers
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example,
/data
for a primary data object, or/data/attributes/title
for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.
array
array
array
A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.
For example, /data
for a primary data object, or /data/attributes/title
for a specific attribute. A JSON pointer must
point to a value in the request document that exists; if it does not, ignore the pointer.