nvrstyle/rest-bapi

BAPI - REST API

Описание

Сервис, реализующий функционал работы с базой данных филиалов организаций и их сотрудников, предоставляющий API для использования другими веб-сервисами

• Запуск приложения
• Описание API Endpoints

Запуск

Собранный jar файл находится в директории binary

Запуск приложения производится через terminal/cmd командой:

java -jar bapi.jar

API Endpoints

Страны

Запрос - получить список стран

GET /api/countries

Возвращает список стран

Ответ

[
  {
    "name":"Российская Федерация",
    "code":"643"
  },
  ...
]

Типы документов

Запрос - получить список типов документов

GET /api/docs

Возвращает список типов документов

Ответ

[
  {
    "name":"Паспорт гражданина РФ",
    "code":"21"
  },
  ...
]

Организации

Запрос - получить список организаций по фильтру

POST /api/organization/list

Возвращает список организаций, отфильтрованных по параметрам из запроса

Запрос

{
    "name":"", //обязательный параметр
    "inn":"",
    "isActive":""
}

Ответ

	[
  {
    "id":""",
    "name":""",
    "isActive":"true"
  },
  ...
]

Запрос - получить организацию по её id

GET /api/organization/{id}

Возвращает сорганизацию, по переданному в параметрах id

Запрос

GET /api/organization/{id}

Ответ

{
  "id":"",
  "name":"",
  "fullName":"",
  "inn":"",
  "kpp":"",
  "address":"",
  "phone","",
  "isActive":"true"
}

Запрос - обновить информацию об организации

POST /api/organization/update

Обновляет данные об организации параметрами из запроса

Запрос

{
  "id":"", //обязательный параметр
  "name":"", //обязательный параметр
  "fullName":"", //обязательный параметр
  "inn":"", //обязательный параметр
  "kpp":"",  //обязательный параметр
  "address":"", //обязательный параметр
  "phone","",
  "isActive":"true"
}

Ответ

{
    "result":"success"
}

Запрос - добавить новую организацию

POST /api/organization/save

Сохраняет новую организацию с данными из параметров запроса

Запрос

{
  "name":"", //обязательный параметр
  "fullName":"", //обязательный параметр
  "inn":"", //обязательный параметр
  "kpp":"",  //обязательный параметр
  "address":"", //обязательный параметр
  "phone","",
  "isActive":"true"
}

Ответ

{
    "result":"success"
}

Офисы

Запрос - получить список офисов по фильтру

POST /api/office/list

Возвращает список офисов, отфильтрованных по параметрам из запроса

Запрос

{
  "orgId":"", //обязательный параметр
  "name":"",
  "phone":"",
  "isActive":true 
}

Ответ

[
  {
    "id":"",
    "name":"",
    "isActive":"true"
  },
  ...
]

Запрос - получить офис по его id

GET /api/office/{id}

Возвращает офис, по переданному в параметрах id

Запрос

GET /api/office/{id}

Ответ

{
  "id":"",
  "name":"",
  "address":"",
  "phone","",
  "isActive":"true"
}

Запрос - обновить информацию об офисе

POST /api/office/update

Обновляет данные об офисе параметрами из запроса

Запрос

{
  "id":"", //обязательный параметр
  "name":"", //обязательный параметр
  "address":"", //обязательный параметр
  "phone","",
  "isActive":"true"
}

Ответ

{
    "result":"success"
}

Запрос - добавить новый офис

POST /api/office/save

Сохраняет новую офис с данными из параметров запроса

Запрос

{
  "orgId":"", //обязательный параметр
  "name":"",
  "address":"",
  "phone","",
  "isActive":"true"
}

Ответ

{
    "result":"success"
}

Пользователи

Запрос - получить список пользователей по фильтру

POST /api/user/list

Возвращает список пользователей, отфильтрованных по параметрам из запроса

Запрос

{
  "officeId":"", //обязательный параметр
  "firstName":"",
  "lastName":"",
  "middleName":"",
  "position","",
  "docCode":"",
  "citizenshipCode":""
}

Ответ

{
  "id":"",
  "firstName":"",
  "secondName":"",
  "middleName":"",
  "position":""
}

Запрос - получить пользователя по его id

GET /api/user/{id}

Возвращает пользователя, по переданному в параметрах id

Запрос

GET /api/user/{id}

Ответ

{
  "id":"",
  "firstName":"",
  "secondName":"",
  "middleName":"",
  "position":""
  "phone","",
  "docName":"",
  "docNumber":"",
  "docDate":"",
  "citizenshipName":"",
  "citizenshipCode":"",
  "isIdentified":"true"
}

Запрос - обновить информацию о пользователе

POST /api/user/update

Обновляет данные о пользователе параметрами из запроса

Запрос

{
  "id":"", //обязательный параметр
  "officeId":"",
  "firstName”:"", //обязательный параметр
  "secondName”:"",
  "middleName":"",
  "position":"" //обязательный параметр
  "phone","",
  "docName":"",
  "docNumber":"",
  "docDate":"",
  "citizenshipCode":"",
  "isIdentified":"true" //пример
}

Ответ

{
    "result":"success"
}

Запрос - добавить нового пользователя

POST /api/user/save

Сохраняет нового пользователя с данными из параметров запроса

Запрос

{
  "officeId":"", //обязательный параметр
  "firstName":"", //обязательный параметр
  "secondName":"",
  "middleName":"",
  "position":"" //обязательный параметр
  "phone","",
  "docCode":"",
  "docName":"",
  "docNumber":"",
  "docDate":"",
  "citizenshipCode":"",
  "isIdentified":"true" //пример
}

Ответ

{
    "result":"success"
}