Consuming Cloud API
REST API fundamentals in Cloud API
The InsuranceSuite Cloud API
Resources
Endpoints
Requests and responses
Testing requests and responses
Overview of the system APIs in Cloud API
The base configuration system APIs
Viewing API definitions
Beta APIs
Routing related API calls in clustered environments
GETs and response payload structures
Overview of GETs
Standardizing payload structures
Sending GETs
Payload structure for a basic response
Payload structure for a response with included resources
Refining response payloads using query parameters
Overview of query parameters
Specifying the resources and fields to return
Sorting the result set
Controlling pagination
Using query parameters on included resources
POSTs and request payload structures
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
Reducing the number of calls
Composite requests
Constructing composite requests
Administering composite requests
Complete composite request syntax
Request inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
Additional request inclusion behaviors
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
Cloud API headers
HTTP headers
Preventing duplicate database transactions
Warming up an endpoint
Handling a call with unknown elements
Validating response payloads against additional constraints
Globalization
Business flows: FNOL and adjudication
Executing FNOL
Overview of the FNOL process
Overview of the FNOL process in Cloud API
The Test Util API
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
ClaimContacts
Overview of ClaimContacts in ClaimCenter
Overview of ClaimContacts in Cloud API
Modifying ClaimContact roles
Identifying the ClaimContact
ClaimContact role constraints
Incidents
Overview of incidents in ClaimCenter
Overview of incidents in Cloud API
Creating incidents
Summary of incident types
Exposures
Overview of exposures in ClaimCenter
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
Business flows: Financials
Reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Acknowledging reserve transactions
Creating checks
Overview of checks in ClaimCenter
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
DELETEing documents
Notes
Querying for notes
Creating claim notes
Additional notes functionality
Users and groups
Users
Groups
User roles
Authority limit profiles
Configuring Cloud API
Configuring schemas
Overview of resource definition files
Syntax for resource definition files
Data mapping for new properties
Additional behaviors for properties
Collection-level behaviors
Swagger files
Apiconfig files
Tutorial: Extending a data model entity and its API resource
Obfuscating Personally Identifiable Information (PII)
Localizing schemas
Architecture of localized text
Associating display keys with API elements
Localization key prefixes
Display key patterns for schema.json-files
Display key patterns for swagger.yaml files
Providing locale specific content for a given locale
Adding localized text for existing API elements
Adding localized text for new API elements
Adding a new locale
Generating endpoints for custom entities
The REST endpoint generator
Running the REST endpoint generator
Issues to consider before running the generator
Running the REST endpoint generator
The REST endpoint generator prompts
Completing the configuration
Configuring the resource definition files
The resource definition files
Configuring the schema file for generated endpoints
Configuring the mapping file for generated endpoints
Configuring the updater file for generated endpoints
Configuring the swagger file for generated endpoints
Completing the configuration
Configuring glue and impl classes for generated endpoints
The glue and impl classes for generated endpoints
Completing the configuration
Configuring authorization for generated endpoints
Configuring endpoint access for generated endpoints
Configuring resource access for generated endpoints
Configuring generated resource access code
Completing the configuration
Generating endpoints for ClaimCenter Policy graph entities
Creating Policy descendant endpoints
Creating custom risk units
Additional considerations for generated endpoints
Integration graphs
Providing locale specific content for a given locale