Zywave Insured Payment Schedules API

openapi: 3.2.0
info:
  title: Policies Insured Payment Schedules API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.policies
  - api.policies:read
tags:
- name: InsuredPaymentSchedules
paths:
  /policies/v2.0/insuredpaymentschedules/{id}:
    get:
      tags:
      - InsuredPaymentSchedules
      summary: Gets an insured payment schedule by id
      operationId: InsuredPaymentSchedules_GetInsuredPaymentSchedule
      parameters:
      - name: id
        in: path
        required: true
        description: The insured payment schedule id.
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsuredPaymentSchedule'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - oidc:
        - api.policies:read
  /policies/v2.0/insuredpaymentschedules:
    get:
      tags:
      - InsuredPaymentSchedules
      summary: Search for an insured payment schedule
      description: 'The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable.

        The following properties can be used when filtering and ordering the response.

        * Id

        * Description

        * PaymentsPerYear

        * IsArchived


        See the Zywave API search documentation for more details about using OData search.'
      operationId: InsuredPaymentSchedules_SearchInsuredPaymentSchedules
      parameters:
      - name: $filter
        x-originalName: filter
        in: query
        description: The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above.
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: $orderBy
        x-originalName: orderBy
        in: query
        description: Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: $skip
        x-originalName: skip
        in: query
        description: The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top.
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 3
      - name: $top
        x-originalName: top
        in: query
        description: The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top.
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 4
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfInsuredPaymentSchedule'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - oidc:
        - api.policies:read
components:
  schemas:
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    InsuredPaymentSchedule:
      allOf:
      - $ref: '#/components/schemas/InsuredPaymentScheduleInfo'
      - type: object
        additionalProperties: false
        properties:
          id:
            type: integer
            description: The unique Zywave identifier for the insured payment schedule.
            format: int32
    PagedResultOfInsuredPaymentSchedule:
      type: object
      additionalProperties: false
      properties:
        hasMoreResults:
          type: boolean
        pageIndex:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        skip:
          type: integer
          format: int32
        take:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/InsuredPaymentSchedule'
    InsuredPaymentScheduleInfo:
      type: object
      additionalProperties: false
      required:
      - description
      - paymentsPerYear
      properties:
        description:
          type: string
          description: The description of the insured payment schedule
          maxLength: 50
          minLength: 1
        paymentsPerYear:
          type: integer
          description: The amount of payments per year
          format: int32
          maximum: 2147483647.0
          minimum: 0.0
        isArchived:
          type: boolean
          description: Indicates whether the insured payment schedule is archived.
    ValidationProblemDetails:
      allOf:
      - $ref: '#/components/schemas/HttpValidationProblemDetails'
      - type: object
        additionalProperties: {}
        properties:
          errors:
            type: object
            additionalProperties:
              type: array
              items:
                type: string
    HttpValidationProblemDetails:
      allOf:
      - $ref: '#/components/schemas/ProblemDetails'
      - type: object
        additionalProperties: {}
        properties:
          errors:
            type: object
            additionalProperties:
              type: array
              items:
                type: string
  securitySchemes:
    oidc:
      type: openIdConnect
      openIdConnectUrl: https://auth.zywave.com/.well-known/openid-configuration
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))