Skip to main content

Знайти протоколи за зв'язком операційного документа GET /api/des-scan/protocols/lookup

Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.

REQUEST

URL

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

Метод запиту

GET 

URL запиту

/api/des-scan/protocols/lookup

URL параметри

tenant (string) обов'язково - Tenant ідентифікатор, чиї протоколи потрібно знайти

relationType (string) обов'язково - зв'язок для пошуку. Enum:
  • "order"
  • "operation-document"

relatedCode (string) обов'язково - non-empty

Точний ідентифікатор, чутливий до регістру, в межах tenant. Max 255 символів лише для relationType=order; без обмежень за довжиною для relationType=operation-document.

 

Headers

 

Authorization

Bearer

Content-Type

application/json

RESPONSE
  • Статус 200.

Масив з даними:

protocolId
string or null
protocolType
string or null
protocolStatus
string or null
operationDocuments
Array of objects or null (ProtocolLookupOperationDocument)
  •  Статус 400 - Bad request

Масив з даними:

type
string or null
title
string or null
status
integer or null <int32>
detail
string or null
instance
string or null
property name*
additional property
any

JSON приклад відповіді:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}