Spliceforms Codesets API

openapi: 3.2.0
info:
  version: '1.0'
  title: Data Services Codesets API
  summary: ''
  description: List of endpoints to serve the public data that may be needed for application form data capture.
  contact:
    name: akhilesh
    url: https://spliceforms.com/
    email: api@apibanking.com
  license:
    url: https://spliceforms.com/
    name: Commercial
servers:
- url: https://api.stitch.spliceforms.com/data
tags:
- name: codesets
  description: Endpoints to retrieve codesets information
paths:
  /v1/codesets:
    get:
      summary: Fetch Codesets
      operationId: fetchCodesets
      parameters:
      - name: pageNo
        in: query
        description: It specifies the page number of the results to be returned
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 10000
          examples:
          - 1
          default: 1
      - name: pageSize
        in: query
        description: It determines the number of records to be returned per page
        required: true
        schema:
          type: integer
          format: int32
          minimum: 10
          maximum: 100
          examples:
          - 10
          default: 10
      responses:
        '200':
          description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client.
          content:
            application/json:
              schema:
                allOf:
                - x-stoplight:
                    id: slyq7sehukfy6
                  $ref: '#/components/schemas/PaginatedResponse'
                - type: object
                  required:
                  - data
                  properties:
                    data:
                      type: array
                      description: The list of codesets
                      items:
                        $ref: '#/components/schemas/Codeset'
              examples: {}
        '400':
          description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
        '500':
          description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
      x-stoplight:
        id: 5k6wskfqkwz38
      description: Retrieves all available codesets used within the application.
      tags:
      - codesets
  /v1/codesets/{codeset}:
    parameters:
    - schema:
        type: string
        example: Gender
        pattern: ^[a-zA-Z0-9]+$
        minLength: 1
        maxLength: 50
      name: codeset
      in: path
      required: true
      description: The codeset name
    get:
      summary: Fetch Codeset Values
      operationId: get-v1-data-codesets-codes
      parameters:
      - name: codeset
        in: path
        description: 'The name of the codeset '
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9 ]+$
          minLength: 1
          maxLength: 100
          examples:
          - InterestPayment
      responses:
        '200':
          description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    description: The list of codes in an active codeset
                    items:
                      $ref: '#/components/schemas/Code'
              examples: {}
        '400':
          description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
        '500':
          description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
      x-stoplight:
        id: xoq72ejb3y1lq
      description: Retrieves the codes associated with the specified codeset.
      tags:
      - codesets
components:
  schemas:
    Codeset:
      type: object
      x-stoplight:
        id: j6sffy52noqvn
      title: Codeset
      description: It represents a standardized collection of related codes used within the system
      required:
      - name
      - codes
      properties:
        name:
          type: string
          description: The name of the codeset.
          pattern: ^[a-zA-Z0-9]+$
          minLength: 1
          maxLength: 100
          example: interestPaymentFrequency
          x-stoplight:
            id: a7cixbzfr3zl9
        codes:
          type: array
          description: List of codes in a codeset
          uniqueItems: true
          items:
            x-stoplight:
              id: wv6q4syd23oe0
            $ref: '#/components/schemas/Code'
          x-stoplight:
            id: nyhslubm2deqr
    Code:
      type: object
      x-stoplight:
        id: hsqnh5jhmn1wf
      title: Code
      description: Code against active Codeset
      required:
      - code
      - name
      properties:
        code:
          type: string
          description: The code is one of the unique value in a codeset
          pattern: ^[a-zA-Z0-9]+$
          minLength: 1
          maxLength: 100
          examples:
          - R
          x-stoplight:
            id: a50h5rj8ud405
        name:
          type: string
          pattern: ^[a-zA-Z0-9]+$
          minLength: 1
          maxLength: 500
          description: The human-readable name of the code, designed for display in user interfaces or logging purposes.
          example: reinvestment
          x-stoplight:
            id: 85dn7af93nnmr
    PaginatedResponse:
      type: object
      x-stoplight:
        id: cd03j7c25sy2q
      title: PaginatedResponse
      required:
      - totalRecords
      - totalPages
      - pageNo
      - pageSize
      properties:
        totalRecords:
          type: integer
          description: Total number of records available.
          format: int32
          example: 45
          minimum: 1
          maximum: 10000
          x-stoplight:
            id: ng7t6wdgbqolv
        totalPages:
          type: integer
          description: Total number of pages.
          example: 4
          minimum: 1
          maximum: 1000
          format: int32
          x-stoplight:
            id: tnb60gemsmgcg
        pageNo:
          type: integer
          description: Current page number.
          example: 2
          minimum: 1
          maximum: 100
          format: int32
          x-stoplight:
            id: 2lvw64mf3ljcq
        pageSize:
          type: integer
          description: Number of records per page.
          example: 10
          minimum: 1
          maximum: 100
          format: int32
          x-stoplight:
            id: lswzbcgxb87ul
    ValidationError:
      type: object
      x-stoplight:
        id: i03w36ken44hv
      title: ValidationError
      description: Validation Error
      required:
      - message
      - severity
      properties:
        message:
          type: string
          description: Message for the validation error
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 2
          maxLength: 2048
          examples:
          - fields can not be empty
          x-stoplight:
            id: vfc11e0vv4ka0
        fields:
          type: array
          description: One or more properties on which the validation was performed.
          items:
            type: string
            description: Propertie on which the validation was performed.
            pattern: ^[A-Za-z0-9-_]+
            minLength: 2
            maxLength: 50
            examples:
            - '23212322'
            x-stoplight:
              id: 7ezn2bw6cptug
          x-stoplight:
            id: ngstgikrr1jga
        severity:
          type: string
          enum:
          - ERROR
          - WARNING
          description: Severity of the validation error.
          pattern: ^[A-Z]+(_[A-Z]+)*$
          minLength: 2
          maxLength: 50
          examples:
          - ERROR
          x-stoplight:
            id: kcvbyilxmlci5
    ProblemJson:
      type: object
      x-stoplight:
        id: oooamay5pgk0b
      title: ProblemJson
      description: Problem Error Json
      required:
      - title
      - status
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
          pattern: ^[A-Za-z0-9-_]+
          minLength: 2
          maxLength: 50
          examples:
          - Unauthorized
          x-stoplight:
            id: qp048dxgamcyv
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
          minimum: 1
          maximum: 1000
          examples:
          - 200
          x-stoplight:
            id: mppplj2ikgpo5
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 5
          maxLength: 2043
          examples:
          - api_key missing
          x-stoplight:
            id: 05ie4179zj1s5
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
          format: uri
          pattern: ^(https?|http):\/\/[^\s/$.?#].[^\s]*$
          minLength: 5
          maxLength: 2083
          examples:
          - https://example.com/resource
          x-stoplight:
            id: f0d9smdiysl1b
        validationErrors:
          type: array
          description: Validation Errors
          items:
            x-stoplight:
              id: 7vcjnrvdy7wos
            $ref: '#/components/schemas/ValidationError'
          x-stoplight:
            id: uxclbrhmspafm
x-stoplight:
  id: p2yovmp4rufcv
x-internal: true
x-source: https://github.com/spliceforms/stoplight-projects/blob/main/stitch-capture-services/data-services-v1.0.yaml
x-bundled-from: openapi/_original/stitch-capture-services/data-services-v1.0.yaml (./models refs inlined into components/schemas; stoplight:// platform overrides are not resolvable outside Stoplight and are kept as x-unresolved-stoplight-ref)