Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
  • Service Layer Architecture
  • Authentication and Authorization
  • OIPA Users and Security Groups
  • Send Requests
  • Use cURL
  • Query Parameters
  • Status Codes
• REST APIs for OIPA SOAP Web Services
  • FileReceived
  • Exposed Computation
  • ProcessPolicy

Tasks

• Calendars
  • Get calendar by calendar code
  • Get list of calendars
• Cases
  • Create Case
  • Get a specific case by Id
  • Get list of cases
  • Get policies for a specific case
  • Update case
• Clients
  • Create client phones
  • Create clients
  • Create clients addresses
  • Get a specific address for a specific client
  • Get a specific client by client Id
  • Get client relationships for a specific client
  • Get list of addresses by client
  • Get list of clients
  • Get phones for a specific client
  • Get roles for a specific client
  • Get specific phone for a specific client
  • Update client
  • Update client address
  • Update client phones
• Codes
  • Get code details for a specific code name
• Companies
  • Get company by Id
  • Get list of companies
  • Get list of plans for a company
  • Get list of products for a company
• Domains
  • Create a domain
  • Delete domain
  • Get a domain of specific ID
  • Get all domains
  • Update domain
• ExposedComputation
  • Process exposed computation
• FileReceived
  • Create FileReceived
• Generic
  • Encrypt the string
• Group Customers
  • Create group customer
  • Get a specific address for a specific group customer
  • Get a specific group customer
  • Get list of addresses by group customer
  • Get list of group customers
  • Update group customer
• Plans
  • Get list of plans
  • Get plan by Id
  • Get plan by Id and plan slice Id
  • Get plan slices by Id
• Policies
  • Create policy
  • Create requirements for a policy
  • Create role
  • Create segments for a policy
  • Get a particular segment for a policy
  • Get a requirement for a policy
  • Get all the roles for a policy
  • Get all the roles for a segment
  • Get impairment for a policy
  • Get impairments for a policy
  • Get list of policies
  • Get list of requirements for a policy
  • Get list of segments for a policy
  • Get policy by Id
  • Get specific role for a policy
  • Update policy
  • Update requirements for a policy
  • Update role
  • Update segments for a policy
• ProcessPolicy
  • Process policy
• Products
  • Get a particular plan for a product
  • Get list of plans for a product
  • Get list of products
  • Get product by Id
• Queries
  • Execute a saved SQL query by query name
  • Post SQL query to OIPA
• Schemas
  • Get a specific entity schema definition
  • Get all entity schema definition links
• Segments
  • Create segment roles
  • Get a specific segment
  • Get all the roles for a segment
  • Update segment roles
• Users
  • Create one or more security groups
  • Create user
  • Delete a specific security group for a user
  • Delete all the Security Groups for a specific user
  • Deletes a specific security group
  • Deletes a specific user
  • Get a specific Security Group
  • Get a specific user
  • Get all Security Groups
  • Get all users
  • Get Security Group(s) for a specific user
  • Get the list of users associated with a Security Group
  • Update information for a specific user