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
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
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
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}
Authentication
Path Parameters
Query Parameters
Headers
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
CallEntryIEnumerablePagedResponse
object * Additional properties are NOT allowed.
messagestring
itemsarray[object]
* 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:^[A-Za-z0-9,-]+$
>= 1 characters<= 50 characters
callTypesarray[string]
Explicit active call-type names. Duplicate canonical values within a contract are rejected.
Match pattern:^[A-Za-z0-9 &'/-]+$
>= 1 characters<= 50 characters
Example