From 1521ea4b775eac195c534f7949742c27ab95403c Mon Sep 17 00:00:00 2001 From: "Josepablo C." Date: Wed, 8 Nov 2023 01:09:04 -0600 Subject: [PATCH] EN-64: Adding public endpoints description --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e8add8..378d147 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,10 @@ Read registered resources: - `GET /meta-data`: List registered meta-data. - `GET /meta-groups`: List registered meta-data. - `GET /product-categories`: List registered product-categories. + - `GET /public-companies`: List registered companies. + - `GET /public-loads`: List registered loads. - `GET /public-load-attachments/download/:id`: Downloads the attachment of the load identified by Id. - - `GET /public-vehicles`: List registered product-categories. + - `GET /public-vehicles`: List registered vehicles. - `GET /states`: List registered states. All these endpoints support the following parameters (except for those with `public-` as prefix, for example `public-vehicles`): @@ -37,6 +39,26 @@ All these endpoints support the following parameters (except for those with `pub - `/:id` : Read specific resource identified by Id. - `/find?regex=xxx` : List resources that matches with regex (support pagination). +### GET /public-companies + +Get public fields from registered companies. + + - `GET /shipper`: List registered shippers that are not hidden only. + - `GET /carrier`: List registered carriers that are not hidden only. + +### GET /public-loads + +Get public fields from registered loads. + + - `GET /`: List only loads with status Published. + +### GET /public-vehicles + +Get public fields from registered vehicles. + + - `GET /published`: List only latest published vehicles. + - `GET /location`: List only location from vehicles in status Free. + ## Private Endpoints The following list of endpoints requires a JWT.