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}

Create a policyholder

POST /policyholder/create

PolicyholderCreateRequest2

{
  // Optional
  "completed" : boolean
  "subEntities" : [SubEntityCreateRequest]
  "values" : map<string,[string]>
}

Update a policyholder

POST /policyholder/update

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

PolicyholderUpdateRequest2

{
  // Required
  "completed" : boolean
  "locator" : string
  "version" : integer

  // Optional
  "addSubEntities" : [SubEntityCreateRequest]
  "deleteSubEntities" : [string]
  "updateSubEntities" : [SubEntityUpdateRequest]
  "values" : map<string,[string]>
}

Policyholder3PageResponse

{
  // Required
  "policyholders" : [PolicyholderResponse3]

  // Optional
  "pagingToken" : string
}

PolicyholderResponse3

{
  // Required
  "createdTimestamp" : integer
  "entity" : EntityResponse2
  "locator" : string
  "updatedTimestamp" : integer
  "version" : integer
}

EntityResponse2

{
  // Required
  "accountLocator" : string
  "completed" : boolean
  "createdTimestamp" : integer
  "locator" : string
  "subEntitiesByLocator" : map<string,EntityResponse2>
  "updatedTimestamp" : integer
  "values" : map<string,[string]>
}

SubEntityCreateRequest

{
  // Required
  "completed" : boolean
  "ontologyUri" : string
  "values" : map<string,[string]>

  // Optional
  "localId" : string
}

SubEntityUpdateRequest

{
  // Required
  "completed" : boolean
  "locator" : string
  "ontologyUri" : string
  "values" : map<string,[string]>
}