OVPAY-2473 - Added endpoint for POSTing missing tap.

src/openapi/customers/customers-trips.yaml

@@ -322,6 +322,104 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/500Response'
+  /customers/id-media/missing-taps:
+    post:
+      tags:
+        - Trips
+      summary: 8255 - Manual Check-in or Check-out
+      description: >-
+        Creates manual Check-in or Check-out for transactions that are missing
+        their pair. Check-in or Check-out directions are defined using
+        **entryExitType** parameter in body respectivelly
+      operationId: API-8255v3_manualCheckInOrCheckOut
+      parameters:
+        - name: X-HTM-JWT-AUTH-HEADER
+          in: header
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ManualTap'
+        required: true
+      responses:
+        '200':
+          description: Operation successful
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericOkResponse'
+              example:
+                referenceId: BSS-1627294719604
+                numberOfRemainingAttempts: 0
+                timeOfNextAllowedAttempt: '2022-03-19T17:07:31Z'
+        '400':
+          description: |-
+            Bad request        
+            List of possible error codes:
+             
+               * 402 - Unable to store message 
+               * 403 - Unable to send message to NotificationProcessor 
+               * 404 - Unable to parse message 
+               * 405 - Unable to validate message 
+               * 406 - Missing mandatory headers 
+               * 407 - Counter Transaction not found 
+               * 408 - Manual taps limit exceeded 
+               * 409 - Unable to send message to Orchestrator 
+               * 410 - Unable to construct message 
+               * 411 - Unable to get data 
+               * 412 - Unable to get bin 
+               * 422 - Duplicate manual tap 
+             
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+              example:
+                errorMessage:
+                  message: >-
+                    Maximum limit 5 of manual taps reached for beId = 7 and role
+                    = PTO within a period of 2592000 seconds for this token
+                  referenceId: BSS-1627294719604
+                businessExceptions:
+                  - code: '408'
+                    message: Manual taps limit exceeded
+                  - code: BSS-timeOfNextAllowedAttempt
+                    message: '2022-03-19T17:07:31Z'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+              example:
+                errorMessage:
+                  message: The server responded with http status code 500
+                  referenceId: BSS-1627294719604
+                businessExceptions:
+                  - code: '5026'
+                    message: Unable to send request to Orchestrator
+        '503':
+          description: Service Unavailable
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/503Response'
+              example:
+                errorMessage:
+                  message: The server responded with http status code 503
+                  referenceId: BSS-1627294719604
+                businessExceptions:
+                  - code: '5026'
+                    message: Unable to send request to Orchestrator
+      x-codegen-request-body-name: ManualTap
+      security:
+        - OAuthAuthorization:
+            - default
 components:
   schemas:
     getTokenTrips:
@@ -803,6 +901,65 @@ components:
           description: >-
             AN altitude IS A number THAT represents the height of an object or
             point in relation to sea level or ground level
+    ManualTap:
+      required:
+        - xbot
+        - counterpartTransactionId
+        - deviceClassId
+        - deviceId
+        - stopId
+      type: object
+      properties:
+        counterpartTransactionId:
+          type: string
+          description: Id of the transaction that is missing its pair
+          example: '1236589547'
+        xbot:
+          type: string
+          description: Token identification code (external backoffice token)
+          example: '12272277752953521453'
+        stopId:
+          type: string
+          description: Id of the location of the tap
+          example: '123'
+        deviceId:
+          type: string
+          description: Id of the device
+          example: '5415236'
+        deviceClassId:
+          type: string
+          description: Class Id of the device
+          example: '54'
+        transactionTimestamp:
+          type: string
+          description: Timestamp of the transaction
+          format: date-time
+          example: '2019-11-25T17:39:45.000Z'
+        entryExitType:
+          type: string
+          description: 'Direction of the tap: in or out'
+          example: ENTRY
+          enum:
+            - UNKNOWN
+            - ENTRY
+            - EXIT
+      description: JSON schema for ManualTap message
+    GenericOkResponse:
+      required:
+        - referenceId
+      description: Ok response object
+      type: object
+      properties:
+        referenceId:
+          type: string
+          description: Reference identification code
+        numberOfRemainingAttempts:
+          type: integer
+          description: Number of remaining attempts
+        timeOfNextAllowedAttempt:
+          type: string
+          format: date-time
+          description: Time when next attempt is allowed
     400Response:
       type: object
       properties:
@@ -877,5 +1034,18 @@ components:
         message:
           type: string
           example: Internal Server Error
+        description:
+          type: string
+    503Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '503'
+        type:
+          type: string
+        message:
+          type: string
+          example: Service Unavailable
         description:
           type: string