Orion-API
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
LookupItemResponse
object * Additional properties are NOT allowed.
idinteger(int32)required
Resolved tenant lookup identifier.
valuestringrequired
Canonical lookup name; renaming it is an API compatibility change.
>= 1 characters<= 50 characters
Example
LookupResponse
objectTenant-scoped active lookup values using canonical compatibility-stable names.
* Additional properties are NOT allowed.
clientCodestringrequired
Canonical tenant code selected by X-Client-Code.
>= 1 characters
itemsarray[object]required
Active values sorted by name.
* Additional properties are NOT allowed.
Show Child Parameters
Example
Response
object * Additional properties are NOT allowed.
messagestring
Example