Search
K
Orion-API

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

CallEntryWriteRequest

object

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

* Additional properties are NOT allowed.
userNamestring

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[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
callerTypestringrequired

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

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

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

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

>= 1 characters<= 50 characters

priorityinteger(int32)

>= 0<= 255

notesstring

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

>= 1 characters<= 7000 characters

surveystring

Allowed values:Not OfferedTakenNot Taken

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

>= 1 characters<= 10 characters

isExchangeboolean
isSuspendedboolean
isFollowUpCompletedboolean
followUpRequestedDatestring(date-time)
followUpCompletedDatestring(date-time)
suspendedUntilDatestring(date-time)
callTimestring(date-time)
callerNamestringrequired

Required caller identity. Trimmed and limited to 500 characters.

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

>= 1 characters<= 500 characters

phoneFaxNumstring(tel)

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

>= 1 characters<= 20 characters

referencestring

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

>= 1 characters<= 200 characters

isWatchOneboolean
isWatchTwoboolean
transactionTypestring

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

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

>= 1 characters<= 50 characters

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

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

>= 1 characters<= 50 characters

authStatusstring
dobstring(date-time)
ssnstring
callSummarystring

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

>= 1 characters<= 7000 characters

callSummaryDatestring(date-time)
documentNumberstring

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

>= 1 characters<= 50 characters

callIdstring

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

>= 1 characters<= 50 characters

Example

LookupItemResponse

object
* Additional properties are NOT allowed.
idinteger(int32)

Resolved tenant lookup identifier.

valuestring

Canonical lookup name; renaming it is an API compatibility change.

Example