ClaimCenter Cloud API Consumer Guide
Basic REST operations
Introduction to Cloud API
List of APIs in Cloud API
Viewing API definitions
REST API fundamentals
Cloud API calls
Resources
Endpoints
Requests and responses
Testing requests and responses
GETs
Overview of GETs
Standard payload structures
Sending GETs
Payload structure for a basic response
Payload structure for a response with included resources
Query parameters
Overview of query parameters
The fields query parameter
The filter query parameter
The sort query parameter
The pagination query parameters
Query parameters for included resources
Query parameters for POSTs and PATCHes
POSTs
Overview of POSTs
Standardizing payload structures
Designing a request payload
Sending POSTs
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
PATCHes
Overview of PATCHes
The PATCH payload structure
PATCHes and arrays
Sending PATCHes
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
DELETEs and lost updates
Request headers
HTTP headers
Language and locale
Preventing duplicate database transactions
Sticky sessions in clustered environments
Warming up an endpoint
Handling a call with unknown elements
Validating response payloads against additional constraints
Optimizing calls
Reducing the number of calls
Composite requests
Constructing composite requests
Composite request limitations
Administering composite requests
Complete composite request syntax
Request and response inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
PATCHes in request inclusion
Additional behaviors with write inclusion
Additional behaviors with read inclusion
Batch requests
Batch request syntax
Batch request examples
Administering batch requests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Checksums for DELETEs
Asynchronous calls
Overview of asynchronous calls
Sending a request asynchronously
Retrieving the response to the original request
Waiting for a response synchronously
Asynchronous request administration
Business flows: FNOL and adjudication
Executing FNOL
The FNOL process in ClaimCenter
The FNOL process in Cloud API
Creating test policies
POSTing a minimal draft claim
PATCHing a draft claim
POSTing a typical draft claim
Creating claims with unverified policies
Minimum criteria for an unverified policy and claim
Contacts on an unverified policy
Locations on an unverified policy
Risk units on an unverified policy
Coverages on unverified policies
PATCH an unverified policy
Retrieving information about an unverified policy
Submitting a draft claim
Canceling a draft claim
Sample payload addendum
Claims
Querying for claims associated with you
Querying for a claim by claim ID
Searching for active and archived claims
Retrieving policy information
Assigning claims
Validating claims
Retrieving claims from archive
Closing claims
ClaimContacts
Overview of ClaimContacts in Cloud API
ClaimContact roles
Querying for ClaimContacts
Creating new ClaimContacts
Working with contacts from the policy
Copying vendor contacts from ContactManager
Creating ClaimContacts during FNOL
PATCHing ClaimContacts
Assigning roles to existing ClaimContacts
Deleting ClaimContacts
Additional behaviors
Incidents
Overview of incidents in ClaimCenter
Overview of incidents in Cloud API
Fixed property incidents
Managing fixed property incidents
Managing dwelling incidents
Managing other structure incidents
General incidents
Injury incidents
Living expenses incidents
Mobile property incidents
Baggage incidents
Property contents incidents
Vehicle incidents
Trip incidents
Overview of trip incidents
Managing trip incidents
Managing trip accommodations
Managing trip segments
Exposures
Overview of exposures in ClaimCenter
Overview of exposures in Cloud API
Creating exposures
Querying for and modifying exposures
Assigning exposures
Additional exposure endpoints
Service requests
Overview of service requests in ClaimCenter
Overview of service requests in the Cloud API
Querying for service requests
Creating service requests
Modifying existing service requests
Advancing a service request in its lifecycle
Service request quotes
Service request invoices
Matters
Query for matters
Creating matters
PATCHing matters
Assigning matters
Closing and reopening matters
Business flows: Financials
Reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Acknowledging reserve transactions
Creating checks
Querying for check sets and checks
POSTing checks
Recurrences
Deductible handling
PATCHing checks
DELETEing checks
Managing the check life cycle
The check life cycle prior to submission
The check life cycle after submission
Acknowledging payment transactions
Recoveries and recovery reserves
Querying for recoveries and recovery reserves
Creating recoveries and recovery reserves
Creating a recovery reserve
Creating a recovery reserve set
Acknowledging a recovery reserve
Creating a recovery
Multicurrency
Multicurrency overview
Retrieving multicurrency information
POSTing multicurrency information
Business flows: Framework APIs
Activities
Querying for activities
Creating activities
Assigning activities
Closing activities
Additional activity functionality
Documents
Overview of documents
Querying for document information
POSTing documents
PATCHing documents
Sending document metadata only using JSON
DELETEing documents
Notes
Querying for notes
Creating claim notes
Additional notes functionality
Users and groups
Users
Groups
Queues
User roles
Authority limit profiles
Security zones
Querying for security zones
Creating security zones
Modifying and deleting security zones
Associating security zones with other objects
Geographic zones
Typelist metadata
Batch processes
Overview of batch processes
Querying for batch process information
Managing batch processes
Database consistency checks
Overview of database consistency checks (DBCCs)
Running DBCCs
Running a previously run DBCC
Querying for DBCC run information
Business entity schemas
Retrieve an entity schema
Business entity schema query parameters
ETag support
Schema properties
Schema properties overview
Schema properties usage
The Test Util API
Enabling the Test Util API
View the Test Util API in Swagger UI
Test Util API endpoints
Trip incidents