Cloud API Consumer Guide
ClaimCenter Cloud API Consumer Guide
Basic REST operations
Introduction to Cloud API
List of APIs in Cloud API
Version numbers for major and minor releases
Viewing API definitions
Swagger UI
View definitions using Swagger UI
Information in Swagger UI
The API definition endpoints and Postman
View definitions using Postman
Information in the output of API definition endpoints
The Guidewire API References site
View definitions using the API References site
Information on the API References site
REST API fundamentals
Cloud API calls
Resources
Endpoints
Root resources
Child resources
Methods
Paths
Requests and responses
Testing requests and responses
Tutorial: Set up your Postman environment
GETs
Overview of GETs
Standard payload structures
Viewing schemas
View a response schema in Swagger UI
Sending GETs
Send a GET using Postman
Tutorial: Send a basic Postman request
Payload structure for a basic response
Structure of a basic response
The count property
The data section
The attributes section
The checksum field
The links subsection (for an element)
The collection-level links section
Payload structure for a response with included resources
Tutorial: Send a Postman request with included resources
Structure of a response with included resources
The related section (for a resource)
The included section (for a response)
Including either a collection or a specific resource
Determining which resources can be included
Query parameters
Overview of query parameters
Viewing query parameter definitions
The fields query parameter
Tutorial: Send a GET with the fields parameter
The filter query parameter
Endpoints with default filters
The assignedUser filters
Tutorial: Send a GET with the filter parameters
The sort query parameter
Tutorial: Send a GET with the sort query parameter
The pagination query parameters
pageSize limits the number of resources per page
The self link returns a single resource in a page
pageOffset pages through resources
includeTotal retrieves the total number of resources
Tutorial: Send a GET with the pageSize and totalCount parameters
Query parameters for included resources
Syntax for query parameters for included resources
Summary of query parameters for included resources
Specifying query parameters at different levels
Tutorial: Send a GET with query parameters for included resources
Query parameters for POSTs and PATCHes
POSTs
Overview of POSTs
Standardizing payload structures
Viewing request schemas
View a request schema in Swagger UI
Designing a request payload
Request payload structure
Determining the minimum creation criteria
Specifying scalar values
Specifying compound values
Setting values and objects to null
Sending POSTs
Send a POST using Postman
Tutorial: Create a new note that specifies required fields only
Tutorial: Create a new note that specifies optional fields
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
PATCHes
Overview of PATCHes
The PATCH payload structure
Designing a request payload
PATCHes and arrays
Sending PATCHes
Send a PATCH using Postman
Tutorial: PATCH an activity
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
Tutorial: DELETE a note
DELETEs and lost updates
Request headers
HTTP headers
Overview of Cloud API headers
Send a request with a Cloud API header using Postman
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
Features that execute multiple requests at once
Comparing features that execute multiple requests
Determining which feature to use
Composite requests
Constructing composite requests
The requests section
Using variables to share information across subrequests
Responses to the subrequests
The selections section
Composite request examples
Composite request limitations
Administering composite requests
Error handling
Logging
Configuring the maximum number of subrequests
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
Optional subrequest attributes
Batch request examples
Simple batch requests
Batch requests with query parameters
Batch requests with request payloads
Batch requests with distinct operations
Administering batch requests
Specifying subrequest headers
Specifying onFail behavior
Configuring the maximum number of subrequests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Tutorial: PATCH an activity using checksums
Tutorial: Assign an activity using checksums
Checksums for DELETEs
Send a checksum in a request header using Postman
Tutorial: DELETE a note using checksums
Asynchronous calls
Overview of asynchronous calls
Determining when the call has been processed
Retrieving the response using /requests/{asyncRequestId}
Retrieving the response from /requests/{asyncRequestId}/response
Sending a request asynchronously
Tutorial: Send a request asynchronously
Retrieving the response to the original request
Response information in the /requests response
Response information using the /response endpoint
Tutorial: Retrieve information about an asynchronous request
Waiting for a response synchronously
Tutorial: Send a request asynchronously with a wait time
Asynchronous request administration
Business flows: FNOL and adjudication
Executing FNOL
The FNOL process in ClaimCenter
Draft claims and open claims
Verified and unverified policies
Claim validation at FNOL
The FNOL process in Cloud API
The Cloud API FNOL process
FNOL use cases by policy state
Claim validation at FNOL
Composite request limitations with claims
Canceling claims
Claim modes
Creating test policies
Creating test policy data
Tutorial: Creating a policy using the Test Util API
Creating test data for related objects
POSTing a minimal draft claim
Tutorial: POSTing a minimal draft claim for personal auto
PATCHing a draft claim
Tutorial: PATCHing a draft claim for personal auto
POSTing a typical draft claim
Tutorial: POSTing a typical draft claim for personal auto
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
Minimum criteria for submitting a claim with an unverified policy
Tutorial: Submitting a draft claim
Canceling a draft claim
Sample payload addendum
Sample policy payload
Sample draft claim payload
Sample composite claim payload
Sample composite first-and-final
Claims
Querying for claims associated with you
Querying for a claim by claim ID
Searching for active and archived claims
Request payload for a claim search
Response payload for a claim search
Retrieving policy information
Summary of the policy endpoints
Assigning claims
Validating claims
ClaimCenter validation levels
Validating a claim through Cloud API
Retrieving claims from archive
Closing claims
ClaimContacts
Overview of ClaimContacts in Cloud API
ClaimContact roles
Querying for ClaimContacts
Creating new ClaimContacts
Creating a new ClaimContact with a reserved role
Creating a new ClaimContact with a non-reserved role
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
Masking the taxID field
Role constraint endpoints
Role owners endpoint
Specifying pronouns for contacts
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
Medical diagnoses
Bodily injury points
Living expenses incidents
Mobile property incidents
Baggage incidents
Property contents incidents
Vehicle incidents
Vehicle damage points
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
Minimum creation criteria
Building an exposure payload
Step 1: Identify the coverage type
Step 2: Identify the coverage subtype
Step 3: Create or identify the claimant
Step 4: Create or identify the incident
Step 5: Identify the coverage
Querying for and modifying exposures
Assigning exposures
Deductibles
Additional exposure endpoints
Deleting draft exposures
Validating exposures
Closing exposures
Service requests
Overview of service requests in ClaimCenter
Service request kinds
The service request lifecycle
Invoices for service request
Overview of service requests in the Cloud API
Service request APIs and vendor portals
Required service request data model
Service request numbers
Support for each service request kind
Composite request limitations with service requests
Querying for service requests
Creating service requests
Minimum creation criteria
Modifying existing service requests
PATCHing service requests
Assigning service requests to users
Advancing a service request in its lifecycle
Submitting, accepting, and declining service requests
Completing and canceling service requests
Service request quotes
Service request invoices
Querying for invoices
Creating invoices for service requests
Approving service request invoices
Marking invoices as paid
Withdrawing service request invoices
Matters
Query for matters
Creating matters
PATCHing matters
Assigning matters
Assignment options
Assignment examples
Closing and reopening matters
Workers' compensation claims
Workers' comp claims in ClaimCenter
Creating basic workers' comp claims
Creating lost wages workers' comp claims
Creating employer liability workers' comp claims
Typical basic workers' comp claim: Example
Managing ICD codes
Configuring Cloud API behavior with workers' comp claims
Business flows: Financials
Reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Example of creating reserves
Example of adding to reserves
Acknowledging reserve transactions
Creating checks
Querying for check sets and checks
POSTing checks
Check creation in ClaimCenter
Check creation through Cloud API
Example of creating a minimal check set
Recurrences
Recurrences in ClaimCenter
Recurrences in Cloud API
Sending checks every X months on the Nth day
Sending checks every X months on the Nth dayOfWeek
Sending checks every X weeks on dayOfWeek
Deductible handling
Deductible handling in ClaimCenter
Deductible handling in Cloud API
Underpaying and overpaying deductibles
PATCHing checks
DELETEing checks
Managing the check life cycle
The check life cycle prior to submission
Advancing a check to submission through Cloud API
The check life cycle after submission
Advancing a check beyond submission through Cloud API
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
Financial calculations
Retrieving the available financial calculations
Retrieving financial calculations
Calculations that include all relevant transactions
Calculations that filter transactions
Filtering transaction examples
Restricting access to financial calculation expressions
Multicurrency
Multicurrency overview
Multicurrency in ClaimCenter
Multicurrency in Cloud API
Retrieving multicurrency information
Multicurrency reserves
Multicurrency checks
Exchange rate information for transactions
POSTing multicurrency information
POSTing a reserve with multiple currencies
POSTing a reserve with a custom exchange rate
POSTing a check set with multiple currencies
POSTing a check set with a custom exchange rate
Specifying multicurrency line items
Additional exchange rate schema fields
Business flows: Framework APIs
Activities
Querying for activities
Creating activities
Assigning activities
Assignment options
Assignment examples
Retrieving recommended assignees
Closing activities
Additional activity functionality
Documents
Overview of documents
Querying for document information
Querying for document metadata
Querying for document content
POSTing documents
POSTing documents using Postman
PATCHing documents
Sending document metadata only using JSON
DELETEing documents
Notes
Querying for notes
Creating claim notes
Additional notes functionality
Users and groups
Users
Querying for user information
Creating users
Updating users
Deleting users
Groups
Querying for groups
Creating groups
Assigning users to groups
Updating groups
Deleting groups
Queues
Working with queues
User roles
Querying for user roles
Creating user roles
Updating user roles
Authority limit profiles
Retrieving information about authority limit profiles
Creating authority limit profiles
Adding limits to the profile
Updating 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
History events
Typelist metadata
The /typelists endpoints
Querying with typekey filters
The /business-line-metadata endpoint
Tutorial: Query for typelist metadata
Batch processes
Overview of batch processes
Querying for batch process information
Getting information about batch process history
Managing batch processes
Starting a batch process
Starting a batch process with arguments
Stopping a batch process
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 a business 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