Orion-API
List active transaction types
Returns active canonical tenant transaction types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.
get
https://api.zinnia.io/callcenter/v1/lookups/transaction-types
Headers
X-Client-Codestringrequired
Required company selector containing 3-4 ASCII letters. The caller must have access to the selected company.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Response
Response
OK
LookupResponse
Tenant-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
get/callcenter/v1/lookups/transaction-types
Authentication
Headers
List active product types
Returns active canonical tenant product types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change. Where product activity metadata is unavailable, all product values are returned.
get
https://api.zinnia.io/callcenter/v1/lookups/product-types
Headers
X-Client-Codestringrequired
Required company selector containing 3-4 ASCII letters. The caller must have access to the selected company.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Response
Response
OK
LookupResponse
Tenant-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
get/callcenter/v1/lookups/product-types
Authentication
Headers
Search call entries
Searches call records and returns a paginated collection of complete CallEntry objects. Filters can narrow the results by company, contract, caller, call type, transaction type, or date.
Use X-Client-Code to search within one company. The clientCode query parameter remains available for backward compatibility and takes precedence if both values are supplied. If neither is supplied, Orion searches across every company the caller is authorized to read.
get
https://api.zinnia.io/callcenter/v1/CallEntry
Query Parameters
clientCodestring
Deprecated: use X-Client-Code. 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.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Contractstring
Matches a contract number associated with the call entry. Also searches the entry’s stored contract list and, when that list is absent, its reference value.
Match pattern:^[\s\S]*$
>= 0 characters<= 200 characters
Example:C-10001
CallerTypeIDinteger(int32)
Matches the call entry’s caller-type ID.
CallerTypestring
Matches the call entry’s caller-type name.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Example:Owner
CallerNamestring
Matches the caller name exactly unless usePartialCallerNameMatch is true.
Match pattern:^[\s\S]*$
>= 0 characters<= 500 characters
Example:Jane
UsePartialCallerNameMatchboolean
When true, callerName may occur anywhere within the stored caller name. When false, the names must match exactly. Defaults to false.
CallTypeIDinteger(int32)
Matches a call-type ID assigned directly to the call entry or to one of its contracts.
CallTypestring
Matches a call-type name assigned directly to the call entry or to one of its contracts.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Example:Billing
TransactionTypeIDinteger(int32)
Matches the call entry’s transaction-type ID.
TransactionTypestring
Matches the call entry’s transaction-type name.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Example:Payment
CreatedStartDatestring(date-time)
Includes entries created at or after this date and 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.
CreatedEndDatestring(date-time)
Includes entries created at or before this date and 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.
LastUpdatedStartDatestring(date-time)
Includes entries last updated at or after this date and 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.
LastUpdatedEndDatestring(date-time)
Includes entries last updated at or before this date and 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.
Offsetinteger(int32)
Number of results to skip. Defaults to 0; negative values are treated as 0.
Default:0
>= 0
Example:0
Limitinteger(int32)
Maximum number of results to return. Defaults to 50; values above 500 are limited to 500, and non-positive values use the default.
Default:50
>= 1<= 500
Example:50
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
CallEntryIEnumerablePagedResponse
* Additional properties are NOT allowed.
messagestring | null
itemsarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
offsetinteger(int32)
limitinteger(int32)
firstPagestring | null(uri)
lastPagestring | null(uri)
totalPagesinteger(int32)
totalCountinteger(int32)
nextPagestring | null(uri)
previousPagestring | null(uri)
get/callcenter/v1/CallEntry
Authentication
Query Parameters
Headers
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://api.zinnia.io/callcenter/v1/CallEntry
Headers
X-Client-Codestringrequired
Required company selector containing 3-4 ASCII letters. The caller must have access to the selected company.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
X-Correlation-Idstringrequired
Required nonblank idempotency key, maximum 100 raw-input characters; accepted values are trimmed. Scoped by canonical tenant, operation, and resource identity; clients must generate operation-unique values.
Match pattern:^[\s\S]*$
>= 1 characters<= 100 characters
Example:call-entry-create-123
Body
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. 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 | null
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 | null[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 | 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:^[\s\S]*$
>= 0 characters<= 50 characters
productTypestring | null
Optional active product-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
priorityinteger | null(int32)
>= 0<= 255
notesstring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
surveystring | null
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 | null
isSuspendedboolean | null
followUpRequestedDatestring | null(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 | null(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 | null(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 | null(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 | null(tel)
Match pattern:^[\s\S]*$
>= 0 characters<= 20 characters
referencestring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 250 characters
isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypestring | null
Optional active transaction-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
isEscalatedboolean | null
initiatedDatestring | null(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 | null
isWatchThreeboolean | null
transactionAmountnumber | null
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 | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
authStatusstring | null
Optional authorization-status value, maximum 5 raw-input characters.
Match pattern:^[\s\S]*$
>= 0 characters<= 5 characters
dobstring | null(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 | null
Optional four-character SSN field. No digits-only restriction is imposed.
Match pattern:^[\s\S]*$
>= 0 characters<= 4 characters
callSummarystring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
callSummaryDatestring | null(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 | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
callIdstring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Response
Response
OK. Identical completed create replay; returns the original full CallEntry without processing the creation again.
CallEntry
* Additional properties are NOT allowed.
clientCodestringrequiredread-only
>= 1 characters
callEntryIDinteger(int32)requiredread-only
Server-generated call-entry identity.
callerTypeIDinteger | null(int32)read-only
callerTypestring | nullread-only
<= 50 characters
callTypeIDinteger | null(int32)read-only
callTypestring | nullread-only
<= 50 characters
productTypeIDinteger | null(int32)read-only
productTypestring | nullread-only
<= 50 characters
contractstring | nullread-only
Legacy comma-joined contract-number mirror.
<= 200 characters
priorityinteger | null(int32)read-only
>= 0<= 255
notesstring | nullread-only
<= 7000 characters
surveystring | nullread-only
<= 10 characters
isExchangeboolean | nullread-only
isSuspendedboolean | nullread-only
isFollowUpCompletedboolean | nullread-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 | null(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 | null(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 | null(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 | null(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.
callerNamestring | nullread-only
<= 500 characters
phoneFaxNumstring | nullread-only
<= 20 characters
referencestring | nullread-only
<= 250 characters
isWatchOneboolean | nullread-only
isWatchTwoboolean | nullread-only
transactionTypeIDinteger | null(int32)read-only
transactionTypestring | nullread-only
<= 50 characters
isEscalatedboolean | nullread-only
initiatedDatestring | null(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.
completeInOrionboolean | nullread-only
isWatchThreeboolean | nullread-only
transactionAmountnumber | nullread-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
sessionIDstring | nullread-only
<= 50 characters
authStatusstring | nullread-only
Optional authorization-status value, maximum 5 raw-input characters.
<= 5 characters
dobstring | null(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.
ssnstring | nullread-only
Optional four-character SSN field. No digits-only restriction is imposed.
<= 4 characters
callSummarystring | nullread-only
<= 7000 characters
callSummaryDatestring | null(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.
documentNumberstring | nullread-only
<= 50 characters
callIdstring | nullread-only
<= 50 characters
contractsarray | null[object]read-only
* Additional properties are NOT allowed.
Show Child Parameters
post/callcenter/v1/CallEntry
Authentication
Headers
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://api.zinnia.io/callcenter/v1/CallEntry/{callEntryId}
Path Parameters
callEntryIdinteger(int32)required
Headers
X-Client-Codestringrequired
Required company selector containing 3-4 ASCII letters. The caller must have access to the selected company.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
X-Correlation-Idstringrequired
Required nonblank idempotency key, maximum 100 raw-input characters; accepted values are trimmed. Scoped by canonical tenant, operation, and resource identity; clients must generate operation-unique values.
Match pattern:^[\s\S]*$
>= 1 characters<= 100 characters
Example:call-entry-create-123
Body
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. 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 | null
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 | null[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 | 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:^[\s\S]*$
>= 0 characters<= 50 characters
productTypestring | null
Optional active product-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
priorityinteger | null(int32)
>= 0<= 255
notesstring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
surveystring | null
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 | null
isSuspendedboolean | null
followUpRequestedDatestring | null(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 | null(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 | null(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 | null(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 | null(tel)
Match pattern:^[\s\S]*$
>= 0 characters<= 20 characters
referencestring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 250 characters
isWatchOneboolean | null
isWatchTwoboolean | null
transactionTypestring | null
Optional active transaction-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
isEscalatedboolean | null
initiatedDatestring | null(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 | null
isWatchThreeboolean | null
transactionAmountnumber | null
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 | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
authStatusstring | null
Optional authorization-status value, maximum 5 raw-input characters.
Match pattern:^[\s\S]*$
>= 0 characters<= 5 characters
dobstring | null(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 | null
Optional four-character SSN field. No digits-only restriction is imposed.
Match pattern:^[\s\S]*$
>= 0 characters<= 4 characters
callSummarystring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
callSummaryDatestring | null(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 | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
callIdstring | null
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Response
Response
OK. First full replacement or identical completed replay; a replay does not apply the replacement again.
CallEntry
* Additional properties are NOT allowed.
clientCodestringrequiredread-only
>= 1 characters
callEntryIDinteger(int32)requiredread-only
Server-generated call-entry identity.
callerTypeIDinteger | null(int32)read-only
callerTypestring | nullread-only
<= 50 characters
callTypeIDinteger | null(int32)read-only
callTypestring | nullread-only
<= 50 characters
productTypeIDinteger | null(int32)read-only
productTypestring | nullread-only
<= 50 characters
contractstring | nullread-only
Legacy comma-joined contract-number mirror.
<= 200 characters
priorityinteger | null(int32)read-only
>= 0<= 255
notesstring | nullread-only
<= 7000 characters
surveystring | nullread-only
<= 10 characters
isExchangeboolean | nullread-only
isSuspendedboolean | nullread-only
isFollowUpCompletedboolean | nullread-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 | null(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 | null(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 | null(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 | null(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.
callerNamestring | nullread-only
<= 500 characters
phoneFaxNumstring | nullread-only
<= 20 characters
referencestring | nullread-only
<= 250 characters
isWatchOneboolean | nullread-only
isWatchTwoboolean | nullread-only
transactionTypeIDinteger | null(int32)read-only
transactionTypestring | nullread-only
<= 50 characters
isEscalatedboolean | nullread-only
initiatedDatestring | null(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.
completeInOrionboolean | nullread-only
isWatchThreeboolean | nullread-only
transactionAmountnumber | nullread-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
sessionIDstring | nullread-only
<= 50 characters
authStatusstring | nullread-only
Optional authorization-status value, maximum 5 raw-input characters.
<= 5 characters
dobstring | null(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.
ssnstring | nullread-only
Optional four-character SSN field. No digits-only restriction is imposed.
<= 4 characters
callSummarystring | nullread-only
<= 7000 characters
callSummaryDatestring | null(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.
documentNumberstring | nullread-only
<= 50 characters
callIdstring | nullread-only
<= 50 characters
contractsarray | null[object]read-only
* Additional properties are NOT allowed.
Show Child Parameters
put/callcenter/v1/CallEntry/{callEntryId}
Authentication
Path Parameters
Headers
Body
{
"callerName": "Jane Caller",
"callerType": "Owner",
"callType": "Billing",
"transactionType": "Payment",
"productType": "Annuity",
"contracts": [
{
"contractNumber": "C-10001",
"callTypes": [
"Billing"
]
}
]
}