Orion-API

Orion Call Center API

Get a call entry

Retrieves one complete CallEntry by its ID. The caller must have read access to the company that owns the record.

Identify the company with X-Client-Code or the backward-compatible clientCode query parameter. At least one is required. If both are supplied with different values, the query parameter takes precedence. Orion returns 404 Not Found when the record does not exist in the selected company.

get
https://api.zinnia.io/callcenter/v1/CallEntry/{callEntryId}

Query Parameters

clientCodestring

Deprecated: use X-Client-Code. Selects one company. Takes precedence over X-Client-Code if both are supplied. If neither is supplied, search includes every company the caller is authorized to read; get-by-ID requires at least one tenant selector.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Path Parameters

callEntryIdinteger(int32)required

Headers

X-Client-Codestring

Preferred tenant selector for new consumers. Optional only for legacy GET compatibility. If query clientCode is also supplied and conflicts after normalization, the query value wins and the conflict is logged.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

CallEntry

* Additional properties are NOT allowed.
clientCodestringrequiredread-only

>= 1 characters

callEntryIDinteger(int32)requiredread-only

Server-generated call-entry identity.

callerTypeIDinteger | null(int32)read-only
callerTypestring | nullread-only

<= 50 characters

callTypeIDinteger | null(int32)read-only
callTypestring | nullread-only

<= 50 characters

productTypeIDinteger | null(int32)read-only
productTypestring | nullread-only

<= 50 characters

contractstring | nullread-only

Legacy comma-joined contract-number mirror.

<= 200 characters

priorityinteger | null(int32)read-only

>= 0<= 255

notesstring | nullread-only

<= 7000 characters

surveystring | nullread-only

<= 10 characters

isExchangeboolean | nullread-only
isSuspendedboolean | nullread-only
isFollowUpCompletedboolean | nullread-only

Computed from follow-up dates: null when followUpRequestedDate is null; otherwise false when followUpCompletedDate is null, and true when it is present. Not writable.

followUpRequestedDatestring | null(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

followUpCompletedDatestring | null(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

suspendedUntilDatestring | null(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

createdByUserstringrequiredread-only

Acting user supplied by token identity or conditional userName. PUT replaces this actor while preserving createdDate.

>= 1 characters<= 255 characters

createdDatestring(date-time)requiredread-only

Server-generated creation timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

lastUpdatedDatestring(date-time)requiredread-only

Server-generated last-write timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

callTimestring | null(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

callerNamestring | nullread-only

<= 500 characters

phoneFaxNumstring | nullread-only

<= 20 characters

referencestring | nullread-only

<= 250 characters

isWatchOneboolean | nullread-only
isWatchTwoboolean | nullread-only
transactionTypeIDinteger | null(int32)read-only
transactionTypestring | nullread-only

<= 50 characters

isEscalatedboolean | nullread-only
initiatedDatestring | null(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

completeInOrionboolean | nullread-only
isWatchThreeboolean | nullread-only
transactionAmountnumber | nullread-only

Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.

>= -922337203685477.6<= 922337203685477.6

sessionIDstring | nullread-only

<= 50 characters

authStatusstring | nullread-only

Optional authorization-status value, maximum 5 raw-input characters.

<= 5 characters

dobstring | null(date-time)read-only

Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

ssnstring | nullread-only

Optional four-character SSN field. No digits-only restriction is imposed.

<= 4 characters

callSummarystring | nullread-only

<= 7000 characters

callSummaryDatestring | null(date-time)read-only

SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

documentNumberstring | nullread-only

<= 50 characters

callIdstring | nullread-only

<= 50 characters

contractsarray | null[object]read-only
* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/CallEntry/{callEntryId}
 

CallEntry

object
* Additional properties are NOT allowed.
clientCodestringrequiredread-only

>= 1 characters

callEntryIDinteger(int32)requiredread-only

Server-generated call-entry identity.

callerTypeIDinteger(int32)read-only
callerTypestringread-only

<= 50 characters

callTypeIDinteger(int32)read-only
callTypestringread-only

<= 50 characters

productTypeIDinteger(int32)read-only
productTypestringread-only

<= 50 characters

contractstringread-only

Legacy comma-joined contract-number mirror.

<= 200 characters

priorityinteger(int32)read-only

>= 0<= 255

notesstringread-only

<= 7000 characters

surveystringread-only

<= 10 characters

isExchangebooleanread-only
isSuspendedbooleanread-only
isFollowUpCompletedbooleanread-only

Computed from follow-up dates: null when followUpRequestedDate is null; otherwise false when followUpCompletedDate is null, and true when it is present. Not writable.

followUpRequestedDatestring(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

followUpCompletedDatestring(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

suspendedUntilDatestring(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

createdByUserstringrequiredread-only

Acting user supplied by token identity or conditional userName. PUT replaces this actor while preserving createdDate.

>= 1 characters<= 255 characters

createdDatestring(date-time)requiredread-only

Server-generated creation timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

lastUpdatedDatestring(date-time)requiredread-only

Server-generated last-write timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

callTimestring(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

callerNamestringread-only

<= 500 characters

phoneFaxNumstringread-only

<= 20 characters

referencestringread-only

<= 250 characters

isWatchOnebooleanread-only
isWatchTwobooleanread-only
transactionTypeIDinteger(int32)read-only
transactionTypestringread-only

<= 50 characters

isEscalatedbooleanread-only
initiatedDatestring(date-time)read-only

SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

completeInOrionbooleanread-only
isWatchThreebooleanread-only
transactionAmountnumberread-only

Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.

>= -922337203685477.6<= 922337203685477.6

sessionIDstringread-only

<= 50 characters

authStatusstringread-only

Optional authorization-status value, maximum 5 raw-input characters.

<= 5 characters

dobstring(date-time)read-only

Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

ssnstringread-only

Optional four-character SSN field. No digits-only restriction is imposed.

<= 4 characters

callSummarystringread-only

<= 7000 characters

callSummaryDatestring(date-time)read-only

SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.

documentNumberstringread-only

<= 50 characters

callIdstringread-only

<= 50 characters

contractsarray[object]read-only
* Additional properties are NOT allowed.
Show Child Parameters
Example

CallEntryContract

object
* Additional properties are NOT allowed.
contractNumberstringrequired

>= 1 characters<= 50 characters

callTypesarray[string]required

Match pattern:^[\s\S]*$

>= 1 characters<= 50 characters

Example

CallEntryIEnumerablePagedResponse

object
* Additional properties are NOT allowed.
messagestring
itemsarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
offsetinteger(int32)
limitinteger(int32)
firstPagestring(uri)
lastPagestring(uri)
totalPagesinteger(int32)
totalCountinteger(int32)
nextPagestring(uri)
previousPagestring(uri)
Example

CallEntryWriteContractRequest

object
* Additional properties are NOT allowed.
contractNumberstringrequired

Trimmed contract number, unique case-insensitively within the request.

Match pattern:^[\s\S]*$

>= 1 characters<= 50 characters

callTypesarray[string]

Explicit active call-type names, each limited to 50 raw-input characters. Duplicate canonical values within a contract are rejected.

Match pattern:^[\s\S]*$

>= 1 characters<= 50 characters

Example