Отримання інформації про актив

Отримати список всіх активів

GET /assets

Отримати список всіх активів

Приклад запиту:

GET api/0/assets HTTP/1.1
Host: lb.api-sandbox.registry.ea.openprocurement.net

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

200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff

{
  "next_page": {
    "path": "/api/0.1/assets?offset=2017-08-14T13%3A35%3A31.474578%2B03%3A00",
    "uri": "http://lb.api-sandbox.registry.ea.openprocurement.net/api/0.1/assets?offset=2017-08-14T13%3A35%3A31.474578%2B03%3A00",
    "offset": "2017-08-14T13:35:31.474578+03:00"
  },
  "data": [
    {
      "id": "2f684c8a57f447768a5a451e2e8e5892",
      "dateModified": "2017-08-14T13:35:31.474578+03:00"
    },
    {
      "id": "1f28428a37f457768a5a451e2e8e5892",
      "dateModified": "2017-08-15T13:35:31.474578+03:00"
    }
  ]
}
Query Parameters:
 
  • offset – параметр, який ви повинні додати до вихідного запиту, щоб отримати наступну сторінку
  • limit – обмеження кількості активів, що повертаються (дефолтне значення - 100)
Request Headers:
 
  • Authorization – необов’язковий токен OAuth для аутентифікації
Status Codes:

Сортування

Повернені активи просортовані за датою модифікації.

Обмеження кількості активів, що повертаються

Ви можете контролювати кількість data записів потоку даних активів (розмір пакета) за допомогою параметра limit. Якщо він не вказаний, то дані будуть повернені пакетами по 100 елементів.

Пакети

Відповідь містить елемент `next_page`з такими властивостями:

offset:

Це параметр, який ви повинні додати до вихідного запиту, щоб отримати наступну сторінку.
path:

Це частина шляху URL-адреси з вихідними параметрами та доданим/заміненим offset параметром вище.
uri:

Повна версія URL-адреси для наступної сторінки.

Якщо запит наступної сторінки повертається без даних (наприклад, пустий масив), тоді немає сенсу викликати сторінки далі.

Синхронізація

Часто необхідно мати можливість синхронізувати зміни центральної бази даних з іншою базою даних (ми будемо називати її “локальною”). Стандартне сортування “за датою модифікації” разом із механізмом пакетування дозволяє ефективно здійснювати синхронізацію. Процес синхронізації може виконуватись посторінково, поки не буде жодних нових даних, що повертаються. Тоді синхронізатор призупиниться на деякий час, щоб дозволити центральній базі даних зареєструвати деякі зміни і спробувати завантажити наступну сторінку. next_page гарантує, що усі зміни з останнього запиту будуть включені у новий пакет.

Безпечна частота запитів на синхронізацію - раз в 5 хвилин.

Прочитати інформацію про окремі активи

GET /assets/{uuid4:id}

Отримати деталі активу

Приклад запиту:

GET /api/0.1/assets/2f684c8a57f447768a5a451e2e8e5892 HTTP/1.0
Host: lb.api-sandbox.registry.ea.openprocurement.net

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

200 OK
Content-Type: application/json

{
  "data": {
    "status": "pending",
    "assetType": "basic",
    "classification": {
      "scheme": "CAV",
      "description": "Земельні ділянки",
      "id": "39513200-3"
    },
    "title": "Земля для космодрому",
    "assetID": "UA-2017-08-14-000001",
    "value": {
      "currency": "UAH",
      "amount": 100.0,
      "valueAddedTaxIncluded": true
    },
    "dateModified": "2017-08-14T13:35:31.474578+03:00",
    "owner": "broker",
    "assetCustodian": {
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "0440000000"
      },
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "uri": "http://www.dus.gov.ua/"
      },
      "name": "Державне управління справами",
      "address": {
        "postalCode": "01220",
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "region": "м. Київ",
        "locality": "м. Київ"
      }
    },
    "address": {
      "postalCode": "79000",
      "countryName": "Україна",
      "streetAddress": "вул. Банкова 1",
      "region": "м. Київ",
      "locality": "м. Київ"
    },
    "date": "2017-08-14T13:35:31.472331+03:00",
    "id": "2f684c8a57f447768a5a451e2e8e5892",
    "unit": {
      "code": "39513200-3",
      "name": "item"
    },
    "quantity": 5
  }
}
Request Headers:
 
  • Authorization – необов’язковий токен OAuth для аутентифікації
Status Codes: