Get group inbox search results

get

/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.

Note: Pagination is not currently supported, so the limit and page parameter are not recognized.

Request

Query Parameters
  • Collection Format: multi
    List of unique identifiers of the group inbox being searched.
  • 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
  • The name of the group inbox being searched. The name can contain any type and number of characters.
  • Minimum Length: 1
    For list pagination. The value of the opc-next-page response header from the previous List request.
Header Parameters
  • Specifies which media types are acceptable for the response. Defaults to application/json.
    Default Value: application/json
  • Specifies which character sets are acceptable for the response. Defaults to UTF-8.
    Default Value: UTF-8
  • Contains the credentials to authenticate a consumer to the service.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Success
Headers
  • For list pagination. When this header appears in the response, additional pages of results remain.
  • For list pagination. When this header appears in the response, additional pages of results remain.
  • 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.
Body ()
Root Schema : GroupInboxCollection
Type: object
Contains a list of group inboxes.
Show Source
Nested Schema : items
Type: array
List of group inboxes. Can be empty.
Show Source
Nested Schema : GroupInboxSummary
Type: object
Summary of the group inbox sender.
Show Source
Nested Schema : PersonSimple
Type: 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.

Show Source
Nested Schema : PersonNameSummary
Type: object
A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
Show Source

400 Response

Bad Request
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source

401 Response

Unauthorized
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source

404 Response

Not Found
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source

429 Response

Too Many Requests
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source

500 Response

Internal Server Error
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source

Default Response

Unknown Error
Headers
  • 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.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • 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.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: 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.

Show Source
Back to Top