Search
K
Orion-API

Create a call entry

Creates a call record for the company identified by X-Client-Code and returns the complete created CallEntry. The request must include callerName and a valid active callerType.

callType, transactionType, and productType are matched without regard to letter casing and resolved to the company’s active canonical lookup values.

A call without contracts must provide a top-level callType. When contracts are provided, the top-level callType becomes the default for any contract that does not provide its own callTypes. Contract-specific values override that default. If no top-level callType is supplied, every contract must provide at least one call type.

Orion determines the acting user from the configured token identity claims. If none of these claims is present, Orion uses the trimmed userName from the request body to identify the caller in machine-to-machine scenarios.

X-Correlation-Id makes the request idempotent for at least 24 hours. The first successful request returns 201 Created. A completed identical replay returns the original record with 200 OK and X-Idempotent-Replay: true, without processing the creation again. Reusing the ID for different content or while the original request is still running returns 409 Conflict.

post
https://qa.api.zinnia.io/callcenter/v1/CallEntry

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

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

>= 3 characters<= 4 characters

Example:ABCD

X-Correlation-Idstringrequired

Required trimmed, nonblank idempotency key, maximum 100 characters. Scoped by canonical tenant, operation, and resource identity; clients must generate operation-unique values.

Match pattern:^[A-Za-z0-9._:-]+$

>= 1 characters<= 100 characters

Example:call-entry-create-123

Body

Full-field name-based create payload. Unknown JSON properties retain permissive framework handling. userName is conditionally required only for interim M2M tokens with no configured username claim.

CallEntryWriteRequest

Full-field name-based request shared by POST and PUT. Tenant selection and authorization never use payload userName.

* Additional properties are NOT allowed.
userNamestring | null

Conditional interim M2M actor. Ignored when a configured token username claim exists; otherwise trimmed, opaque, required, and limited to 255 characters.

Match pattern:^[^\u0000-\u001F\u007F]+$

>= 1 characters<= 254 characters

contractsarray | null[object]

Optional contracts; missing, null, and empty are equivalent. Contract and call-type order is non-semantic for idempotency.

* Additional properties are NOT allowed.
Show Child Parameters
callerTypestring | nullrequired

Required active caller-type name, trimmed and matched case-insensitively to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

callTypestring | null

Canonical root call-type name. Required without contracts; otherwise supplies an inheritable default. If absent, every contract must supply at least one call type.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

productTypestring | null

Optional active product-type name resolved to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

priorityinteger | null(int32)

>= 0<= 255

notesstring | null

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 7000 characters

surveystring | null

Allowed values:Not OfferedTakenNot Taken

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 10 characters

isExchangeboolean | null
isSuspendedboolean | null
isFollowUpCompletedboolean | null
followUpRequestedDatestring | null(date-time)
followUpCompletedDatestring | null(date-time)
suspendedUntilDatestring | null(date-time)
callTimestring | null(date-time)
callerNamestring | nullrequired

Required caller identity. Trimmed and limited to 500 characters.

