2.1.1 метод получения списка ки: различия между версиями

Материал из База знаний АО АСП
Перейти к навигации Перейти к поиску
Нет описания правки
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
======= Метод получения списка КИ по заданному фильтру с подробной информацией о КИ =======
====== Метод получения списка КИ по заданному фильтру с подробной информацией о КИ ======


Метод возвращает список КИ с подробной информацией, которые доступны в данный момент времени участнику оборота товаров (ИНН определится по токену), согласно заданному фильтру.
Метод возвращает список КИ с подробной информацией, которые доступны в данный момент времени участнику оборота товаров (ИНН определится по токену), согласно заданному фильтру.


<syntaxhighlight lang='bash'>
'''URL:''' /api/v3/facade/identifytools/listV2
'URL:
</syntaxhighlight>' /api/v3/facade/identifytools/listV2


<syntaxhighlight lang='bash'>
'''Метод:''' GET
'Метод:
</syntaxhighlight>' GET


<syntaxhighlight lang='bash'>
'''Пример запроса:'''
'Пример запроса:
</syntaxhighlight>'


<1c>curl -X GET 'https://ismp.crpt.ru/api/v3/facade/identifytools/listV2?<br/>limit=10&order=DESC&orderColumn=emd&<br/>uit=010469022978096621qSF7qjA3aRIqM2406402&<br/>orderedColumnValue=2019-01-23T08:42:17.593Z&pageDir=NEXT' <br/>-H 'Authorization: Bearer <ТОКЕН>'</1c>
<syntaxhighlight lang='1c'>curl -X GET 'https://ismp.crpt.ru/api/v3/facade/identifytools/listV2?<br/>limit=10&order=DESC&orderColumn=emd&<br/>uit=010469022978096621qSF7qjA3aRIqM2406402&<br/>orderedColumnValue=2019-01-23T08:42:17.593Z&pageDir=NEXT' <br/>-H 'Authorization: Bearer <ТОКЕН>'</syntaxhighlight>


Данный запрос вернет 10 (параметр limit) следующих (параметр pageDir) записей, начиная с даты эмиссии 2019-01-23T08:42:17.593Z (параметр orderedColumnValue) и кода маркировки 010469022978096621qSF7qjA3aRIqM2406402 (параметр uit). Сортировка будет производиться по дате эмиссии (параметр orderColumn) и (всегда) по самому коду маркировки
Данный запрос вернет 10 (параметр limit) следующих (параметр pageDir) записей, начиная с даты эмиссии 2019-01-23T08:42:17.593Z (параметр orderedColumnValue) и кода маркировки 010469022978096621qSF7qjA3aRIqM2406402 (параметр uit). Сортировка будет производиться по дате эмиссии (параметр orderColumn) и (всегда) по самому коду маркировки
(вне зависимости от переданных параметров) DESC’ом (параметр order). Значение даты эмиссии и кода маркировки должно быть взято из последней строки (для pageDir NEXT) и из первой для (pageDir PREV) для перемещения между страницами.
(вне зависимости от переданных параметров) DESC’ом (параметр order). Значение даты эмиссии и кода маркировки должно быть взято из последней строки (для pageDir NEXT) и из первой для (pageDir PREV) для перемещения между страницами.


<syntaxhighlight lang='bash'>
'''Параметры заголовка запроса:''' Authorization: Bearer <token>
'Параметры заголовка запроса:
</syntaxhighlight>' Authorization: Bearer <token>


<syntaxhighlight lang='bash'>
'''Параметры запроса:'''
'Параметры запроса:
</syntaxhighlight>'


[[File:4_параметры.png]]
[[File:4_параметры.png]]
Строка 34: Строка 24:
[[File:6_параметры.png]]
[[File:6_параметры.png]]


<syntaxhighlight lang='bash'>
'''Пример ответа:'''
'Пример ответа:
<syntaxhighlight lang='1c'>{
</syntaxhighlight>'
<1c>{
  "results": [
  "results": [
  {
  {
Строка 138: Строка 126:
  }
  }
  ]
  ]
}</1c>
}'''''Параметры ответа:'''
 
