Валюти

Список валют

Отримати список валют

GET /api/currencies{?active,order,filters,with,ids_list,offset,limit,unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
active	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
order	string	ні	Список полів сортування через кому без пробілів
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: currenciesExchange,currentCurrencyExchange
offset	number	ні	Повертати дані, починаючи з указаного номера запису
limit	number	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_currency": 1,
    "symbol_currency": "UAH",
    "name_currency": "Гривны",
    "is_default": true,
    "active": true
  }
]

Додати валюту

POST /api/currencies{?active,order,filters,with,ids_list,offset,limit,unprotect_keys}

• Атрибут unprotect_keys=true і значення id_currency у тілі запиту вказувати обов’язково. Значення ключа id_currency автоматично не генерується під час створення запису.

Параметри

Параметр	Тип	Обов’язковий	Опис
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_currency": 1,
  "symbol_currency": "UAH",
  "name_currency": "Гривны",
  "is_default": true,
  "active": true
}

Відповідь 201 (application/json)

{
  "id_currency": 1,
  "symbol_currency": "UAH",
  "name_currency": "Гривны",
  "is_default": true,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_currency": {
      "type": "number"
    },
    "symbol_currency": {
      "type": "string"
    },
    "name_currency": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_currency",
    "symbol_currency",
    "name_currency",
    "is_default",
    "active"
  ]
}

Кількість валют

Отримати кількість валют

GET /api/currencies/count{?filters,ids_list,active}

Параметри

Параметр	Тип	Обов’язковий	Опис
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
active	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Валюта

Отримати дані про валюту

GET /api/currencies/{id_currency}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_currency	number	так	Ідентифікатор валюти
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: currenciesExchange,currentCurrencyExchange

Відповідь 200 (application/json)

{
  "id_currency": 1,
  "symbol_currency": "UAH",
  "name_currency": "Гривны",
  "is_default": true,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_currency": {
      "type": "number"
    },
    "symbol_currency": {
      "type": "string"
    },
    "name_currency": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_currency",
    "symbol_currency",
    "name_currency",
    "is_default",
    "active"
  ]
}

Змінити дані про валюту

PUT /api/currencies/{id_currency}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_currency	number	так	Ідентифікатор валюти
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_currency": 1,
  "symbol_currency": "UAH",
  "name_currency": "Гривны",
  "is_default": true,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_currency": 1,
  "symbol_currency": "UAH",
  "name_currency": "Гривны",
  "is_default": true,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_currency": {
      "type": "number"
    },
    "symbol_currency": {
      "type": "string"
    },
    "name_currency": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_currency",
    "symbol_currency",
    "name_currency",
    "is_default",
    "active"
  ]
}

Деактивувати дані про валюту

DELETE /api/currencies/{id_currency}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_currency	number	так	Ідентифікатор валюти

Відповідь 204