Zywave Policy Statuses API

openapi: 3.2.0
info:
  title: Policies Policy Statuses API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.policies
  - api.policies:read
tags:
- name: PolicyStatuses
paths:
  /policies/v2.0/policystatuses/{id}:
    get:
      tags:
      - PolicyStatuses
      summary: Gets a policy status by id
      operationId: PolicyStatuses_GetPolicyStatus
      parameters:
      - name: id
        in: path
        required: true
        description: The policy status id.
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyStatus'
        '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/policystatuses:
    get:
      tags:
      - PolicyStatuses
      summary: Search for policy status
      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

        * BasePolicyStatus

        * PolicyStatusType

        * IsArchived


        See the Zywave API search documentation for more details about using OData search.'
      operationId: PolicyStatuses_SearchPolicyStatuses
      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/PagedResultOfPolicyStatus'
        '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'
    PolicyStatusInfo:
      type: object
      additionalProperties: false
      required:
      - description
      - basePolicyStatus
      - policyStatusType
      properties:
        description:
          type: string
          description: The description of the policy status.
          maxLength: 50
          minLength: 1
        basePolicyStatus:
          description: 'The base policy status that this policy status derives from.

            Ex. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier'
          oneOf:
          - $ref: '#/components/schemas/BasePolicyStatusOption'
        policyStatusType:
          description: 'The type of policy status.

            Ex. Beginning, Ending'
          oneOf:
          - $ref: '#/components/schemas/PolicyStatusTypeOption'
        isArchived:
          type: boolean
          description: Indicates whether the policy status is archived.
    PolicyStatusTypeOption:
      type: string
      description: ''
      x-enumNames:
      - Beginning
      - Ending
      enum:
      - Beginning
      - Ending
    PolicyStatus:
      allOf:
      - $ref: '#/components/schemas/PolicyStatusInfo'
      - type: object
        additionalProperties: false
        properties:
          id:
            type: integer
            description: The unique Zywave identifier for the policy status.
            format: int32
    PagedResultOfPolicyStatus:
      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/PolicyStatus'
    BasePolicyStatusOption:
      type: string
      description: ''
      x-enumNames:
      - New
      - Retained
      - Lost
      enum:
      - New
      - Retained
      - Lost
    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))