ETA/ETAApi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Update calendars documentation

Browse Source
This commit is contained in:
Josepablo C.
2024-07-08 21:46:03 -06:00
parent cfa545b91c
commit 718121b3b6
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -375,8 +375,8 @@ This endpoint is part of /loads endpoint
- company_name[$options] : Regex options from MongoDB filter description
- $sort[ field ] : -1/1 ; Sort result by field name
- `GET /calendar` : Find a list of elements with any of the following fields:
- load_status_updated[gte] : Date grater than.
- load_status_updated[lte] : Date less than.
- date[gte] : Date grater than.
- date[lte] : Date less than.
- load_status : string enumerator ['Published', 'Loading', 'Transit', 'Downloading', 'Delivered'].
- $sort[ field ] : -1/1 ; Sort result by field name
- `POST /new` : Creates a new element.
@@ -386,7 +386,7 @@ This endpoint is part of /loads endpoint
##### Example of filter and sort:
- `GET /calendar?$sort[createdAt]=-1&load_status_updated[gte]=2022-08-25&load_status_updated[lte]=2022-05-25&load_status=Loading`: Get loads within date range 2022-08-25 -> 2022-05-25 with load_state "Loading" and sort it by createdAt field.
- `GET /calendar?$sort[createdAt]=-1&date[gte]=2022-08-25&date[lte]=2022-05-25&load_status=Loading`: Get loads within date range 2022-08-25 -> 2022-05-25 with load_state "Loading" and sort it by createdAt field.
- `GET /loads/find?$sort[createdAt]=-1&load_status=Loading`: Get loads with status "Loading" sorted by createdAt.