<syntaxhighlight lang='bash'>
'Параметры ответа:
</syntaxhighlight>'


[[File:7_параметры.png]]
[[File:7_параметры.png]]
Строка 156: Строка 140:
[[File:12_параметры.png]]
[[File:12_параметры.png]]
[[Category:2.1 общие методы]]
[[Category:2.1 общие методы]]
<vote type=1 />

Текущая версия от 13:13, 2 апреля 2025

Метод получения списка КИ по заданному фильтру с подробной информацией о КИ

Метод возвращает список КИ с подробной информацией, которые доступны в данный момент времени участнику оборота товаров (ИНН определится по токену), согласно заданному фильтру.

URL: /api/v3/facade/identifytools/listV2

Метод: GET

Пример запроса:

curl -X GET 'https://ismp.crpt.ru/api/v3/facade/identifytools/listV2?<br/>limit=10&order=DESC&orderColumn=emd&<br/>uit=010469022978096621qSF7qjA3aRIqM2406402&<br/>orderedColumnValue=2019-01-23T08:42:17.593Z&pageDir=NEXT' <br/>-H 'Authorization: Bearer <ТОКЕН>'

Данный запрос вернет 10 (параметр limit) следующих (параметр pageDir) записей, начиная с даты эмиссии 2019-01-23T08:42:17.593Z (параметр orderedColumnValue) и кода маркировки 010469022978096621qSF7qjA3aRIqM2406402 (параметр uit). Сортировка будет производиться по дате эмиссии (параметр orderColumn) и (всегда) по самому коду маркировки (вне зависимости от переданных параметров) DESC’ом (параметр order). Значение даты эмиссии и кода маркировки должно быть взято из последней строки (для pageDir NEXT) и из первой для (pageDir PREV) для перемещения между страницами.

Параметры заголовка запроса: Authorization: Bearer <token>

Параметры запроса:

Пример ответа: <syntaxhighlight lang='1c'>{

"results": [
{
"agentInn": "string",
"agentName": "string",
"children": [
{
"brand": "string",
"children": [
"string"
],

15

"childrenMap": [
null
],
"cis": "string",
"countChildren": 0,
"emissionDate": "2020

-01 -23T16:17:48Z",

"expireDate": "2020

-01 -23T16:17:48Z",

"exporterName": "string",
"exporterTaxpayerId": "string",
"sgtin": "string",
"introducedDate": "2020

-01 -23T16:17:48Z",

"lastDocId": "string",
"nextCises": [
"string"
],
"ownerInn": "string",
"ownerName": "string",
"packageType": "string",
"parent": "string",
"prVetDocument": "string",
"prevCises": [
"string"
],
"producedDate": "2020

-01 -23T16:17:48Z",

"producerName": "string",
"productName": "string",
"status": "string",
"statusEx": "string"

}

],
"cis": "string",
"countChildren": 0,
"dateChange": "2020

-01 -23T16:17:48Z",

"emissionDate": "2020

-01 -23T16:17:48Z",

"emissionType": "string",
"expireDate": "2020

-01 -23T16:17:48Z",

"exporterName": "string",
"exporterTaxpayerId": "string",
"gtin": "string",
"introducedDate": "2020

-01 -23T16:17:48Z",

"lastDocId": "string",
"nextCises": [
"string"
],
"ownerInn": "string",
"ownerName": "string",
"packType": "string",
"parent": "string",
"participantInn": "string",
"participantName": "string",
"prVetDocument": "string",
"prevCises": [
"string"
],
"producedDate": "2020

-01 -23T16:17:48Z",

"productName": "string",
"receiptDate": "2020

-01 -23T16:17:48Z",

"sgtin": "string",
"status": "string",

16

"statusEx": "string",
"tnVedEaes": "string",
"tnVedEaesGroup": "string",
"uit": "string",
"uitu": "string",
"withdrawReason": "string"
}
]

}Параметры ответа:

Файл:9 параметры.png

0.00
(0 голосов)