Match pattern:^[A-Za-z ,.'-]+$

>= 1 characters<= 500 characters

phoneFaxNumstring | null(tel)

Match pattern:^\+?[0-9() .-]+$

>= 1 characters<= 20 characters

referencestring | null

Match pattern:^[A-Za-z0-9,-]+$

>= 1 characters<= 200 characters

isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypestring | null

Optional active transaction-type name resolved to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

isEscalatedboolean | null
initiatedDatestring | null(date-time)
completeInOrionboolean | null
isWatchThreeboolean | null
transactionAmountnumber | null(double)
sessionIDstring | null

Match pattern:^[A-Za-z0-9._:-]+$

>= 1 characters<= 50 characters

authStatusstring | null
dobstring | null(date-time)
ssnstring | null
callSummarystring | null

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 7000 characters

callSummaryDatestring | null(date-time)
documentNumberstring | null

Match pattern:^[A-Za-z0-9,-]+$

>= 1 characters<= 50 characters

callIdstring | null

Match pattern:^[A-Za-z0-9._:/-]+$

>= 1 characters<= 50 characters

Response

OK. Identical completed create replay; returns the original full CallEntry without processing the creation again.

CallEntry

* Additional properties are NOT allowed.
clientCodestringrequired

>= 1 characters

callEntryIDinteger(int32)required
callerTypeIDinteger | null(int32)
callerTypestring | null
callTypeIDinteger | null(int32)
callTypestring | null
productTypeIDinteger | null(int32)
productTypestring | null
contractstring | null
priorityinteger | null(int32)
notesstring | null
surveystring | null
isExchangeboolean | null
isSuspendedboolean | null
isFollowUpCompletedboolean | null
followUpRequestedDatestring | null(date-time)
followUpCompletedDatestring | null(date-time)
suspendedUntilDatestring | null(date-time)
createdByUserstringrequired

>= 1 characters

createdDatestring(date-time)required
lastUpdatedDatestring(date-time)required
callTimestring | null(date-time)
callerNamestring | null
phoneFaxNumstring | null
referencestring | null
isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypeIDinteger | null(int32)
transactionTypestring | null
isEscalatedboolean | null
initiatedDatestring | null(date-time)
completeInOrionboolean | null
isWatchThreeboolean | null
transactionAmountnumber | null(double)
sessionIDstring | null
authStatusstring | null
dobstring | null(date-time)
ssnstring | null
callSummarystring | null
callSummaryDatestring | null(date-time)
documentNumberstring | null
callIdstring | null
contractsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
post/callcenter/v1/CallEntry

Body

{ "callerName": "Jane Caller", "callerType": "Owner", "callType": "Billing", "transactionType": "Payment", "productType": "Annuity", "contracts": [ { "contractNumber": "C-10001", "callTypes": [ "Billing" ] } ] }
 

Replace a call entry

Completely replaces the writable contents of an existing call record for the company identified by X-Client-Code. This is a full replacement, not a partial update: omitted nullable fields are cleared, and the submitted contracts replace all stored contract relationships. Orion returns 404 Not Found when the specified record does not exist.

The request must include callerName and a valid active callerType. Lookup values and contract call types follow the same resolution and defaulting rules described for creation.

Orion determines the acting user from the configured token identity claims. If none of these claims is present, Orion uses the trimmed userName from the request body to identify the caller in machine-to-machine scenarios.

X-Correlation-Id makes the replacement idempotent for at least 24 hours. A successful replacement or completed identical replay returns 200 OK; replays also include X-Idempotent-Replay: true and do not apply the replacement again. Reusing the ID for different content or while the original request is still running returns 409 Conflict.

This operation does not support PATCH, ETags, If-Match, or optimistic concurrency.

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

Path Parameters

callEntryIdinteger(int32)required

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

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

>= 3 characters<= 4 characters

Example:ABCD

X-Correlation-Idstringrequired

Required trimmed, nonblank idempotency key, maximum 100 characters. Scoped by canonical tenant, operation, and resource identity; clients must generate operation-unique values.

Match pattern:^[A-Za-z0-9._:-]+$

>= 1 characters<= 100 characters

Example:call-entry-create-123

Body

Full replacement payload. Omitted nullable fields are cleared; contracts replace the stored collection. Unknown JSON properties remain permissive.

CallEntryWriteRequest

Full-field name-based request shared by POST and PUT. Tenant selection and authorization never use payload userName.

* Additional properties are NOT allowed.
userNamestring | null

Conditional interim M2M actor. Ignored when a configured token username claim exists; otherwise trimmed, opaque, required, and limited to 255 characters.

Match pattern:^[^\u0000-\u001F\u007F]+$

>= 1 characters<= 254 characters

contractsarray | null[object]

Optional contracts; missing, null, and empty are equivalent. Contract and call-type order is non-semantic for idempotency.

* Additional properties are NOT allowed.
Show Child Parameters
callerTypestring | nullrequired

Required active caller-type name, trimmed and matched case-insensitively to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

callTypestring | null

Canonical root call-type name. Required without contracts; otherwise supplies an inheritable default. If absent, every contract must supply at least one call type.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

productTypestring | null

Optional active product-type name resolved to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

priorityinteger | null(int32)

>= 0<= 255

notesstring | null

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 7000 characters

surveystring | null

Allowed values:Not OfferedTakenNot Taken

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 10 characters

isExchangeboolean | null
isSuspendedboolean | null
isFollowUpCompletedboolean | null
followUpRequestedDatestring | null(date-time)
followUpCompletedDatestring | null(date-time)
suspendedUntilDatestring | null(date-time)
callTimestring | null(date-time)
callerNamestring | nullrequired

Required caller identity. Trimmed and limited to 500 characters.

Match pattern:^[A-Za-z ,.'-]+$

>= 1 characters<= 500 characters

phoneFaxNumstring | null(tel)

Match pattern:^\+?[0-9() .-]+$

>= 1 characters<= 20 characters

referencestring | null

Match pattern:^[A-Za-z0-9,-]+$

>= 1 characters<= 200 characters

isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypestring | null

Optional active transaction-type name resolved to its canonical tenant value.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

isEscalatedboolean | null
initiatedDatestring | null(date-time)
completeInOrionboolean | null
isWatchThreeboolean | null
transactionAmountnumber | null(double)
sessionIDstring | null

Match pattern:^[A-Za-z0-9._:-]+$

>= 1 characters<= 50 characters

authStatusstring | null
dobstring | null(date-time)
ssnstring | null
callSummarystring | null

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 7000 characters

callSummaryDatestring | null(date-time)
documentNumberstring | null

Match pattern:^[A-Za-z0-9,-]+$

>= 1 characters<= 50 characters

callIdstring | null

Match pattern:^[A-Za-z0-9._:/-]+$

>= 1 characters<= 50 characters

Response

OK. First full replacement or identical completed replay; a replay does not apply the replacement again.

CallEntry

* Additional properties are NOT allowed.
clientCodestringrequired

>= 1 characters

callEntryIDinteger(int32)required
callerTypeIDinteger | null(int32)
callerTypestring | null
callTypeIDinteger | null(int32)
callTypestring | null
productTypeIDinteger | null(int32)
productTypestring | null
contractstring | null
priorityinteger | null(int32)
notesstring | null
surveystring | null
isExchangeboolean | null
isSuspendedboolean | null
isFollowUpCompletedboolean | null
followUpRequestedDatestring | null(date-time)
followUpCompletedDatestring | null(date-time)
suspendedUntilDatestring | null(date-time)
createdByUserstringrequired

>= 1 characters

createdDatestring(date-time)required
lastUpdatedDatestring(date-time)required
callTimestring | null(date-time)
callerNamestring | null
phoneFaxNumstring | null
referencestring | null
isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypeIDinteger | null(int32)
transactionTypestring | null
isEscalatedboolean | null
initiatedDatestring | null(date-time)
completeInOrionboolean | null
isWatchThreeboolean | null
transactionAmountnumber | null(double)
sessionIDstring | null
authStatusstring | null
dobstring | null(date-time)
ssnstring | null
callSummarystring | null
callSummaryDatestring | null(date-time)
documentNumberstring | null
callIdstring | null
contractsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
put/callcenter/v1/CallEntry/{callEntryId}

Body

{ "callerName": "Jane Caller", "callerType": "Owner", "callType": "Billing", "transactionType": "Payment", "productType": "Annuity", "contracts": [ { "contractNumber": "C-10001", "callTypes": [ "Billing" ] } ] }
 

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://qa.api.zinnia.io/callcenter/v1/CallEntry/{callEntryId}

Query Parameters

clientCodestring

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.

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

>= 1 characters

callEntryIDinteger(int32)required
callerTypeIDinteger | null(int32)
callerTypestring | null
callTypeIDinteger | null(int32)
callTypestring | null
productTypeIDinteger | null(int32)
productTypestring | null
contractstring | null
priorityinteger | null(int32)
notesstring | null
surveystring | null
isExchangeboolean | null
isSuspendedboolean | null
isFollowUpCompletedboolean | null
followUpRequestedDatestring | null(date-time)
followUpCompletedDatestring | null(date-time)
suspendedUntilDatestring | null(date-time)
createdByUserstringrequired

>= 1 characters

createdDatestring(date-time)required
lastUpdatedDatestring(date-time)required
callTimestring | null(date-time)
callerNamestring | null
phoneFaxNumstring | null
referencestring | null
isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypeIDinteger | null(int32)
transactionTypestring | null
isEscalatedboolean | null
initiatedDatestring | null(date-time)
completeInOrionboolean | null
isWatchThreeboolean | null
transactionAmountnumber | null(double)
sessionIDstring | null
authStatusstring | null
dobstring | null(date-time)
ssnstring | null
callSummarystring | null
callSummaryDatestring | null(date-time)
documentNumberstring | null
callIdstring | null
contractsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/CallEntry/{callEntryId}
 

CallEntry

object
* Additional properties are NOT allowed.
clientCodestringrequired

>= 1 characters

callEntryIDinteger(int32)required
callerTypeIDinteger(int32)
callerTypestring
callTypeIDinteger(int32)
callTypestring
productTypeIDinteger(int32)
productTypestring
contractstring
priorityinteger(int32)
notesstring
surveystring
isExchangeboolean
isSuspendedboolean
isFollowUpCompletedboolean
followUpRequestedDatestring(date-time)
followUpCompletedDatestring(date-time)
suspendedUntilDatestring(date-time)
createdByUserstringrequired

>= 1 characters

createdDatestring(date-time)required
lastUpdatedDatestring(date-time)required
callTimestring(date-time)
callerNamestring
phoneFaxNumstring
referencestring
isWatchOneboolean
isWatchTwoboolean
transactionTypeIDinteger(int32)
transactionTypestring
isEscalatedboolean
initiatedDatestring(date-time)
completeInOrionboolean
isWatchThreeboolean
transactionAmountnumber(double)
sessionIDstring
authStatusstring
dobstring(date-time)
ssnstring
callSummarystring
callSummaryDatestring(date-time)
documentNumberstring
callIdstring
contractsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example

CallEntryContract

object
* Additional properties are NOT allowed.
contractNumberstringrequired

>= 1 characters

callTypesarray[string]required
Example