Запрос информации по точкам.
Система возвращает список точек (получателей), где <limit>(integer) - количество выводимых точек, <skip>(integer) - количество пропущенных от начала точек.
Команда /points/<limit>/<skip>
Метод GET
Пример запроса
https://api.logist-pro.com.ua/api/points - выводит весь список точек;
https://api.logist-pro.com.ua/api/points/100 - выводит первые 100 точек(<limit> = 100);
https://api.logist-pro.com.ua/api/points/100/100 - выводит c 101 по 200 точку со списка (<limit> = 100, <skip>=100);
https://api.logist-pro.com.ua/api/points/0/100 - выводит c 101 и до конца списка точек (<limit> = 0, <skip>=100);
Ответ json с параметрами точек. Пример ответа
[{
"point_code" : "POINT_CODE_1",
"shipper_code": "1",
"city":"CITY",
"address":"MYADDRESS",
"company":"MYCOMPANY",
"contact_person":"CP",
"phone":"1234567890",
"email":"email@dot.com",
"comment":"comment text",
"point_zone": "Zone"
},{
"point_code" : "POINT_CODE_2",
"shipper_code": "1",
"city":"CITY",
"address":"MYADDRESS",
"company":"MYCOMPANY",
"contact_person":"CP",
"phone":"1234567890",
"email":"email@dot.com",
"comment":"comment text",
"point_zone": "Zone"
}]
| Поля в запросе | Обязательное поле | Описание | Тип поля | Пример\комментарий |
|---|---|---|---|---|
| point_code | обязательно | Уникальный код точки (получателя) | string (1..100) | |
| shipper_code | обязательно | Значение кода (ID) грузоотправителя | numeric | Предоставляется после регистрации |
| address | обязательно | Адрес | string (0..255) | |
| city | Город | string (0..255) | ||
| company | Название компании | string (0..255) | ||
| contact_person | Контактное лицо | string (0..255) | ||
| phone | Контактный номер телефона | string (0..255) | ||
| Электронная почта | string (0..255) | |||
| comment | Комментарий | string (0..255) | ||
| point_zone | Административная зона точки | string (0..255) |