Fenergo Ongoing Screening API

openapi: 3.2.0
info:
  title: Fenergo Ongoing Screening API
  version: '1.0'
  description: 'Operations tagged OngoingScreening across 2 of this provider''s published API definitions: fenergo-dataprotectioncommand-v1-0-openapi.json, fenergo-dataprotectionquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /dataprotectioncommand
- url: /dataprotectionquery
security:
- Bearer: []
tags:
- name: Ongoing Screening
paths:
  /api/ongoingscreening:
    post:
      tags:
      - Ongoing Screening
      summary: Creates a new Ongoing Screening Unsubscribe Batch for an Entity and Journey.
      description: 'Required permissions:

        Following permissions are required: JourneyEdit'
      operationId: CreateUnsubscribeBatch
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateUnsubscribeBatchRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: The request has been accepted and the Ongoing Screening Unsubscribe Batch is being created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsubscribeBatchDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: An unexpected error occurred during the processing of this request
        '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
        '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: /dataprotectioncommand
  /api/ongoingscreening/{id}:
    put:
      tags:
      - Ongoing Screening
      summary: Updates an existing Ongoing Screening Unsubscribe Batch with the relevant Legal…
      description: 'Required permissions:

        Following permissions are required: JourneyEdit'
      operationId: UpdateUnsubscribeBatchEntities
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - 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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateUnsubscribeBatchEntityDtoListServiceRequest'
              description: Service request data
      responses:
        '202':
          description: The request has been accepted and the Ongoing Screening Unsubscribe Batch is being updated
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: An unexpected error occurred during the processing of this request
        '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
        '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: /dataprotectioncommand
  /api/ongoingscreening/{journeyId}/entity/{entityId}:
    get:
      tags:
      - Ongoing Screening
      summary: Returns an existing Ongoing Screening Unsubscribe Batch for a given Journey and…
      description: 'Required permissions:

        At least one of the following permissions is required: JourneyAccess, JourneyEdit'
      operationId: GetUnsubscribeBatchByEntityIdAndJourneyId
      parameters:
      - name: journeyId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: Ongoing Screening Unsubscribe Batch is retrieved given JourneyId and EntityId
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsubscribeBatchDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Ongoing Screening Unsubscribe Batch was not found for given JourneyId and EntityId
                  type: Error
                  errorCode: Error Code
        '500':
          description: An unexpected error occurred during the processing of this request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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
        '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: /dataprotectionquery
components:
  schemas:
    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
    UnsubscribeBatchEntityDto:
      type: object
      properties:
        screeningEntityId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        providerId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
      additionalProperties: false
    UnsubscribeBatchDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type:
          - string
          - 'null'
        entityId:
          type: string
          format: uuid
        journeyId:
          type: string
          format: uuid
        entities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UnsubscribeBatchEntityDto'
      additionalProperties: false
    CreateUnsubscribeBatchRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateUnsubscribeBatchRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    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
    UpdateUnsubscribeBatchEntityDtoListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UpdateUnsubscribeBatchEntityDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    UpdateUnsubscribeBatchEntityDto:
      type: object
      properties:
        screeningEntityId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        providerId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
          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
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    CreateUnsubscribeBatchRequestDto:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        journeyId:
          type: string
          format: uuid
      additionalProperties: false
    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
    UnsubscribeBatchDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UnsubscribeBatchDto'
          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
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    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
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-dataprotectioncommand-v1-0-openapi.json
- fenergo-dataprotectionquery-v1-0-openapi.json