Architecture/SEPA-TIS-Specs.md

@@ -116,6 +116,34 @@ paths:
             schema:
               $ref: '#/components/schemas/NextMessageRequest'
         description: Next message request
+  /processing-result:
+    post:
+      tags:
+        - input
+      summary: Sends message processing result from TIS to DIS
+      operationId: processingResult
+      description: >-
+        Sends message processing result from TIS to DIS.  If the result is
+        COMPLETED, document with given ID and type has status set to PROCESSED,
+        otherwise its status is set to FOR_RESENDING and error count incremented
+        by one. If the error count is greater than 3, the status is set to
+        PROCESSING_FAILED instead to indicate system operator action is
+        required.
+      responses:
+        '200':
+          description: ALways HTTP code 200
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Response'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ProcessingResult'
+        description: >-
+          Result of processing a message previously fetched using next-message
+          endpoint
 servers:
   - url: 'http://localhost:8080/'
   - url: 'https://localhost:8443/'
@@ -286,6 +314,39 @@ components:
             $ref: '#/components/schemas/NextMessageRequestParams'
           minItems: 1
           maxItems: 1
+    ProcessingResult:
+      type: object
+      required:
+        - jsonrpc
+        - id
+        - method
+        - params
+      properties:
+        jsonrpc:
+          type: number
+          format: double
+          enum:
+            - 1
+            - 2
+          description: JSON-RPC standard version number
+          example: 1
+        id:
+          type: integer
+          description: Request ID
+          example: 1
+        method:
+          type: string
+          enum:
+            - nextmsg
+          description: Method name
+          example: prcsres
+        params:
+          type: array
+          description: RequestParameters
+          items:
+            $ref: '#/components/schemas/ProcessingResultParams'
+          minItems: 1
+          maxItems: 1
     PaymentRequestParams:
       type: object
       description: Payment request data
@@ -459,6 +520,33 @@ components:
           type: string
           description: Two character TIS code - all generated IDs start with this
           example: D1
+    ProcessingResultParams:
+      type: object
+      description: Processing result request parameters
+      required:
+        - doc_ref_id
+        - doc_ref_type
+        - processing_result
+      properties:
+        doc_ref_id:
+          type: string
+          description: Reference to the document that caused the error
+          example: D118091001045732
+        doc_ref_type:
+          type: string
+          description: Reference to the document type that caused the error
+          enum:
+            - ffcctrns
+            - ffpcqrst
+            - prtrn
+            - roinvstg
+          example: ffcctrns
+        processing_result:
+          type: string
+          description: Processing result
+          enum:
+            - completed
+            - failed
     DocumentHeader:
       type: object
       description: Document header