Skip to content

Commit

Permalink
Merge pull request #2036 from EDI-N/Kolya_ua
Browse files Browse the repository at this point in the history
schedules
  • Loading branch information
EDI-N committed Jan 5, 2024
2 parents d80b9cb + b480533 commit 3164934
Show file tree
Hide file tree
Showing 20 changed files with 610 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/Distribution/EDIN_2_0/API_2_0/Distribution_API_2_0_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,44 @@ API
Methods/PostAccessGroupUsers
Methods/DelAccessGroupUsers

.. schedules::

Робота з Графіком замовлень
============================================================================

+-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Метод** | **URL запиту** | **Опис** |
+===========+=======================================+========================================================================================================================================================================+
| GET | ``/api/distribex/producer/schedules`` | `Отримати список графіків замовлень (Виробник/Продавець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/ProducerSchedulesControllerGet.html>`__ |
+-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| POST | ``/api/distribex/producer/schedules`` | `Створити графік замовлень (Виробник/Продавець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/ProducerSchedulesControllerPost.html>`__ |
+-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| PATCH | ``/api/distribex/producer/schedules`` | `Оновити графік замовлень (Виробник/Продавець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/ProducerSchedulesControllerPatch.html>`__ |
+-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DELETE | ``/api/distribex/producer/schedules`` | `Видалити графік замовлень (Виробник/Продавець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/ProducerSchedulesControllerDelete.html>`__ |
+-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

+-----------+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Метод** | **URL запиту** | **Опис** |
+===========+==========================================+=============================================================================================================================================================================================================================================+
| POST | ``/api/distribex/distributor/schedules`` | `Отримати найбільш актуальні графіки замовлень за списком Виробників/Продавців (Дистриб'ютор/Покупець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/GetDistributorSchedules.html>`__ |
+-----------+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| POST | ``/api/distribex/schedule/dates`` | `Отримати список дат, в які можлива відправка замовлень в конкретному місяці згідно графіку Виробників/Продавців (Дистриб'ютор/Покупець) <https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/API_2_0/Methods/GetDatesyBySchedule.html>`__ |
+-----------+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. beauty list
.. toctree::
:hidden:
:glob:

Methods/ProducerSchedulesControllerGet
Methods/ProducerSchedulesControllerPost
Methods/ProducerSchedulesControllerPatch
Methods/ProducerSchedulesControllerDelete
Methods/GetDistributorSchedules
Methods/GetDatesyBySchedule

---------------------------------

.. _market-errors:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#################################################################################
**Список графіків замовлень за списком Виробників/Продавців (Response)**
#################################################################################

**JSON:**

.. code:: json
{
"13200757":
{
"id": 17,
"producerId": 13200757,
"name": "Test6",
"dateCreated": 1700668481,
"dateChanged": 1700672623,
"dateStart": 1761516000,
"dateEnd": 1768860000,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 1,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 50,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 1761516000
}
}
Таблиця 1 - Опис параметрів об'єкта Schedule

.. csv-table::
:file: for_csv/Schedule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

Таблиця 2 - Опис параметрів об'єкта RecurrenceRule

.. csv-table::
:file: for_csv/RecurrenceRule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

-------------------------

.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
* M (mandatory) — обов'язкові до заповнення поля;
* O (optional) — необов'язкові (опціональні) до заповнення поля.
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
#############################################################
**Список графіків замовлень (Response)**
#############################################################

**JSON:**

.. code:: json
[
{
"id": 9,
"producerId": 13200757,
"name": "Test3",
"dateCreated": 1700659795,
"dateChanged": 1700659795,
"dateStart": 1701381600,
"dateEnd": 1702159200,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "DAILY",
"interval": 1,
"count": 10,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
},
{
"id": 1,
"producerId": 13200757,
"name": "Test2",
"dateCreated": 1700656825,
"dateChanged": 1700658476,
"dateStart": 1704060000,
"dateEnd": 0,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 0,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
}
]
Таблиця 1 - Опис параметрів об'єкта Schedule

.. csv-table::
:file: for_csv/Schedule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

Таблиця 2 - Опис параметрів об'єкта RecurrenceRule

.. csv-table::
:file: for_csv/RecurrenceRule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

-------------------------

.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
* M (mandatory) — обов'язкові до заповнення поля;
* O (optional) — необов'язкові (опціональні) до заповнення поля.
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#############################################################
**Оновлення даних графіка замовлень (Request)**
#############################################################

**JSON:**

.. code:: json
{
"id": 17,
"name": "Test6",
"dateCreated": 0,
"dateChanged": 0,
"dateStart": 1761516000,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 1,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 50,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"distributors":
[
13200791,
13202863
],
"dateClosest": 0
}
Таблиця 1 - Опис параметрів об'єкта Schedule

.. csv-table::
:file: for_csv/Schedule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

Таблиця 2 - Опис параметрів об'єкта RecurrenceRule

.. csv-table::
:file: for_csv/RecurrenceRule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

-------------------------

.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
* M (mandatory) — обов'язкові до заповнення поля;
* O (optional) — необов'язкові (опціональні) до заповнення поля.
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
#############################################################
**Дані графіка замовлень (Request)**
#############################################################

**JSON:**

.. code:: json
{
"name": "Test5",
"dateStart": 1761516000,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 1,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 50,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"distributors":
[
13200791,
13202863
]
}
Таблиця 1 - Опис параметрів об'єкта Schedule

.. csv-table::
:file: for_csv/Schedule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

Таблиця 2 - Опис параметрів об'єкта RecurrenceRule

.. csv-table::
:file: for_csv/RecurrenceRule.csv
:widths: 1, 2, 12, 41
:header-rows: 1
:stub-columns: 0

-------------------------

.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
* M (mandatory) — обов'язкові до заповнення поля;
* O (optional) — необов'язкові (опціональні) до заповнення поля.

0 comments on commit 3164934

Please sign in to comment.