Policyholder API¶
Fetch policyholders¶
GET /policyholders
Request:
Name
Position
Type
Required
createdAfterTimestamp
query
integer
optional
createdBeforeTimestamp
query
integer
optional
pageSize
query
integer
optional
pagingToken
query
string
optional
Response:
Policyholder3PageResponse
Fetch a policyholder¶
GET /policyholder/{policyholderLocator}
Request:
Name
Position
Type
Required
policyholderLocator
path
string
required
Response:
PolicyholderResponse3
Create a policyholder¶
POST /policyholder/create
Request:
Name
Position
Type
Required
request
body
required
Response:
PolicyholderResponse3
PolicyholderCreateRequest2¶
{// Optionalcompleted : booleansubEntities : [SubEntityCreateRequest]values : map<string,[string]>}
Update a policyholder¶
POST /policyholder/update
Request:
Name
Position
Type
Required
updateRequest
body
required
Response:
PolicyholderResponse3
Fetch policies for policyholder¶
GET /policyholder/{policyholderLocator}/policies
Request:
Name
Position
Type
Required
policyholderLocator
path
string
required
Response:
[Policy2Response]
Fetch invoices for policyholder¶
GET /policyholder/{policyholderLocator}/invoices
Request:
Name
Position
Type
Required
policyholderLocator
path
string
required
Response:
[PolicyInvoice2Response]
PolicyholderUpdateRequest2¶
{// Requiredcompleted : booleanlocator : stringversion : integer// OptionaladdSubEntities : [SubEntityCreateRequest]deleteSubEntities : [string]updateSubEntities : [SubEntityUpdateRequest]values : map<string,[string]>}
Policyholder3PageResponse¶
{// Requiredpolicyholders : [PolicyholderResponse3]// OptionalpagingToken : string}
PolicyholderResponse3¶
{// RequiredcreatedTimestamp : timestampentity : EntityResponse2locator : stringupdatedTimestamp : timestampversion : integer}
EntityResponse2¶
{// RequiredaccountLocator : stringcompleted : booleancreatedTimestamp : timestamplocator : stringsubEntitiesByLocator : map<string,EntityResponse2>updatedTimestamp : timestampvalues : map<string,[string]>}
SubEntityCreateRequest¶
{// Requiredcompleted : booleanontologyUri : stringvalues : map<string,[string]>// OptionallocalId : string}
SubEntityUpdateRequest¶
{// Requiredcompleted : booleanlocator : stringontologyUri : stringvalues : map<string,[string]>}