openapi: 3.2.0
info:
  title: Fenergo Validation Rule API
  version: '1.0'
  description: 'Operations tagged ValidationRule across 2 of this provider''s published API definitions: fenergo-policyquery-v1-0-openapi.json, fenergo-policyquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policyquery
security:
- Bearer: []
tags:
- name: ValidationRule
paths:
  /api/validation-rule/validation-rules:
    post:
      tags:
      - ValidationRule
      summary: Get validation data by jurisdiction(s)
      description: 'Returns validation data of requirements and data groups by requirement set jurisdiction(s).


        Required permissions:

        Following permissions are required: PolicySearch'
      operationId: GetValidationRules
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Get validation data request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetValidationRulesRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of validation data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationRuleListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policyquery
  /api/v2/validation-rule/validation-rules:
    post:
      tags:
      - ValidationRule
      summary: Get validation data by jurisdiction(s)
      description: 'Returns validation data of requirements and data groups by requirement set jurisdiction(s).


        Required permissions:

        Following permissions are required: PolicySearch'
      operationId: postApiV2ValidationRuleValidationRules
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Get validation data request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetValidationRulesRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of validation data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationRuleListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: GetValidationRules
    servers:
    - url: /policyquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DateLimitRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        minDate:
          type:
          - string
          - 'null'
          format: date-time
        maxDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    ValueLimitRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        minValue:
          type:
          - integer
          - 'null'
          format: int32
        maxValue:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    RegexRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        isCaseSensitive:
          type: boolean
        regexValue:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
        setId:
          type: string
          format: uuid
        propertyId:
          type: string
          format: uuid
        propertyTypeId:
          type:
          - string
          - 'null'
          format: uuid
        linkChildFieldPropertyName:
          type:
          - string
          - 'null'
        linkedParentFieldPropertyName:
          type:
          - string
          - 'null'
        propertyName:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        validationType:
          type:
          - string
          - 'null'
        isDataGroup:
          type: boolean
        dataGroupId:
          type:
          - string
          - 'null'
          format: uuid
        validationData:
          allOf:
          - $ref: '#/components/schemas/ValidationData'
      additionalProperties: false
    ExternalProviderRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        providerId:
          type: string
          format: uuid
      additionalProperties: false
    GetValidationRulesRequestDto:
      required:
      - entityType
      - jurisdictions
      type: object
      properties:
        jurisdictions:
          minItems: 1
          type: array
          items:
            minLength: 1
            type: string
          description: List of jurisdictions e.g. ["Global", "Ireland"]
        entityType:
          minLength: 1
          type: string
          description: The type of the entity (Individual, Company, Other, All)
          example: Individual
        category:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
      additionalProperties: false
      description: Response DTO representing validation request data
    ValidationRuleListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationRule'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    CollectionMaximumCountRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMaximumCount:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    CollectionMinimumCountRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMinimumCount:
          type: integer
          format: int32
      additionalProperties: false
    BasicRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetValidationRulesRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetValidationRulesRequestDto'
          description: Response DTO representing validation request data
      additionalProperties: false
      description: Service request data
    ValidationData:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        specialCharacters:
          allOf:
          - $ref: '#/components/schemas/SpecialCharactersRule'
        noNumbers:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        onlyInteger:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        noNegative:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        onlyDecimal:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        regex:
          allOf:
          - $ref: '#/components/schemas/RegexRule'
        characterLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRule'
        numberLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRule'
        noFutureDates:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        noPastDates:
          allOf:
          - $ref: '#/components/schemas/BasicRule'
        dateLimit:
          allOf:
          - $ref: '#/components/schemas/DateLimitRule'
        multiSelectLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRule'
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRule'
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRule'
        externalProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRule'
        externalDataGroupProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRule'
      additionalProperties: false
    SpecialCharactersRule:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        excludedCharacters:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-policyquery-v1-0-openapi.json
- fenergo-policyquery-v2-0-openapi.json