Query Parameters - Schema

The following table lists the URIs related to schema query parameters, description, and schema design.

Table - Schema Query Parmaters

HTTP Method URI Query Parameter Description Schema Design
GET /schemas Permit All Return all HATEOS schema links GET/schemas
GET /schema/addresses/ companyId, addressType(Mandatory), country(Mandatory) Return JSON schema for a Address resource GET/schema/addresses
GET /schema/cases/ companyId Return JSON schema for a Case resource GET/schema/cases
GET /schema/clients/ companyId, type(Mandatory) Return JSON schema for a Client resource GET/schema/clients
GET /schema/groupCustomers/ companyId, type(Mandatory) Return JSON schema for a Group Customer resource GET/schema/groupCustomers
GET /schema/phones/ N/A Return JSON schema for a Phone resource GET/schema/phones
GET /schema/policies/ planID, issueStateCode, systemCode Return JSON schema for a Policy resource GET/schema/policies
GET /schema/requirements/ planId, companyId, issueStateCode, requirmentName(Mandatory) Return JSON schema for a Requirements resource GET/schema/requirements
GET /schema/roles/ planId, issueStateCode, systemCode, roleCode(Mandatory) Return JSON schema for a Roles resource GET/schema/roles
GET /schema/segmentRoles/ issueStateCode, segmentName(Mandatory), roleCode(Mandatory), systemCode Return JSON schema for a SegmentRoles resource GET/schema/segmentRoles
GET /schema/segments planId(Mandatory), segmentName(Mandatory) Return JSON schema for a Segments resource GET/schema/segments