Skip to main content

Отримати протокол сканування за protocolId GET /api/des-pscan/protocols/{protocolId}

REQUEST

URL

https://des-pscan.stage.akcyz.edin.ua/

Метод запиту

GET 

URL запиту

/api/des-pscan/protocols/{protocolId}

PATH параметри

protocolId (string) обов'язково - ідентифікатор протокола

URL параметри

tenant (string) обов'язково - Tenant ідентифікатор

Headers

 

Authorization

Bearer

Content-Type

application/json

RESPONSE
  • Статус 200.

Об'єкт ScanningProtocolResponse

JSON приклад відповіді
{
  "protocolId": "string",
  "protocolType": "string",
  "operationType": "string",
  "protocolStatus": "string",
  "ugiCode": "string",
  "protocolCreatedBy": "string",
  "protocolCreatedAt": "2026-11-16T10:24:53.992Z",
  "protocolUpdatedBy": "string",
  "protocolUpdatedAt": "2026-11-16T10:24:53.992Z",
  "protocolClosedBy": "string",
  "protocolClosedAt": "2026-11-16T10:24:53.992Z",
  "senderEconomicOperatorCode": "string",
  "senderEconomicOperatorObjectCode": "string",
  "senderBusinessUnitId": "string",
  "receiverEconomicOperatorCode": "string",
  "receiverEconomicOperatorObjectCode": "string",
  "receiverBusinessUnitId": "string",
  "operatorObjectCode": "string",
  "businessUnitId": "string",
  "operationDocuments": [
    {
      "relations": {
        "additionalProp1": [
          "string"
        ],
        "additionalProp2": [
          "string"
        ],
        "additionalProp3": [
          "string"
        ]
      },
      "operationDocumentType": "string",
      "operationDocumentId": "string",
      "items": [
        {
          "articleId": "string",
          "quantity": 0
        }
      ]
    }
  ],
  "items": [
    {
      "itemId": "string",
      "scannedBy": "string",
      "scannedAt": "2026-11-16T10:24:53.992Z",
      "exciseCode": "string",
      "barcode": "string",
      "ssccCode": "string",
      "readableCode": "string",
      "legacyExciseCode": "string",
      "quantity": 0,
      "itemSource": "string",
      "itemType": "string",
      "articleId": "string",
      "validationStatus": "string",
      "validationMessage": "string",
      "documentId": "string",
      "validations": {
        "additionalProp1": {
          "options": {
            "propertyNameCaseInsensitive": true
          },
          "parent": "string",
          "root": "string"
        },
        "additionalProp2": {
          "options": {
            "propertyNameCaseInsensitive": true
          },
          "parent": "string",
          "root": "string"
        },
        "additionalProp3": {
          "options": {
            "propertyNameCaseInsensitive": true
          },
          "parent": "string",
          "root": "string"
        }
      }
    }
  ],
  "docs": [
    {
      "documentId": "string",
      "desState": "string",
      "validationResult": "string"
    }
  ],
  "emValidation": {
    "errors": [
      {
        "ruleId": "string",
        "message": "string",
        "params": [
          "string"
        ],
        "token": "string",
        "propertyNames": [
          "string"
        ],
        "type": "Business",
        "details": "string",
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ],
    "warnings": [
      {
        "ruleId": "string",
        "message": "string",
        "params": [
          "string"
        ],
        "token": "string",
        "propertyNames": [
          "string"
        ],
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ],
    "decision": "Valid"
  },
  "generalValidation": {
    "errors": [
      {
        "ruleId": "string",
        "message": "string",
        "params": [
          "string"
        ],
        "token": "string",
        "propertyNames": [
          "string"
        ],
        "type": "Business",
        "details": "string",
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ],
    "warnings": [
      {
        "ruleId": "string",
        "message": "string",
        "params": [
          "string"
        ],
        "token": "string",
        "propertyNames": [
          "string"
        ],
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ],
    "decision": "Valid"
  }
}
  •  Статус 400 - Not Found