Client Resource

Clients is a collection which could be a person, organization, agents , case-managers, or underwriters in OIPA. A Client resource is an abstraction of data fields pertaining to client which include fixed fields, dynamic fields and client multi-value fields . OIPA supports end points which will allow filtering, sorting, and projections. Filtering allows selecting a subset of fields. Sorting allows the results in the response to be arranged. Projection allows selecting only certain fields in the response.

Client object represents a single person or business entity/organization in OIPA. This API allows to retrieve, create, update and delete clients in OIPA.

Note: Currently, only retrieving is supported.

  1. Client resource is a collection of data fields also referred as parameters from OIPA tables- AsClient, AsClientField and AsClientMultiValueField.
  2. Client resources are linked to address resource, which is defined as a subresource. Please refer section on addresses subresource.
  3. Client resource is linked to phone which is also defined as a subresource. The join table AsClientPhone is used to create a client's phone.
  4. Client resource is also linked to role and relationship subresources. Subresources roles and Relationships are linked to Group customer and Policy objects in OIPA.
  5. Client collections (arrays of records) will retrieve root object which is Client and its parameters. It will retrieve available links by default, but not addresses and phones.
  6. Client Type Code =99 will be excluded in response as this type belongs to OIPA user.
  7. All collections for any resource in OIPA will not return children collections of referenced items by default . This is done to reduce network traffic and the time it takes to generate a response from the service.

Note: In case a client app/requester need details of child resources, it is recommended to use the expand query string parameter to expand a children collection and include those results.

  1. HATEOAS links will be included in collections to allow API navigation easiness.

Note: Currently, only primary navigation links will be included, i.e for clients , only links to navigate to addresses and phones will be provided, not links to each address and phone records or all query, pagination links.

  1. For all collection responses, a count will be sent as key:value pair. This contains the number of records in response. Maximum being 100 which is the limit set.
  2. Singleton resource calls such as a singular client will return address and phone already expanded by default. This will reduce multiple calls to server.

Client APIs

Subresources of a Client

 

API

 

URI

 

Method

 

Description
  •  
  • GET All Addresses of a Client
    		•

     

    /clients/{id}/addresses

     

    GET

     

    List of all addresses for a given client unique id.

     

    GET Specific Address of a Client

     

    /clients/{id}/addresses/{id}

     

    GET

     

    Unique address for a given client unique id.

     

    GET All Phones of a Client

     

    /clients/{id}/phones

     

    GET

     

    List of all phones for a given client unique id.

     

    GET Specific Phone of a Client

     

    /clients/{id}/phones/{id}

     

    GET

     

    Unique phone for a given client unique id.