feat: Adding observers/loads endpoint
This commit is contained in:
39
v1/README.md
39
v1/README.md
@@ -377,6 +377,8 @@ This endpoint is part of /loads endpoint
|
||||
- shipper_warehouse : id of a company branch
|
||||
- est_loading_date[gte] : Date greater than.
|
||||
- est_loading_date[lte] : Date less than.
|
||||
- est_unloading_date[gte] : Date greater than.
|
||||
- est_unloading_date[lte] : Date less than.
|
||||
- company_name[$regex] : Regex string to find company_name
|
||||
- company_name[$options] : Regex options from MongoDB filter description
|
||||
- $sort[ field ] : -1/1 ; Sort result by field name
|
||||
@@ -485,7 +487,11 @@ __This endpoint is only valid for carriers.__
|
||||
|
||||
## Observers endpoints
|
||||
|
||||
### observers/account/
|
||||
### Public
|
||||
|
||||
The following endpoints doesn't require a JWT authorization
|
||||
|
||||
#### observers/account/
|
||||
|
||||
The full endpoint is `observers/account/`, and serves for the account credentials management, the same way it works for the common users at the endpoint `/public/account`, by the process of creating an OTP when requesting a new user or recovering the account password.
|
||||
|
||||
@@ -496,3 +502,34 @@ The full endpoint is `observers/account/`, and serves for the account credential
|
||||
- `POST /client/recover` or `POST /warehouse/recover`: Requests an OTP recover the account password.
|
||||
- `PATCH /client/recover` or `PATCH /warehouse/recover`: Confirms the new password OTP.
|
||||
|
||||
### Private
|
||||
|
||||
The following endpoints require a JWT authorization
|
||||
|
||||
#### observers/loads/
|
||||
|
||||
##### /find
|
||||
|
||||
- `/warehouse/find`: Warehouse find loads
|
||||
- `/client/find`: Client find loads
|
||||
|
||||
- `GET /warehouse/find` or `GET /client/find` : Find a list of elements with any of the following fields:
|
||||
|
||||
- company: Id of the shipper company
|
||||
- carrier: Id of the carrier company
|
||||
- status: Status of the load
|
||||
- posted_by: Id of the user posting the load
|
||||
- load_status
|
||||
- published_date
|
||||
- loaded_date
|
||||
- transit_date
|
||||
- categories
|
||||
- product
|
||||
- shipment_code: ETA code
|
||||
- origin_warehouse: id of the warehouse
|
||||
- destination_warehouse: id of the warehouse
|
||||
- est_loading_date[gte] : Date greater than.
|
||||
- est_loading_date[lte] : Date less than.
|
||||
- est_unloading_date[gte] : Date greater than.
|
||||
- est_unloading_date[lte] : Date less than.
|
||||
- $sort[ field ] : -1/1 ; Sort result by field name
|
||||
|
||||
Reference in New Issue
Block a user