Orion-API
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
CallEntryWriteRequest
objectFull-field name-based request shared by POST and PUT. Tenant selection and authorization never use payload userName. String maximum lengths apply to raw input before trimming. Accepted lookup names and identifiers are trimmed; blank optional identifiers and survey values become null. Storage encoding may limit Unicode persistence; character-length bounds do not guarantee Unicode round-tripping.
* Additional properties are NOT allowed.
userNamestring
Conditional interim M2M actor. Raw input is limited to 255 characters even when a token claim supplies the actor. Otherwise trimmed, opaque, and required.
Match pattern:^[\s\S]*$
>= 0 characters<= 255 characters
contractsarray[object]
Optional contracts; missing, null, and empty are equivalent. Trimmed contract numbers joined with commas must total at most 200 characters, including separators. 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:^[\s\S]*$
>= 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:^[\s\S]*$
>= 0 characters<= 50 characters
productTypestring
Optional active product-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
priorityinteger(int32)
>= 0<= 255
notesstring
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
surveystring
Canonical values: Not Offere, Not Taken, Taken. Accepted case-insensitively after trimming; blank input becomes null. Maximum length applies before trimming.
Allowed values:Not OffereTakenNot Taken
Match pattern:^[\s\S]*$
>= 0 characters<= 10 characters
isExchangeboolean
isSuspendedboolean
followUpRequestedDatestring(date-time)
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)
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)
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.
callTimestring(date-time)
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.
callerNamestringrequired
Required nonblank caller identity. Raw input is limited to 500 characters; accepted values are trimmed.
Match pattern:^[\s\S]*$
>= 1 characters<= 500 characters
phoneFaxNumstring(tel)
Match pattern:^[\s\S]*$
>= 0 characters<= 20 characters
referencestring
Match pattern:^[\s\S]*$
>= 0 characters<= 250 characters
isWatchOneboolean
isWatchTwoboolean
transactionTypestring
Optional active transaction-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
isEscalatedboolean
initiatedDatestring(date-time)
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
isWatchThreeboolean
transactionAmountnumber
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
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
authStatusstring
Optional authorization-status value, maximum 5 raw-input characters.
Match pattern:^[\s\S]*$
>= 0 characters<= 5 characters
dobstring(date-time)
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
Optional four-character SSN field. No digits-only restriction is imposed.
Match pattern:^[\s\S]*$
>= 0 characters<= 4 characters
callSummarystring
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
callSummaryDatestring(date-time)
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
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
callIdstring
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Example