1. Resources

1.1. Login

A POST request to log in, get token and its validity as a response.

Error codes:
401 "UNAUTHORIZED" invalid username or password or user/organization is blocked.
403 "FORBIDDEN" in case of 2nd login.

Curl request

$ curl 'http://localhost:8801/api/auth/login' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -d '{    "username": "dummy",    "password": "829C3804401B0727F70F73D4415E162400CBE57B"}'

HTTP request

POST /api/auth/login HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 84
Host: localhost:8801

{    "username": "dummy",    "password": "829C3804401B0727F70F73D4415E162400CBE57B"}

Request fields

Path Type Description

username

String

The user login

password

String

SHA-1 user password

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 14405

{"userId":21940,"organizationId":3045,"organizationLevel":3,"token":"5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e","validUntil":"2024-04-30T01:59+03:00[Europe/Minsk]","exp":1714431540,"authorities":["ADMINISTRATION_ADD","ANALYSIS_BY_VOLUME_OF_WORKPIECE_ADD","ANALYSIS_BY_VOLUME_OF_WORKPIECE_EDIT","ANALYSIS_BY_VOLUME_OF_WORKPIECE_PRINT","ANALYSIS_BY_VOLUME_OF_WORKPIECE_VIEW","ANALYSIS_WAREHOUSE_ADD_CHANGE_SAVE","ANALYTICAL_BALANCES_PRINT","ANALYTICAL_BALANCES_VIEW","ANALYTICS_VIEW","APPLICATION_ADD_CHANGE_SAVE","AUTHORIZATION_DOCUMENTS_VIEW","BALANCE_CA_FORM_ADD_CHANGE_SAVE","BALANCE_CA_FORM_DELETE","BALANCE_CA_FORM_EDIT","BALANCE_CA_FORM_PRINT","BALANCE_CA_FORM_VIEW","BALANCE_CA_OPERATIONAL_FORM_PRINT","BALANCE_CA_OPERATIONAL_FORM_VIEW","BALANCE_MONTH_PRINT","BALANCE_MONTH_VIEW","BANKING_ORGANIZATIONS_ADD","BANKING_ORGANIZATIONS_DELETE","BANKING_ORGANIZATIONS_EDIT","BANKING_ORGANIZATIONS_PRINT","BANKING_ORGANIZATIONS_VIEW","BASE_REQUESTS_PRINT","BASIC_QUERY_LIST_TABLE_QUERY_LIST_SAVE","BASIC_REQUESTS_ADD","BASIC_REQUESTS_ADD_CHANGE_SAVE","BASIC_REQUESTS_DELETE","BASIC_REQUESTS_EDIT","BASIC_REQUESTS_VIEW","BASIS_FOREST_ADD","BASIS_FOREST_DELETE","BASIS_FOREST_EDIT","BASIS_FOREST_PRINT","BASIS_FOREST_VIEW","BASIS_OF_CHANGE_ADD","BASIS_OF_CHANGE_DELETE","BASIS_OF_CHANGE_EDIT","BASIS_OF_CHANGE_PRINT","BASIS_OF_CHANGE_SAVE","BASIS_OF_CHANGE_VIEW","CARD_ADD_CHANGE_OPERATIONAL_ACCOUNT_FOR_FOREST_SAVE","CARD_ADD_CHANGE_REPORT_OPERATIONAL_ACCOUNT_SAVE","CATEGORY_PRODUCT_ADD","CATEGORY_PRODUCT_DELETE","CATEGORY_PRODUCT_EDIT","CATEGORY_PRODUCT_PRINT","CATEGORY_PRODUCT_VIEW","CLIENTS_ADD","CLIENTS_DELETE","CLIENTS_EDIT","CLIENTS_SAVE","CLIENTS_VIEW","COEFFICIENTS_OF_FULL_TREE_ADD","COEFFICIENTS_OF_FULL_TREE_ADD_CHANGE_SAVE","COEFFICIENTS_OF_FULL_TREE_DELETE","COEFFICIENTS_OF_FULL_TREE_EDIT","COEFFICIENTS_OF_FULL_TREE_PRINT","COEFFICIENTS_OF_FULL_TREE_VIEW","COMPONENT_TYPES_ADD","COMPONENT_TYPES_DELETE","COMPONENT_TYPES_EDIT","COMPONENT_TYPES_PRINT","COMPONENT_TYPES_VIEW","CONTRACT_ADD","CONTRACT_ADD_CHANGE_SAVE","CONTRACT_DELETE","CONTRACT_EDIT","CONTRACT_PRINT","CONTRACT_VIEW","CONTROL_TRANSPORT_ADD","CONTROL_TRANSPORT_DELETE","CONTROL_TRANSPORT_EDIT","CONTROL_TRANSPORT_PRINT","CONTROL_TRANSPORT_SAVE","CONTROL_TRANSPORT_VIEW","CONTROL_VERSIONS_ADD","CONTROL_VERSIONS_DELETE","CONTROL_VERSIONS_EDIT","CONTROL_VERSIONS_PRINT","CONTROL_VERSIONS_SAVE","CONTROL_VERSIONS_VIEW","DESCRIPTION_FORM_ADD","DESCRIPTION_FORM_ADD_CHANGE_SAVE","DESCRIPTION_FORM_DELETE","DESCRIPTION_FORM_EDIT","DESCRIPTION_FORM_PRINT","DESCRIPTION_FORM_VIEW","DIAMETERS_WOOD_ADD","DIAMETERS_WOOD_DELETE","DIAMETERS_WOOD_EDIT","DIAMETERS_WOOD_PRINT","DIAMETERS_WOOD_VIEW","DIRECTORY_TYPES_REPORT_DELETE","DISCHARGE_WHIPLASH_ADD","DISCHARGE_WHIPLASH_DELETE","DISCHARGE_WHIPLASH_EDIT","DISCHARGE_WHIPLASH_PRINT","DISCHARGE_WHIPLASH_SAVE","DISCHARGE_WHIPLASH_VIEW","EGAIS_BUY_USERS_EDIT","EGAIS_BUY_USERS_VIEW","EGAIS_II_SESSION_DELETE","EGAIS_II_USERS_EDIT","EGAIS_II_USERS_VIEW","EMPLOYEES_ADD","EMPLOYEES_ADD_CHANGE_SAVE","EMPLOYEES_DELETE","EMPLOYEES_EDIT","EMPLOYEES_FORESTER_ADD","EMPLOYEES_FORESTER_ADD_CHANGE_SAVE","EMPLOYEES_FORESTER_DELETE","EMPLOYEES_FORESTER_EDIT","EMPLOYEES_FORESTER_PRINT","EMPLOYEES_FORESTER_VIEW","EMPLOYEES_PRINT","EMPLOYEES_VIEW","FOLDER_OTHER_VIEW","FORESTRY_CATALOG_VIEW","FORMS_REPORTS_ADD","FORMS_REPORTS_DELETE","FORMS_REPORTS_EDIT","FORMS_REPORTS_PRINT","FORMS_REPORTS_VIEW","FORM_ADD_SPECIFICATION_MOVEMENT_TO_DOCUMENT_WAREHOUSE_SAVE","FORM_ADD_SPECIFICATION_TO_STOCK_DOCUMENT_SAVE","FORM_GENERATE_REPORTS_SAVE","FORM_NEWS_SAVE","FUNCTION_REQUEST_ADD_CHANGE_SAVE","GENERAL_VIEW","GENERATOR_REPORT_ADD","GENERATOR_REPORT_ADD_CHANGE_SAVE","GENERATOR_REPORT_ADD_COLUMN_SAVE","GENERATOR_REPORT_DELETE","GENERATOR_REPORT_EDIT","GENERATOR_REPORT_PRINT","GENERATOR_REPORT_VIEW","GPS_DEVICES_ADD","GPS_DEVICES_DELETE","GPS_DEVICES_EDIT","GPS_DEVICES_SAVE","GPS_DEVICES_VIEW","GROUPS_DIAMETERS_ADD","GROUPS_DIAMETERS_DELETE","GROUPS_DIAMETERS_EDIT","GROUPS_DIAMETERS_PRINT","GROUPS_DIAMETERS_VIEW","GROUPS_ROLES_DELETE","GROUPS_ROLES_PRINT","GROUPS_ROLE_ADD","GROUPS_ROLE_EDIT","GROUPS_ROLE_SAVE","GROUPS_ROLE_VIEW","HANDBOOK_HANDLES_ADD","HANDBOOK_HANDLES_DELETE","HANDBOOK_HANDLES_EDIT","HANDBOOK_HANDLES_PRINT","HANDBOOK_HANDLES_VIEW","ITEM_NOMENCLATURE_ADD","ITEM_NOMENCLATURE_ADD_CHANGE_SAVE","ITEM_NOMENCLATURE_DELETE","ITEM_NOMENCLATURE_EDIT","ITEM_NOMENCLATURE_PRINT","ITEM_NOMENCLATURE_VIEW","JSON_FILES_FOR_PROCESSING_ADD_CHANGE_SAVE","JSON_FILES_TO_PROCESS_ADD","JSON_FILES_TO_PROCESS_DELETE","JSON_FILES_TO_PROCESS_EDIT","JSON_FILES_TO_PROCESS_PRINT","JSON_FILES_TO_PROCESS_VIEW","LABEL_SUPPLIER_ADD","LABEL_SUPPLIER_ADD_SAVE","LABEL_SUPPLIER_DELETE","LABEL_SUPPLIER_EDIT","LABEL_SUPPLIER_PRINT","LABEL_SUPPLIER_VIEW","LENGTHS_PRODUCTS_ADD","LENGTHS_PRODUCTS_DELETE","LENGTHS_PRODUCTS_EDIT","LENGTHS_PRODUCTS_PRINT","LENGTHS_PRODUCTS_VIEW","LESOSKI_ADD","LESOSKI_DELETE","LESOSKI_EDIT","LESOSKI_PRINT","LESOSKI_VIEW","LIST_OF_FUNCTIONS_FOR_DYNAMIC_REPORT","LIST_OF_FUNCTIONS_FOR_DYNAMIC_REPORT_ADD","LIST_OF_FUNCTIONS_FOR_DYNAMIC_REPORT_EDIT","LIST_OF_FUNCTIONS_FOR_DYNAMIC_REPORT_PRINT","LIST_OF_FUNCTIONS_FOR_DYNAMIC_REPORT_VIEW","LIST_PARAMETERS_FUNCTIONS_ADD","LIST_PARAMETERS_FUNCTIONS_ADD_CHANGE_SAVE","LIST_PARAMETERS_FUNCTIONS_DELETE","LIST_PARAMETERS_FUNCTIONS_EDIT","LIST_PARAMETERS_FUNCTIONS_PRINT","LIST_PARAMETERS_FUNCTIONS_VIEW","LIST_RIGHTS_APPLICATION_PRINT","LIST_RIGHT_APPLICATION_ADD","LIST_RIGHT_APPLICATION_DELETE","LIST_RIGHT_APPLICATION_EDIT","LIST_RIGHT_APPLICATION_VIEW","LOGGING_ADD_CHANGE_SAVE","LOGGING_SETTINGS_ADD","LOGGING_SETTINGS_ADD_CHANGE_ADD","LOGGING_SETTINGS_ADD_CHANGE_DELETE","LOGGING_SETTINGS_ADD_CHANGE_EDIT","LOGGING_SETTINGS_ADD_CHANGE_PRINT","LOGGING_SETTINGS_ADD_CHANGE_SAVE","LOGGING_SETTINGS_ADD_CHANGE_VIEW","LOGGING_SETTINGS_DELETE","LOGGING_SETTINGS_EDIT","LOGGING_SETTINGS_PRINT","LOGGING_SETTINGS_SAVE","LOGGING_SETTINGS_VIEW","LOGS_VIEW","LOG_CHANGES_DB_ADD","LOG_CHANGES_DB_DELETE","LOG_CHANGES_DB_EDIT","LOG_CHANGES_DB_PRINT","LOG_CHANGES_DB_VIEW","LOG_CHECK_VIEW","LOG_MOBILE_APPLICATION_PRINT","LOG_MOBILE_APPLICATION_VIEW","MACHINES_ADD","MACHINES_ADD_CHANGE_SAVE","MACHINES_DELETE","MACHINES_EDIT","MACHINES_PRINT","MACHINES_VIEW","MANAGE_VERSIONS_ADD_CHANGE_ADD","MANAGE_VERSIONS_ADD_CHANGE_DELETE","MANAGE_VERSIONS_ADD_CHANGE_EDIT","MANAGE_VERSIONS_ADD_CHANGE_PRINT","MANAGE_VERSIONS_ADD_CHANGE_SAVE","MANAGE_VERSIONS_ADD_CHANGE_VIEW","METHOD_DEFINITION_VOLUME_ADD","METHOD_DEFINITION_VOLUME_DELETE","METHOD_DEFINITION_VOLUME_EDIT","METHOD_DEFINITION_VOLUME_PRINT","METHOD_DEFINITION_VOLUME_VIEW","METHOD_OF_DETERMINING_CHOP_VOLUME_ADD","METHOD_OF_DETERMINING_CHOP_VOLUME_DELETE","METHOD_OF_DETERMINING_CHOP_VOLUME_EDIT","METHOD_OF_DETERMINING_CHOP_VOLUME_PRINT","METHOD_OF_DETERMINING_CHOP_VOLUME_VIEW","MOBILE_INSTALL_PRINT","MOBILE_INSTALL_VIEW","MOBILE_MODULE_FOREST_ADD","MOBILE_MODULE_FOREST_DELETE","MOBILE_MODULE_FOREST_EDIT","MOBILE_MODULE_FOREST_PRINT","MOBILE_MODULE_FOREST_SAVE","MOBILE_MODULE_FOREST_VIEW","MP_OBS_OVER_WAREHOUSE_ADD","MP_OBS_OVER_WAREHOUSE_DELETE","MP_OBS_OVER_WAREHOUSE_EDIT","MP_OBS_OVER_WAREHOUSE_PRINT","MP_OBS_OVER_WAREHOUSE_SAVE","MP_OBS_OVER_WAREHOUSE_VIEW","NEWS_FORM_ADD","NEWS_FORM_DELETE","NEWS_FORM_EDIT","NEWS_FORM_PRINT","NEWS_FORM_VIEW","NSI_APPLICATION_ROLES_ADD","NSI_APPLICATION_ROLES_DELETE","NSI_APPLICATION_ROLES_EDIT","NSI_APPLICATION_ROLES_PRINT","NSI_APPLICATION_ROLES_VIEW","NSI_ROLE_GROUPS_ADD","NSI_ROLE_GROUPS_DELETE","NSI_ROLE_GROUPS_EDIT","NSI_ROLE_GROUPS_PRINT","NSI_ROLE_GROUPS_VIEW","NSI_VIEW","OPERATIONAL_ACCOUNTING_ADD","OPERATIONAL_ACCOUNTING_EDIT","OPERATIONAL_ACCOUNTING_PRINT","OPERATIONAL_ACCOUNTING_VIEW","OPERATIVE_ACCOUNTING_ADD","OPERATIVE_ACCOUNTING_DELETE","OPERATIVE_ACCOUNTING_EDIT","OPERATIVE_ACCOUNTING_PRINT","OPERATIVE_ACCOUNTING_SAVE","OPERATIVE_ACCOUNTING_VIEW","ORGANIZATIONS_ADD","ORGANIZATIONS_ADD_CHANGE_SAVE","ORGANIZATIONS_DELETE","ORGANIZATIONS_EDIT","ORGANIZATIONS_PRINT","ORGANIZATIONS_VIEW","ORGANIZATION_STORAGE_VIEW","PERMIT_DOCUMENT_ADD","PERMIT_DOCUMENT_ADD_CHANGE_SAVE","PERMIT_DOCUMENT_DELETE","PERMIT_DOCUMENT_EDIT","PERMIT_DOCUMENT_PRINT","PERMIT_DOCUMENT_VIEW","PERMIT_TYPES_ADD","PERMIT_TYPES_DELETE","PERMIT_TYPES_EDIT","PERMIT_TYPES_PRINT","PERMIT_TYPES_VIEW","POSITIONS_ADD","POSITIONS_ADD_CHANGE_SAVE","POSITIONS_DELETE","POSITIONS_EDIT","POSITIONS_PRINT","POSITIONS_VIEW","PRODUCT_AVAILABILITY_IN_WAREHOUSES_ADD","PRODUCT_AVAILABILITY_IN_WAREHOUSES_DELETE","PRODUCT_AVAILABILITY_IN_WAREHOUSES_EDIT","PRODUCT_AVAILABILITY_IN_WAREHOUSES_PRINT","PRODUCT_AVAILABILITY_IN_WAREHOUSES_VIEW","QUERY_TYPES_ADD","QUERY_TYPES_DELETE","QUERY_TYPES_EDIT","QUERY_TYPES_PRINT","QUERY_TYPES_VIEW","REFERENCES_ADD","REFERENCE_LICENSE_DOCUMENTS_VIEW","REFERENCE_NOMENCLATURES_VIEW","REFERENCE_OPERATOR_CONDITIONS_ADD","REFERENCE_OPERATOR_CONDITIONS_DELETE","REFERENCE_OPERATOR_CONDITIONS_EDIT","REFERENCE_OPERATOR_CONDITIONS_PRINT","REFERENCE_OPERATOR_CONDITIONS_VIEW","REFERENCE_TYPES_REPORT_EDIT","REFERENCE_TYPES_REPORT_PRINT","REFERENCE_TYPE_REPORT_ADD","REFERENCE_TYPE_REPORT_VIEW","REFERENCE_WAREHOUSES_VIEW","REGISTER_MOVEMENT_BY_WAREHOUSE_ADD","REGISTER_MOVEMENT_BY_WAREHOUSE_DELETE","REGISTER_MOVEMENT_BY_WAREHOUSE_EDIT","REGISTER_MOVEMENT_BY_WAREHOUSE_PRINT","REGISTER_MOVEMENT_BY_WAREHOUSE_VIEW","REGULATION_CLOSING_REPORTING_PERIOD_ADD","REGULATION_CLOSING_REPORTING_PERIOD_ADD_CHANGE_SAVE","REGULATION_CLOSING_REPORTING_PERIOD_DELETE","REGULATION_CLOSING_REPORTING_PERIOD_EDIT","REGULATION_CLOSING_REPORTING_PERIOD_PRINT","REGULATION_CLOSING_REPORTING_PERIOD_VIEW","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_ADD","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_DELETE","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_EDIT","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_PRINT","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_SAVE","RELATIONSHIP_TYPES_STORAGE_STOCKS_WITH_ACTIONS_VIEW","REPORTING_VIEW","RIGHTS_ACCESS_VIEW","ROLES_ADD","ROLES_DELETE","ROLES_EDIT","ROLES_PRINT","ROLES_SAVE","ROLES_VIEW","SCHEDULER_ADD_CHANGE_SAVE","SCHEDULER_VIEW","SETUP_REPORTING_VIEW","SPECIFICATIONS_FORESTER_ADD","SPECIFICATIONS_FORESTER_ADD_CHANGE_SAVE","SPECIFICATIONS_FORESTER_DELETE","SPECIFICATIONS_FORESTER_EDIT","SPECIFICATIONS_FORESTER_PRINT","SPECIFICATIONS_FORESTER_VIEW","STATS_PROCESSING_PRINT","STATUS_PROCESSING_ADD","STATUS_PROCESSING_DELETE","STATUS_PROCESSING_EDIT","STATUS_PROCESSING_VIEW","STOCK_DOCUMENTS_ADD_CHANGE_SAVE","STORAGE_ADD_CHANGE_MOL_SAVE","STORAGE_ADD_CHANGE_SAVE","STRUCTURE_UNITS_ADD","STRUCTURE_UNITS_DELETE","STRUCTURE_UNITS_EDIT","STRUCTURE_UNITS_PRINT","STRUCTURE_UNITS_VIEW","STRUCTURE_UNIT_ADD_CHANGE_SAVE","SUPPORT_ABON_PAYMENT_ADD","SUPPORT_ABON_PAYMENT_EDIT","SUPPORT_ABON_PAYMENT_PRINT","SUPPORT_ABON_PAYMENT_SAVE","SUPPORT_ABON_PAYMENT_VIEW","SUPPORT_FUNCTION_ADD","SUPPORT_FUNCTION_EDIT","SUPPORT_FUNCTION_PRINT","SUPPORT_FUNCTION_SAVE","SUPPORT_FUNCTION_VIEW","SYSTEM_SETTINGS_VIEW","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_ADD","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_ADD_CHANGE_SAVE","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_DELETE","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_EDIT","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_PRINT","TABLE_COLUMN_LIST_FOR_DYNAMIC_QUERIES_VIEW","TABLE_LIST_DB_ADD","TABLE_LIST_DB_DELETE","TABLE_LIST_DB_EDIT","TABLE_LIST_DB_PRINT","TABLE_LIST_DB_VIEW","TAGS_ADD","TAGS_DELETE","TAGS_EDIT","TAGS_PRINT","TAGS_VIEW","TIMBER_VOLUMES_WOOD_ADD_CHANGE_SAVE","TIMBER_VOLUMES_WOOD_CUBIC_ADD","TIMBER_VOLUMES_WOOD_CUBIC_DELETE","TIMBER_VOLUMES_WOOD_CUBIC_EDIT","TIMBER_VOLUMES_WOOD_CUBIC_PRINT","TIMBER_VOLUMES_WOOD_CUBIC_VIEW","TRANSPORT_VIEW","TREE_SPECIES_AND_WOOD_GROUPS_ADD","TREE_SPECIES_AND_WOOD_GROUPS_ADD_CHANGE_SAVE","TREE_SPECIES_AND_WOOD_GROUPS_DELETE","TREE_SPECIES_AND_WOOD_GROUPS_EDIT","TREE_SPECIES_AND_WOOD_GROUPS_PRINT","TREE_SPECIES_AND_WOOD_GROUPS_VIEW","TYPES_OF_USAGE_AND_CHOP_TYPES_ADD","TYPES_OF_USE_AND_CHOPPER_VIEWS_ADD_CHANGE_SAVE","TYPES_OF_USE_AND_CHOP_TYPES_DELETE","TYPES_OF_USE_AND_CHOP_TYPES_EDIT","TYPES_OF_USE_AND_CHOP_TYPES_PRINT","TYPES_OF_USE_AND_CHOP_TYPES_VIEW","TYPES_WAREHOUSE_OPERATIONS_ADD","TYPES_WAREHOUSE_OPERATIONS_DELETE","TYPES_WAREHOUSE_OPERATIONS_EDIT","TYPES_WAREHOUSE_OPERATIONS_PRINT","TYPES_WAREHOUSE_OPERATIONS_VIEW","TYPE_ACTIVITY_ADD","TYPE_ACTIVITY_DELETE","TYPE_ACTIVITY_EDIT","TYPE_ACTIVITY_PRINT","TYPE_ACTIVITY_VIEW","TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_ADD","TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_DELETE","TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_EDIT","TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_PRINT","TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_VIEW","TYPE_APPLICATION_ADD","TYPE_APPLICATION_DELETE","TYPE_APPLICATION_EDIT","TYPE_APPLICATION_PRINT","TYPE_APPLICATION_VIEW","TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_ADD","TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_DELETE_OPERATION","TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_EDIT","TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_PRINT","TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_VIEW","TYPE_OF_VEHICLE_ADD","TYPE_OF_VEHICLE_DELETE","TYPE_OF_VEHICLE_EDIT","TYPE_OF_VEHICLE_PRINT","TYPE_OF_VEHICLE_VIEW","UNITS_ADD","UNITS_DELETE","UNITS_EDIT","UNITS_PRINT","UNITS_SAVE","UNITS_VIEW","USERS_ADD","USERS_ADD_CHANGE_SAVE","USERS_DELETE","USERS_EDIT","USERS_PRINT","USERS_SAVE","USERS_VIEW","VARIETIES_ADD","VARIETIES_DELETE","VARIETIES_EDIT","VARIETIES_PRINT","VARIETIES_VIEW","VEHICLES_BY_DOCUMENTS_ADD_CHANGE_SAVE","VEHICLES_DOCUMENT_ADD","VEHICLES_DOCUMENT_DELETE","VEHICLES_DOCUMENT_EDIT","VEHICLES_DOCUMENT_PRINT","VEHICLES_DOCUMENT_VIEW","WAREHOUSES_ADD","WAREHOUSES_DELETE","WAREHOUSES_EDIT","WAREHOUSES_PRINT","WAREHOUSES_VIEW","WAREHOUSE_ACCOUNTING_ADD","WAREHOUSE_ACCOUNTING_DELETE","WAREHOUSE_ACCOUNTING_EDIT","WAREHOUSE_ACCOUNTING_PRINT","WAREHOUSE_ACCOUNTING_VIEW","WAREHOUSE_ADD","WAREHOUSE_ADD_LOCK_TO_ADJUST_RESIDUALS_SAVE","WAREHOUSE_ANALYTIC_ADD","WAREHOUSE_ANALYTIC_DELETE","WAREHOUSE_ANALYTIC_EDIT","WAREHOUSE_ANALYTIC_PRINT","WAREHOUSE_ANALYTIC_VIEW","WAREHOUSE_DOCUMENTS_ADD","WAREHOUSE_DOCUMENTS_DELETE","WAREHOUSE_DOCUMENTS_EDIT","WAREHOUSE_DOCUMENTS_PRINT","WAREHOUSE_DOCUMENTS_VIEW","WAREHOUSE_TYPES_ADD","WAREHOUSE_TYPES_DELETE","WAREHOUSE_TYPES_EDIT","WAREHOUSE_TYPES_PRINT","WAREHOUSE_TYPES_VIEW","WOOD_VARIETIES_ADD","WOOD_VARIETIES_DELETE","WOOD_VARIETIES_EDIT","WOOD_VARIETIES_PRINT","WOOD_VARIETIES_VIEW"],"lastName":"Тестовый","firstName":"Google","middleName":"Play","jobTitle":"специалист"}

Response fields

Path Type Description

userId

Number

User id

organizationId

Number

Organization id

organizationLevel

Number

Organization level(1-4)

token

String

User token

validUntil

String

Expiration description.

exp

Number

Expiration Unix Epoc Time (in seconds).

lastName

String

User last name

firstName

String

User first name

middleName

String

User middle name

jobTitle

String

User job title

authorities

Array

User authorities.

1.2. Departments with Organizations

1.2.1. Get current user Departments

A GET request to get departments/organizations of user. Request parameter "level" is optional.

Required ORGANIZATIONS_VIEW(201,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/departments?level=4' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/departments?level=4 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Query parameters
Parameter Description

level

Level of department(default = 1, recommended = 4)
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 869

[{"departmentId":40,"shortName":"Тест_лесничество","departmentCode":"1500900001","organizationId":3046,"parentId":38,"levelParent":4},{"departmentId":111,"shortName":"Тест_лесопункт","departmentCode":"505050","organizationId":3049,"parentId":38,"levelParent":4},{"departmentId":384,"shortName":"Тест_лесничество 2","departmentCode":"4242272","organizationId":3075,"organizationUnp":"999999999","parentId":38,"levelParent":4},{"departmentId":2056,"shortName":"тест_цех","organizationId":5029,"parentId":38,"levelParent":4},{"departmentId":4299,"shortName":"Тест_Ж/Д станция","organizationId":7212,"parentId":38,"levelParent":4},{"departmentId":5579,"shortName":"Тест_лесничество 4","departmentCode":"7070705","organizationId":8432,"organizationUnp":"665544332","parentId":38,"levelParent":4}]
Response fields-
Path Type Description

departmentId

Number

Department id.

shortName

String

Department name.

departmentCode

String

Department code. Optional.

organizationId

Number

Organization id. Optional

organizationUnp

String

Organization Unp. Optional

parentId

Number

Department parent id. Optional.

levelParent

Number

Department level[1-4]. Optional.

1.2.2. Get Department by department code

Curl request
$ curl 'http://localhost:8801/api/organizations/departments/1521040205' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/departments/1521040205 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/departments/{departmentCode}
Parameter Description

departmentCode

The code of Department.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 179

{"departmentId":372,"shortName":"Неманское лесничество Гродно","departmentCode":"1521040205","organizationId":3062,"parentId":1521040200,"levelParent":4}
Response fields
Path Type Description

departmentId

Number

Department id.

shortName

String

Department name.

departmentCode

String

Department code. Optional.

organizationId

Number

Organization id. Optional

organizationUnp

String

Organization Unp. Optional

parentId

Number

Department parent id. Optional.

levelParent

Number

Department level[1-4]. Optional.

1.3. Organizations

1.3.1. Get Organization by ID

A GET request to get organization by organization id. Organization must belong User’s organization and received organization.

Required ORGANIZATIONS_VIEW(201,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/3046' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/3046 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/{organizationId}
Parameter Description

organizationId

The id of Organization.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 189

{"id":3046,"fullName":"Тест_лесничество","shortName":"Тест_лесничество","isDeleted":false,"isBlocked":false,"extOrg":false,"storages":null,"waybillUsers":null}
Response fields
Path Type Description

id

Number

The id of Organization.

fullName

String

The full name of organization.

shortName

String

The short name of organization. Optional.

unp

String

Organization Unp. Optional.

okpo

String

Organization okpo. Optional.

rcount

String

Settlement account of the organization. Optional.

regEgr

String

The registration number EGR of organization. Optional.

regDecisionDate

String

Date of the decision on registration of the EGR. Optional.

regNumber

String

EGR registration decision number. Optional.

postalCode

String

The postal code of Organization.

isDeleted

Boolean

True when Organization deleted. Optional.

countryCode

String

The Organization country code. Optional.

countryName

String

The Organization country name. Optional.

region

String

The Organization district location. Optional.

city

String

The Organization city location. Optional.

streetHome

String

The Organization address. Optional.

telephone

String

The phone number of Organization. Optional.

fax

String

The Organization’s fax. Optional.

email

String

The Organization’s email. Optional.

isBlocked

Boolean

True when Organization blocked. Optional.

regOrgan

String

Registration authority of the Organization. Optional.

extOrg

Boolean

True when Organization is external. Optional.

1.3.2. Get Organization by UNP

A GET request to get organization by organization UNP.

Required ORGANIZATIONS_VIEW(201,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/unp/500682227' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/unp/500682227 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/unp/{unp}
Parameter Description

unp

The UNP of Organization.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 779

{"id":3029,"fullName":"Филиал по розничной мелкооптовой торговле Гродненский лесхоз","shortName":"Филиал Гродненский лесхоз","unp":"500682227","bank":23,"rcount":"BY36BAPB3015222160014000","regDecisionDate":"2000-07-19","postalCode":"230030","isDeleted":false,"countryCode":"375","countryName":"Республика Беларусь","region":"Гродненская","city":"Гродно","streetHome":"ул. Фестивальная, д. 16а/2","telephone":"(80152) 68-86-52","fax":"(80152) 68-86-52","email":"leshos_filial@tut.by","isBlocked":true,"regOrgan":"Гродненский городской исполнительный комитет","extOrg":false,"storages":null,"waybillUsers":null}
Response fields
Path Type Description

id

Number

The id of Organization.

fullName

String

The full name of organization.

shortName

String

The short name of organization. Optional.

unp

String

Organization Unp. Optional

okpo

String

Organization okpo. Optional

rcount

String

Settlement account of the organization. Optional.

regEgr

String

The registration number EGR of organization. Optional.

regDecisionDate

String

Date of the decision on registration of the EGR. Optional.

regNumber

String

EGR registration decision number. Optional.

postalCode

String

The postal code of Organization.

isDeleted

Boolean

True when Organization deleted. Optional.

countryCode

String

The Organization country code. Optional,

countryName

String

The Organization country name. Optional.

region

String

The Organization district location. Optional.

city

String

The Organization city location. Optional.

streetHome

String

The Organization address. Optional.

telephone

String

The phone number of Organization. Optional.

fax

String

The Organization’s fax. Optional.

email

String

The Organization’s email. Optional.

isBlocked

Boolean

True when Organization blocked. Optional.

regOrgan

String

Registration authority of the Organization. Optional.

extOrg

Boolean

True when Organization is external. Optional.

1.3.3. Get all Organizations

A GET request to get all organizations. Response fields are the same as in the previous request.

Warning: a response would contain more than 4500 records.

Required ORGANIZATIONS_VIEW(201,3) role.

/api/organizations

GET /api/organizations HTTP/1.1
Authorization: 9D412264A84416A6B2626AEEF78AA199DEBA9BA7
Host: localhost:8801

1.4. DocStorages

1.4.1. Get Operations

A GET request to get storage operations for organization. Dates must be within one month. It’s allowed to receive operations only for the user’s organizations.

Required REGISTER_MOVEMENT_BY_WAREHOUSE_VIEW(303,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/3046/operations?dateStart=2021-02-01&dateEnd=2021-02-28' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/3046/operations?dateStart=2021-02-01&dateEnd=2021-02-28 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/{id}/operations
Parameter Description

id

The id of Organization
Query parameters
Parameter Description

dateStart

LocalDate of beginning date.

dateEnd

LocalDate of expiration date.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 13268

[{"dateDoc":"2021-02-07","numberDoc":"210207160545-741204","docStorageId":2394691,"docStorageTypeId":14,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":1204,"consigneeType":1,"operationStorageId":5702378,"operationVisible":1,"quantityPcs":0,"volumeM3":-10.0,"nomenclatureId":1111132,"productCode":"10001510001000000000","lengthValue":1.7},{"dateDoc":"2021-02-10","numberDoc":"210210155649-291204","docStorageId":2394561,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":1204,"consigneeType":1,"operationStorageId":5701937,"operationVisible":1,"quantityPcs":0,"volumeM3":10.0,"nomenclatureId":1111132,"productCode":"10001510001000000000","lengthValue":1.7},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375461,"operationVisible":0,"quantityPcs":2,"volumeM3":0.246,"nomenclatureId":1692328,"productCode":"10008010001001024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375463,"operationVisible":1,"quantityPcs":-2,"volumeM3":-0.246,"nomenclatureId":1692328,"productCode":"10008010001001024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375464,"operationVisible":0,"quantityPcs":2,"volumeM3":0.246,"nomenclatureId":1695380,"productCode":"10008010001002024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375466,"operationVisible":1,"quantityPcs":-2,"volumeM3":-0.246,"nomenclatureId":1695380,"productCode":"10008010001002024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375467,"operationVisible":0,"quantityPcs":10,"volumeM3":1.23,"nomenclatureId":1504232,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375469,"operationVisible":1,"quantityPcs":-10,"volumeM3":-1.23,"nomenclatureId":1504232,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375471,"operationVisible":0,"quantityPcs":6,"volumeM3":0.93,"nomenclatureId":1504233,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375473,"operationVisible":1,"quantityPcs":-6,"volumeM3":-0.93,"nomenclatureId":1504233,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375474,"operationVisible":0,"quantityPcs":7,"volumeM3":1.358,"nomenclatureId":1504234,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375476,"operationVisible":1,"quantityPcs":-7,"volumeM3":-1.358,"nomenclatureId":1504234,"productCode":"10008010001003024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210144946-4715410","docStorageId":2300761,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":15410,"consigneeType":1,"operationStorageId":5374818,"operationVisible":1,"quantityPcs":0,"volumeM3":20.0,"nomenclatureId":1692373,"productCode":"10001520004000000000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375462,"operationVisible":0,"quantityPcs":-2,"volumeM3":-0.246,"nomenclatureId":1071617,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375465,"operationVisible":0,"quantityPcs":-2,"volumeM3":-0.246,"nomenclatureId":1071617,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375468,"operationVisible":0,"quantityPcs":-10,"volumeM3":-1.23,"nomenclatureId":1071617,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375470,"operationVisible":1,"quantityPcs":-1,"volumeM3":-0.123,"nomenclatureId":1071617,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375472,"operationVisible":0,"quantityPcs":-6,"volumeM3":-0.93,"nomenclatureId":1071618,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210145522-1215410","docStorageId":2300938,"docStorageTypeId":8,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":15410,"storagePostingId":37606,"consigneeType":1,"basisDocumentTypeId":3,"operationStorageId":5375475,"operationVisible":0,"quantityPcs":-7,"volumeM3":-1.358,"nomenclatureId":1071619,"productCode":"10008010001000024000","lengthValue":6.0,"employeeDrive":"тест водитель ","carPlate":"ЕВ 0440-3"},{"dateDoc":"2021-02-10","numberDoc":"210210144946-4715410","docStorageId":2300761,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":15410,"consigneeType":1,"operationStorageId":5374814,"operationVisible":1,"quantityPcs":9,"volumeM3":2.07,"nomenclatureId":1071620,"productCode":"10008010001000024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210144946-4715410","docStorageId":2300761,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":15410,"consigneeType":1,"operationStorageId":5374815,"operationVisible":1,"quantityPcs":21,"volumeM3":5.88,"nomenclatureId":1071621,"productCode":"10008010001000024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210144946-4715410","docStorageId":2300761,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":15410,"consigneeType":1,"operationStorageId":5374816,"operationVisible":1,"quantityPcs":14,"volumeM3":4.62,"nomenclatureId":1071622,"productCode":"10008010001000024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210144946-4715410","docStorageId":2300761,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":15410,"consigneeType":1,"operationStorageId":5374817,"operationVisible":1,"quantityPcs":13,"volumeM3":5.85,"nomenclatureId":1071624,"productCode":"10008010001000030000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375904,"operationStorageParentId":5375463,"operationVisible":1,"quantityPcs":2,"volumeM3":0.246,"nomenclatureId":1692328,"productCode":"10008010001001024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375905,"operationStorageParentId":5375466,"operationVisible":1,"quantityPcs":2,"volumeM3":0.246,"nomenclatureId":1695380,"productCode":"10008010001002024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375906,"operationStorageParentId":5375469,"operationVisible":1,"quantityPcs":10,"volumeM3":1.23,"nomenclatureId":1504232,"productCode":"10008010001003024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375908,"operationStorageParentId":5375473,"operationVisible":1,"quantityPcs":6,"volumeM3":0.93,"nomenclatureId":1504233,"productCode":"10008010001003024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375909,"operationStorageParentId":5375476,"operationVisible":1,"quantityPcs":7,"volumeM3":1.358,"nomenclatureId":1504234,"productCode":"10008010001003024000","lengthValue":6.0},{"dateDoc":"2021-02-10","numberDoc":"210210150829-3937606","docStorageId":2301058,"docStorageParentId":2300938,"docStorageTypeId":5,"docStorageTypeActivityId":1,"employeeId":309,"storageLeaveId":37606,"consigneeType":1,"operationStorageId":5375907,"operationStorageParentId":5375470,"operationVisible":1,"quantityPcs":1,"volumeM3":0.123,"nomenclatureId":1071617,"productCode":"10008010001000024000","lengthValue":6.0},{"dateDoc":"2021-02-23","numberDoc":"210223162410-251204","docStorageId":2395005,"docStorageTypeId":5,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":1204,"consigneeType":1,"operationStorageId":5703431,"operationVisible":1,"quantityPcs":0,"volumeM3":5.0,"nomenclatureId":1732610,"productCode":"10008010001000061000","lengthValue":1.5},{"dateDoc":"2021-02-23","numberDoc":"210223175501-591204","docStorageId":2395916,"docStorageTypeId":5,"docStorageTypeActivityId":2,"employeeId":309,"storageLeaveId":1204,"consigneeType":1,"operationStorageId":5707272,"operationVisible":1,"quantityPcs":4,"volumeM3":2.12,"nomenclatureId":1732618,"productCode":"10008020227002030000","lengthValue":5.5}]
Response fields-
Path Type Description

dateDoc

String

Doc storage local date in ISO 8601 'YYYY-MM-DD' format.

numberDoc

String

Doc storage number. Optional.

docStorageId

Number

Doc storage id.

docStorageParentId

Number

Doc storage parent id. Optional

docStorageTypeId

Number

Doc storage type id[4-18]. Optional

docStorageTypeActivityId

Number

Doc storage type activity id[1-3].

employeeId

Number

Responsible employee id, performing the operation. Optional.

labelId

Number

Label id on truck. Optional.

storageLeaveId

Number

Storage leave id. Optional.

storagePostingId

Number

Storage posting id. Optional.

consigneeType

Number

Consignee type[1,2](company/individual). Optional.

organizationConsignee

String

Consignee(individual) person name. Optional.

basisDocumentTypeId

Number

Basis document type id for operation. Optional.

basisDocumentNumber

String

Basis document number for operation. Optional.

basisDocumentDate

String

Basis document local date for operation. Optional.

numberCommission

String

Commission/order contract number. Optional.

dateCommission

String

Commission/order contract local date. Optional.

operationStorageId

Number

Operation storage id.

operationStorageParentId

Number

Operation storage parent id. Optional

operationVisible

Number

Is operation visible for client[0,1]. Optional.

quantityPcs

Number

Quantity, piece by piece accounting.

volumeM3

Number

Volume, cubic meters accounting.

nomenclatureId

Number

Nomenclature id

woodDiamGroupId

Number

Wood diameter group id from Operation storage. Optional.

productCode

String

20 digits code starts with '10' for logging.

lengthValue

Number

The length value for the nomenclature in meters. Optional.

organizationConsigneeId

Number

Organization consignee id. Optional.

organizationShortName

String

Organization consignee name. Optional.

organizationUnp

String

Organization consignee UNP. Optional.

organizationTransportId

Number

Organization transport customer id. Optional.

employeeDrive

String

Driver full name. Optional.

carPlate

String

Truck license plate. Optional.

trailerPlate

String

Trailer license plate. Optional.

1.4.2. Get DocStorageTypes

A GET request for DocStorageTypes.

Required TYPES_WAREHOUSE_OPERATIONS_VIEW(111,3) role.

Curl request
$ curl 'http://localhost:8801/api/doc-storages/doc-storage-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/doc-storages/doc-storage-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2038

[{"id":4,"shortName":"Корректировка остатков","fullName":"Корректировка остатков","codeDocStorage":"002","codeOperation":"1"},{"id":5,"shortName":"Приход","fullName":"Приход","codeDocStorage":"003","codeOperation":"+"},{"id":7,"shortName":"Расход для собственного потребления","fullName":"Расход для собственного потребления","codeDocStorage":"004","codeOperation":"-"},{"id":8,"shortName":"Расход при внутреннем перемещении","fullName":"Расход при внутреннем перемещении","codeDocStorage":"005","codeOperation":"-"},{"id":9,"shortName":"Перевод","fullName":"Перевод в сортимент","codeDocStorage":"007","codeOperation":"0"},{"id":12,"shortName":"Расход при реализации потребителю","fullName":"Расход при реализации потребителю","codeDocStorage":"006","codeOperation":"-"},{"id":14,"shortName":"Расход для переработки","fullName":"Расход для переработки","codeDocStorage":"008","codeOperation":"-"},{"id":15,"shortName":"Расход при реализации на экспорт","fullName":"Расход при реализации на экспорт","codeDocStorage":"009","codeOperation":"-"},{"id":16,"shortName":"Замена бирки","fullName":"Замена бирки","codeDocStorage":"010","codeOperation":"$"},{"id":17,"shortName":"Перевод в группу","fullName":"Перевод в группу","codeDocStorage":"011","codeOperation":"0"},{"id":18,"shortName":"Расход для автоматизированной переработки","fullName":"Расход для автоматизированной переработки","codeDocStorage":"012","codeOperation":"-"},{"id":19,"shortName":"Раскряжевка","fullName":"Раскряжевка","codeDocStorage":"019","codeOperation":"0"}]
Response fields-
Path Type Description

id

Number

The DocStorageType id.

shortName

String

The short name.

fullName

String

The full name. Optional.

codeDocStorage

String

The doc storage code.

codeOperation

String

The operation code. Optional.

1.4.3. Get DocStorageTypeActivities

A GET request for DocStorageTypeActivities.

Required TYPE_ACTIVITY_WAREHOUSE_OPERATIONS_VIEW(130,3) role.

Curl request
$ curl 'http://localhost:8801/api/doc-storages/doc-storage-type-activities' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/doc-storages/doc-storage-type-activities HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 394

[{"id":1,"fullName":"Лесохозяйственная деятельность","shortName":"Лесохозяйственная"},{"id":2,"fullName":"Коммерческая деятельность","shortName":"Коммерческая"},{"id":6,"fullName":"ЛХ/Коммерческая деятельность","shortName":"Лесохозяйственная/Коммерческая"}]
Response fields-
Path Type Description

id

Number

The DocStorageTypeActivity id.

shortName

String

The short name.

fullName

String

The full name. Optional.

1.4.4. Get BasisDocumentTypes

A GET request for BasisDocumentTypes.

Required TYPE_OF_DOCUMENT_REASONS_FOR_OPERATION_VIEW(112,3) role.

Curl request
$ curl 'http://localhost:8801/api/doc-storages/basis-document-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/doc-storages/basis-document-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1613

[{"id":1,"fullName":"Договор купли-продажи","shortName":"Договор купли-продажи","externalCode":"02"},{"id":2,"fullName":"Приказ для проведения","shortName":"приказ"},{"id":3,"fullName":"Распоряжение директора","shortName":"Распоряжение директора"},{"id":4,"fullName":"Биржевой договор","shortName":"Биржевой договор","externalCode":"03"},{"id":5,"fullName":"Прямой договор","shortName":"Прямой договор"},{"id":6,"fullName":"Договор комиссии","shortName":"Договор комиссии"},{"id":7,"fullName":"Договор \"Беллесэкспорт\"- покупатель","shortName":"Договор \"Беллесэкспорт\"- покупатель"},{"id":8,"fullName":"Заявление","shortName":"Заявление"},{"id":9,"fullName":"Обмер по ордеру","shortName":"Обмер по ордеру"},{"id":10,"fullName":"Распоряжение ответственного должностного лица","shortName":"Распоряжение ответственного должностного лица"},{"id":11,"fullName":"Сменный рапорт","shortName":"Сменный рапорт"},{"id":12,"fullName":"Гражданско-правовой договор","shortName":"Гражданско-правовой договор","externalCode":"01"},{"id":13,"fullName":"Дополнение к договору","shortName":"Дополнение к договору","externalCode":"05"}]
Response fields-
Path Type Description

id

Number

The BasisDocumentTypes id.

shortName

String

The short name.

fullName

String

The full name. Optional.

externalCode

String

The contract type in external systems like 1C. Optional.

1.5. Nomenclature

1.5.1. Get Nomenclature by ID

A GET request to get nomenclature by Nomenclature id.

Required ITEM_NOMENCLATURE_VIEW(301,3) role.

Curl request
$ curl 'http://localhost:8801/api/nomenclatures/612230' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/nomenclatures/612230 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/nomenclatures/{nomenclatureId}
Parameter Description

nomenclatureId

The id of nomenclature
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 273

{"id":612230,"nomenclatureName":"Балансы, Сосна, 2 м., 6-13 см, 3 сорт","productCode":"10031210001003046000","woodProductCategory":1,"unit":44,"determiningVolumeMethod":2,"woodGroupType":49,"woodDiameterGroup":12,"woodSort":3,"woodClass":691,"length":11}
Response fields
Path Type Description

id

Number

The id of Nomenclature.

nomenclatureName

String

The name of Nomenclature.

productCode

String

20 digits code starts with '10' for logging. Optional.

woodProductCategory

Number

The WoodProductCategory id of Nomenclature. Optional.

determiningVolumeMethod

Number

The DeterminingVolumeMethod id of Nomenclature. Optional.

woodGroupType

Number

The WoodGroupType id of Nomenclature.

woodDiameterGroup

Number

The WoodDiameterGroup id of Nomenclature. Optional.

woodDiameter

Number

The WoodDiameter id of Nomenclature. Optional.

woodSort

Number

The WoodSort id of Nomenclature. Optional.

woodClass

Number

The WoodClass id of Nomenclature. Optional.

unit

Number

The Unit id of Nomenclature. Optional.

length

Number

The Length id of Nomenclature. Optional.

woodWhipClass

Number

The WoodWhipClass id of Nomenclature. Optional.

1.5.2. Get WoodProductCategories

A GET request to get all WoodProductCategories.

Required CATEGORY_PRODUCT_VIEW(114,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-product-categories' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-product-categories HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 268

[{"id":1,"fullName":"Деловая древесина","shortName":"Дел"},{"id":2,"fullName":"Дровяная древесена","shortName":"Др"},{"id":3,"fullName":"Хлысты","shortName":"Хлысты"},{"id":11,"fullName":"Нел","shortName":"Нел"}]
Response fields-
Path Type Description

id

Number

The WoodProductCategory id.

fullName

String

The full name of WoodProductCategory. Optional.

shortName

String

The short name of WoodProductCategory.

1.5.3. Get DeterminingVolumeMethods

A GET request to get all DeterminingVolumeMethods.

Required METHOD_DEFINITION_VOLUME_VIEW(109,3) role.

Curl request
$ curl 'http://localhost:8801/api/determining-volume-methods' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/determining-volume-methods HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 269

[{"id":1,"fullName":"Поштучный","shortName":"Поштучный","rounding":3},{"id":2,"fullName":"Групповой","shortName":"Групповой","rounding":2},{"id":3,"fullName":"Объемный метод","shortName":"Объемный","rounding":3}]
Response fields-
Path Type Description

id

Number

The DeterminingVolumeMethod id.

fullName

String

The full name of DeterminingVolumeMethod. Optional.

shortName

String

The short name of DeterminingVolumeMethod.

rounding

Number

The rounding of DeterminingVolumeMethod. Optional.

1.5.4. Get WoodDiameterGroups

A GET request to get all WoodDiameterGroups.

Required GROUPS_DIAMETERS_VIEW(104,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-diameter-groups' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-diameter-groups HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 6290

[{"id":1,"fullName":"14-24 см","shortName":"14-24 см","diameterGroupCode":24,"minimumValue":14,"maximumValue":24,"enabled":true},{"id":2,"fullName":"26-38 см","shortName":"26-38 см","diameterGroupCode":33,"minimumValue":26,"maximumValue":38,"enabled":true},{"id":3,"fullName":"16-28 см","shortName":"16-28 см","diameterGroupCode":27,"minimumValue":16,"maximumValue":28,"enabled":true},{"id":4,"fullName":"14-18 см","shortName":"14-18 см","diameterGroupCode":13,"minimumValue":14,"maximumValue":18,"enabled":true},{"id":5,"fullName":"20-24 см","shortName":"20-24 см","diameterGroupCode":14,"minimumValue":20,"maximumValue":24,"enabled":true},{"id":6,"fullName":"10-13 см","shortName":"10-13 см","diameterGroupCode":18,"minimumValue":10,"maximumValue":13,"enabled":true},{"id":7,"fullName":"26 и более см","shortName":"26 и более см","diameterGroupCode":30,"minimumValue":26,"maximumValue":999,"enabled":true},{"id":8,"fullName":"14 и более см","shortName":"14 и более см","diameterGroupCode":11,"minimumValue":14,"maximumValue":999,"enabled":true},{"id":9,"fullName":"26-34 см","shortName":"26-34 см","diameterGroupCode":32,"minimumValue":26,"maximumValue":34,"enabled":true},{"id":10,"fullName":"36 и более см","shortName":"36 и более см","diameterGroupCode":38,"minimumValue":36,"maximumValue":999,"enabled":true},{"id":11,"fullName":"6-18 см","shortName":"6-18 см","diameterGroupCode":12,"minimumValue":6,"maximumValue":18,"enabled":true},{"id":12,"fullName":"6-13 см","shortName":"6-13 см","diameterGroupCode":46,"minimumValue":6,"maximumValue":13,"enabled":true},{"id":13,"fullName":"18-24 см","shortName":"18-24 см","diameterGroupCode":28,"minimumValue":18,"maximumValue":24,"enabled":true},{"id":14,"fullName":"32 и более см","shortName":"32 и более см","diameterGroupCode":36,"minimumValue":32,"maximumValue":999,"enabled":true},{"id":15,"fullName":"24 и более см","shortName":"24 и более см","diameterGroupCode":53,"minimumValue":24,"maximumValue":999,"enabled":true},{"id":16,"fullName":"18 и более см","shortName":"18 и более см","diameterGroupCode":62,"minimumValue":18,"maximumValue":999,"enabled":true},{"id":17,"fullName":"16-24 см","shortName":"16-24 см","diameterGroupCode":27,"minimumValue":16,"maximumValue":24,"enabled":true},{"id":18,"fullName":"16 и более см","shortName":"16 и более см","diameterGroupCode":61,"minimumValue":16,"maximumValue":999,"enabled":true},{"id":19,"fullName":"6-24 см","shortName":"6-24 см","diameterGroupCode":15,"minimumValue":6,"maximumValue":24,"enabled":true},{"id":20,"fullName":"10-24 см","shortName":"10-24 см","diameterGroupCode":63,"minimumValue":10,"maximumValue":24,"enabled":true},{"id":21,"fullName":"6-20 см","shortName":"6-20 см","diameterGroupCode":64,"minimumValue":6,"maximumValue":20,"enabled":true},{"id":22,"fullName":"26-40 см","shortName":"26-40 см","diameterGroupCode":33,"minimumValue":26,"maximumValue":40,"enabled":true},{"id":23,"fullName":"6-40 см","shortName":"6-40 см","diameterGroupCode":16,"minimumValue":6,"maximumValue":40,"enabled":true},{"id":24,"fullName":"12-13 см","shortName":"12-13 см","diameterGroupCode":21,"minimumValue":12,"maximumValue":13,"enabled":true},{"id":25,"fullName":"8-11 см","shortName":"8-11 см","diameterGroupCode":50,"minimumValue":8,"maximumValue":11,"enabled":true},{"id":26,"fullName":"26-32 см","shortName":"26-32 см","diameterGroupCode":31,"minimumValue":26,"maximumValue":32,"enabled":true},{"id":27,"fullName":"7-13 см","shortName":"7-13 см","diameterGroupCode":48,"minimumValue":7,"maximumValue":13,"enabled":true},{"id":28,"fullName":"4 и более см","shortName":"4 и более см","diameterGroupCode":54,"minimumValue":4,"maximumValue":999,"enabled":true},{"id":29,"fullName":"4-13 см","shortName":"4-13 см","diameterGroupCode":40,"minimumValue":4,"maximumValue":13,"enabled":true},{"id":30,"fullName":"3-7 см","shortName":"3-7 см","diameterGroupCode":34,"minimumValue":3,"maximumValue":7,"enabled":true},{"id":31,"fullName":"6-80 см","shortName":"6-80 см","diameterGroupCode":16,"minimumValue":6,"maximumValue":80,"enabled":true},{"id":32,"fullName":"0-0 см","shortName":"0-0 см","diameterGroupCode":0,"minimumValue":0,"maximumValue":999,"enabled":false},{"id":33,"fullName":"105-140 мм","shortName":"105-140 мм","diameterGroupCode":56,"minimumValue":105,"maximumValue":140,"enabled":false},{"id":34,"fullName":"60-100 мм","shortName":"60-100 мм","diameterGroupCode":55,"minimumValue":60,"maximumValue":100,"enabled":false},{"id":35,"fullName":"25-30 мм","shortName":"25-30 мм","diameterGroupCode":6,"minimumValue":25,"maximumValue":30,"enabled":false},{"id":36,"fullName":"100-125 мм","shortName":"100-125 мм","diameterGroupCode":9,"minimumValue":100,"maximumValue":125,"enabled":false},{"id":37,"fullName":"19-35 мм","shortName":"19-35 мм","diameterGroupCode":205,"minimumValue":19,"maximumValue":35,"enabled":false},{"id":38,"fullName":"40-60 см","shortName":"40-60 см","diameterGroupCode":59,"minimumValue":40,"maximumValue":60,"enabled":true},{"id":39,"fullName":"4-40 см","shortName":"4-40 см","diameterGroupCode":94,"minimumValue":4,"maximumValue":40,"enabled":true},{"id":40,"fullName":"7-24 см","shortName":"7-24 см","diameterGroupCode":0,"minimumValue":7,"maximumValue":24,"enabled":true},{"id":41,"fullName":"6-14 см","shortName":"6-14 см","diameterGroupCode":0,"minimumValue":6,"maximumValue":14,"enabled":true},{"id":42,"fullName":"14-25 см","shortName":"14-25 см","diameterGroupCode":93,"minimumValue":14,"maximumValue":25,"enabled":true},{"id":44,"fullName":"14-60 тест","shortName":"14-60 тест","diameterGroupCode":0,"minimumValue":14,"maximumValue":60,"enabled":false},{"id":45,"fullName":"до 13 см","shortName":"до 13 см","diameterGroupCode":82,"minimumValue":0,"maximumValue":13,"enabled":true},{"id":46,"fullName":"3 и более см","shortName":"3 и более см","diameterGroupCode":0,"minimumValue":3,"maximumValue":999,"enabled":true},{"id":47,"fullName":"5-14 см","shortName":"5-14 см","diameterGroupCode":115,"minimumValue":5,"maximumValue":14,"enabled":true}]
Response fields-
Path Type Description

id

Number

The WoodDiameterGroup id.

fullName

String

The full name of WoodDiameterGroup. Optional.

shortName

String

The short name of WoodDiameterGroup. Optional.

diameterGroupCode

Number

The Code 1C of WoodDiameterGroup.

minimumValue

Number

The minimumValue of WoodDiameterGroup.

maximumValue

Number

The maximumValue of WoodDiameterGroup.

enabled

Boolean

Is WoodDiameterGroup enabled.

1.5.5. Get WoodDiameters

A GET request to get all WoodDiameters.

Required DIAMETERS_WOOD_VIEW(103,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-diameters' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-diameters HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 9975

[{"id":1,"fullName":"Диаметр 3 см","shortName":"3 см","diameterValue":3,"dateOn":"1970-01-01","dateOff":"2019-06-30","productCode":"3"},{"id":2,"fullName":"Диаметр 4 см","shortName":"4 см","diameterValue":4,"dateOn":"1970-01-01","dateOff":"2019-07-07","productCode":"4"},{"id":3,"fullName":"Диаметр 5 см","shortName":"5 см","diameterValue":5,"dateOn":"1970-01-01","dateOff":"2019-06-27","productCode":"5"},{"id":5,"fullName":"Диаметр 6 см","shortName":"6 см","diameterValue":6,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"6"},{"id":6,"fullName":"Диаметр 7 см","shortName":"7 см","diameterValue":7,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"7"},{"id":7,"fullName":"Диаметр 8 см","shortName":"8 см","diameterValue":8,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"8"},{"id":8,"fullName":"Диаметр 9 см","shortName":"9 см","diameterValue":9,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"9"},{"id":9,"fullName":"Диаметр 10 см","shortName":"10 см","diameterValue":10,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"10"},{"id":10,"fullName":"Диаметр 11 см","shortName":"11 см","diameterValue":11,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"11"},{"id":11,"fullName":"Диаметр 12 см","shortName":"12 см","diameterValue":12,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"12"},{"id":12,"fullName":"Диаметр 13 см","shortName":"13 см","diameterValue":13,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"13"},{"id":13,"fullName":"Диаметр 14 см","shortName":"14 см","diameterValue":14,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"14"},{"id":14,"fullName":"Диаметр 16 см","shortName":"16 см","diameterValue":16,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"16"},{"id":15,"fullName":"Диаметр 18 см","shortName":"18 см","diameterValue":18,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"18"},{"id":16,"fullName":"Диаметр 20 см","shortName":"20 см","diameterValue":20,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"20"},{"id":17,"fullName":"Диаметр 34 см","shortName":"34 см","diameterValue":34,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"34"},{"id":18,"fullName":"Диаметр 22 см","shortName":"22 см","diameterValue":22,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"22"},{"id":19,"fullName":"Диаметр 24 см","shortName":"24 см","diameterValue":24,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"24"},{"id":20,"fullName":"Диаметр 26 см","shortName":"26 см","diameterValue":26,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"26"},{"id":21,"fullName":"Диаметр 28 см","shortName":"28 см","diameterValue":28,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"28"},{"id":22,"fullName":"Диаметр 30 см","shortName":"30 см","diameterValue":30,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"30"},{"id":23,"fullName":"Диаметр 32 см","shortName":"32 см","diameterValue":32,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"32"},{"id":24,"fullName":"Диаметр 36 см","shortName":"36 см","diameterValue":36,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"36"},{"id":25,"fullName":"Диаметр 38 см","shortName":"38 см","diameterValue":38,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"38"},{"id":26,"fullName":"Диаметр 40 см","shortName":"40 см","diameterValue":40,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"40"},{"id":27,"fullName":"Диаметр 42 см","shortName":"42 см","diameterValue":42,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"42"},{"id":28,"fullName":"Диаметр 44 см","shortName":"44 см","diameterValue":44,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"44"},{"id":29,"fullName":"Диаметр 46 см","shortName":"46 см","diameterValue":46,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"46"},{"id":30,"fullName":"Диаметр 48 см","shortName":"48 см","diameterValue":48,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"48"},{"id":31,"fullName":"Диаметр 50 см","shortName":"50 см","diameterValue":50,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"50"},{"id":32,"fullName":"Диаметр 52 см","shortName":"52 см","diameterValue":52,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"52"},{"id":33,"fullName":"Диаметр 54 см","shortName":"54 см","diameterValue":54,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"54"},{"id":34,"fullName":"Диаметр 56 см","shortName":"56 см","diameterValue":56,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"56"},{"id":35,"fullName":"Диаметр 58 см","shortName":"58 см","diameterValue":58,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"58"},{"id":36,"fullName":"Диаметр 60 см","shortName":"60 см","diameterValue":60,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"60"},{"id":37,"fullName":"Диаметр 62 см","shortName":"62 см","diameterValue":62,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"62"},{"id":38,"fullName":"Диаметр 64 см","shortName":"64 см","diameterValue":64,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"64"},{"id":39,"fullName":"Диаметр 66 см","shortName":"66 см","diameterValue":66,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"66"},{"id":40,"fullName":"Диаметр 68 см","shortName":"68 см","diameterValue":68,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"68"},{"id":41,"fullName":"Диаметр 70 см","shortName":"70 см","diameterValue":70,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"70"},{"id":42,"fullName":"Диаметр 72 см","shortName":"72 см","diameterValue":72,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"72"},{"id":43,"fullName":"Диаметр 74 см","shortName":"74 см","diameterValue":74,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"74"},{"id":44,"fullName":"Диаметр 76 см","shortName":"76 см","diameterValue":76,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"76"},{"id":45,"fullName":"Диаметр 78 см","shortName":"78 см","diameterValue":78,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"78"},{"id":46,"fullName":"Диаметр 80 см","shortName":"80 см","diameterValue":80,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"80"},{"id":47,"fullName":"Диаметр 82 см","shortName":"82 см","diameterValue":82,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"82"},{"id":48,"fullName":"Диаметр 84 см","shortName":"84 см","diameterValue":84,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"84"},{"id":49,"fullName":"Диаметр 86 см","shortName":"86 см","diameterValue":86,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"86"},{"id":50,"fullName":"Диаметр 88 см","shortName":"88 см","diameterValue":88,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"88"},{"id":51,"fullName":"Диаметр 90 см","shortName":"90 см","diameterValue":90,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"90"},{"id":52,"fullName":"Диаметр 92 см","shortName":"92 см","diameterValue":92,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"92"},{"id":53,"fullName":"Диаметр 94 см","shortName":"94 см","diameterValue":94,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"94"},{"id":54,"fullName":"Диаметр 96 см","shortName":"96 см","diameterValue":96,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"96"},{"id":55,"fullName":"Диаметр 98 см","shortName":"98 см","diameterValue":98,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"98"},{"id":56,"fullName":"Диаметр 100 см","shortName":"100 см","diameterValue":100,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"100"},{"id":57,"fullName":"Диаметр 102 см","shortName":"102 см","diameterValue":102,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"102"},{"id":58,"fullName":"Диаметр 104 см","shortName":"104 см","diameterValue":104,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"104"},{"id":59,"fullName":"Диаметр 106 см","shortName":"106 см","diameterValue":106,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"106"},{"id":60,"fullName":"Диаметр 108 см","shortName":"108 см","diameterValue":108,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"108"},{"id":61,"fullName":"Диаметр 110 см","shortName":"110 см","diameterValue":110,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"110"},{"id":62,"fullName":"Диаметр 112 см","shortName":"112 см","diameterValue":112,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"112"},{"id":63,"fullName":"Диаметр 114 см","shortName":"114 см","diameterValue":114,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"114"},{"id":64,"fullName":"Диаметр 116 см","shortName":"116 см","diameterValue":116,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"116"},{"id":65,"fullName":"Диаметр 118 см","shortName":"118 см","diameterValue":118,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"118"},{"id":66,"fullName":"Диаметр 120 см","shortName":"120 см","diameterValue":120,"dateOn":"1970-01-01","dateOff":"2100-01-01","productCode":"120"},{"id":67,"fullName":"Диаметр 25 см","shortName":"25 см","diameterValue":25,"dateOn":"2020-05-25","dateOff":"2020-05-25","productCode":"25"}]
Response fields-
Path Type Description

id

Number

The WoodDiameter id.

fullName

String

The full name of WoodDiameter.

shortName

String

The short name of WoodDiameter. Optional.

diameterValue

Number

The diameterValue of WoodDiameter. Optional.

dateOn

String

The start date of WoodDiameter.

dateOff

String

The expiration date of WoodDiameter. Optional.

productCode

String

The productCode WoodDiameter. Optional.

1.5.6. Get WoodSorts

A GET request to get all WoodSorts.

Required VARIETIES_VIEW(113,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-sorts' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-sorts HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1915

[{"id":1,"fullName":"1 сорт","shortName":"1 сорт","code":1,"productCode":"1","typeStandard":0,"sortCode":1},{"id":2,"fullName":"2 сорт","shortName":"2 сорт","code":1,"productCode":"2","typeStandard":0,"sortCode":2},{"id":3,"fullName":"3 сорт","shortName":"3 сорт","code":1,"productCode":"3","typeStandard":0,"sortCode":3},{"id":4,"fullName":"Без сорта","shortName":"без сорта","code":0,"productCode":"0","typeStandard":0,"sortCode":0},{"id":10,"fullName":"I группа качества","shortName":"I группа","code":2,"productCode":"21","typeStandard":0,"sortCode":6},{"id":11,"fullName":"II группа качества","shortName":"II группа","code":2,"productCode":"22","typeStandard":0,"sortCode":7},{"id":12,"fullName":"III группа качества","shortName":"III группа","code":2,"productCode":"23","typeStandard":0,"sortCode":8},{"id":13,"fullName":"IV группа качества","shortName":"IV группа","code":2,"productCode":"24","typeStandard":0,"sortCode":24},{"id":25,"fullName":"Не определено","shortName":"нет","code":0,"productCode":"0","typeStandard":1,"sortCode":0},{"id":26,"fullName":"A","shortName":"A","code":1,"productCode":"4","typeStandard":1,"sortCode":27},{"id":27,"fullName":"B","shortName":"B","code":1,"productCode":"5","typeStandard":1,"sortCode":28},{"id":28,"fullName":"C","shortName":"C","code":1,"productCode":"6","typeStandard":1,"sortCode":29},{"id":29,"fullName":"D","shortName":"D","code":1,"productCode":"7","typeStandard":1,"sortCode":30},{"id":33,"fullName":"B, C","shortName":"B, C","code":1,"productCode":"33","typeStandard":1,"sortCode":33},{"id":35,"fullName":"1, 2, 3 сорт","shortName":"1,2,3 сорт","code":1,"productCode":"35","typeStandard":0,"sortCode":35},{"id":50,"fullName":"C, D","shortName":"C, D","code":1,"productCode":"32","typeStandard":1,"sortCode":32}]
Response fields-
Path Type Description

id

Number

The WoodSort id.

fullName

String

The full name of WoodSort.

shortName

String

The short name of WoodSort.

code

Number

The code of WoodSort.

productCode

String

The productCode of WoodSort. Optional.

typeStandard

Number

The typeStandard of WoodSort. Optional.

sortCode

Number

The Code 1C of WoodSort.

1.5.7. Get WoodClasses

A GET request to get all WoodClasses.

Required WOOD_VARIETIES_VIEW(102,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-classes' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-classes HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 6162

[{"id":684,"fullName":"Пиловочное бревно","shortName":"Пиловочное бревно","code":100,"productCode":"100","determiningVolumeMethod":1,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":1},{"id":685,"fullName":"Шпальное бревно","shortName":"Шпальное бревно","code":101,"productCode":"101","determiningVolumeMethod":1,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":2},{"id":686,"fullName":"Лесоматериалы для оцилиндровки изделий","shortName":"Лесоматериалы для оцилиндровки изделий","code":102,"productCode":"102","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":3},{"id":687,"fullName":"Лесоматериалы для оцилиндровки срубов","shortName":"Лесоматериалы для оцилиндровки срубов","code":103,"productCode":"103","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":4},{"id":688,"fullName":"Фанерное бревно","shortName":"Фанерное бревно","code":104,"productCode":"104","determiningVolumeMethod":1,"minimumLength":1.3,"maximumLength":10.0,"woodSortsType":1,"classesCode":5},{"id":690,"fullName":"Спичечное бревно","shortName":"Спичечное бревно","code":106,"productCode":"106","determiningVolumeMethod":1,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":7},{"id":691,"fullName":"Балансы","shortName":"Балансы","code":107,"productCode":"107","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":312},{"id":692,"fullName":"Строительное бревно","shortName":"Строительное бревно","code":108,"productCode":"108","determiningVolumeMethod":1,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":4},{"id":693,"fullName":"Подтоварник","shortName":"Подтоварник","code":109,"productCode":"109","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":10},{"id":694,"fullName":"Рудстойка","shortName":"Рудстойка","code":110,"productCode":"110","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":11},{"id":695,"fullName":"Техсырье","shortName":"Техсырье","code":111,"productCode":"111","determiningVolumeMethod":2,"minimumLength":2.0,"maximumLength":4.0,"woodSortsType":1,"classesCode":12},{"id":696,"fullName":"Хлысты древесные","shortName":"Хлысты древесные","code":112,"productCode":"112","determiningVolumeMethod":2,"minimumLength":2.0,"maximumLength":34.0,"woodSortsType":2,"classesCode":13},{"id":698,"fullName":"Дрова","shortName":"Дрова","code":114,"productCode":"114","determiningVolumeMethod":2,"minimumLength":0.25,"maximumLength":4.0,"woodSortsType":0,"industrialFire":2,"classesCode":15},{"id":701,"fullName":"Лесоматериалы круглые гр","shortName":"Лесоматериалы круглые","code":117,"productCode":"117","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":0,"industrialFire":1,"classesCode":80},{"id":718,"fullName":"Балансы для экспорта","shortName":"Балансы для экспорта","code":134,"productCode":"134","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":138},{"id":719,"fullName":"Техсырье экспортное","shortName":"Техсырье экспортное","code":135,"productCode":"135","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":139},{"id":720,"fullName":"Стойки для ж/д вагонов","shortName":"Стойки для ж/д вагонов","code":136,"productCode":"136","determiningVolumeMethod":2,"minimumLength":1.5,"maximumLength":13.5,"woodSortsType":1,"classesCode":261},{"id":857,"fullName":"Лесоматериалы круглые шт","shortName":"Лесоматериалы круглые","code":117,"productCode":"","determiningVolumeMethod":1,"minimumLength":1.0,"maximumLength":13.5,"woodSortsType":0,"classesCode":80},{"id":858,"fullName":"Хлысты древесные шт.","shortName":"Хлысты древесные","code":112,"productCode":"","determiningVolumeMethod":1,"minimumLength":2.0,"maximumLength":34.0,"woodSortsType":2,"classesCode":13},{"id":859,"fullName":"Фанерное бревно для лущения","shortName":"Фанерное бревно для лущения","code":105,"productCode":"","determiningVolumeMethod":1,"minimumLength":1.3,"maximumLength":10.0,"woodSortsType":1,"classesCode":6},{"id":861,"fullName":"Крона(ликвид)","shortName":"Крона(ликвид)","code":137,"productCode":"137","determiningVolumeMethod":-1,"minimumLength":0.25,"maximumLength":4.0,"woodSortsType":0,"industrialFire":3,"classesCode":104},{"id":862,"fullName":"Лесоматериалы для выработки целлюлозы и древесной массы","shortName":"Лесоматериалы для целлюлозы и древесной массы","code":107,"productCode":"107","determiningVolumeMethod":2,"minimumLength":0.75,"maximumLength":6.5,"woodSortsType":1,"classesCode":8},{"id":863,"fullName":"Лесоматериалы для распиловки и строгания","shortName":"Лесоматериалы для распиловки и строгания","code":100,"productCode":"100","determiningVolumeMethod":1,"minimumLength":1.0,"maximumLength":6.5,"woodSortsType":1,"classesCode":328},{"id":864,"fullName":"Лесоматериалы для выработки шпона","shortName":"Лесоматериалы для выработки шпона","code":104,"productCode":"104","determiningVolumeMethod":1,"minimumLength":1.3,"maximumLength":6.5,"woodSortsType":1,"classesCode":327}]
Response fields-
Path Type Description

id

Number

The WoodClass id.

fullName

String

The full name of WoodClass.

shortName

String

The short name of WoodClass. Optional.

code

Number

The code of WoodClass.

productCode

String

The productCode of WoodClass. Optional.

determiningVolumeMethod

Number

The determiningVolumeMethod id[1-3].

minimumLength

Number

The minimumLength of WoodClass. Optional.

maximumLength

Number

The maximumLength of WoodClass. Optional.

woodSortsType

Number

The WoodSortsType id of WoodClass[0-2].

industrialFire

Number

Sign for operational accounting. Optional

classesCode

Number

The Code 1C of WoodClass.

1.5.8. Get WoodSortTypes

A GET request to get all WoodSortTypes.

Required WOOD_VARIETIES_VIEW(102,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-sorts-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-sorts-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 218

[{"id":0,"fullName":"Сортовая древесина с включением бессортовой"},{"id":1,"fullName":"Сортовая древесина"},{"id":2,"fullName":"Хлысты древесные"}]
Response fields-
Path Type Description

id

Number

The WoodSortsType id.

fullName

String

The full name of WoodSortsType.

shortName

String

The short name of WoodSortsType. Optional.

1.5.9. Get Units

A GET request to get all Units.

Required UNITS_VIEW(100,3) role.

Curl request
$ curl 'http://localhost:8801/api/units' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/units HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 772

[{"id":16,"fullName":"Сантиметр","shortName":"см","code":1},{"id":17,"fullName":"Километр","shortName":"км","code":2},{"id":18,"fullName":"Метр","shortName":"м","code":3},{"id":29,"fullName":"Литр","shortName":"л","code":11},{"id":31,"fullName":"Тонна","shortName":"т","code":10},{"id":44,"fullName":"Метр кубический","shortName":"м3","code":12},{"id":45,"fullName":"Штуки","shortName":"шт","code":13},{"id":46,"fullName":"Килограмм","shortName":"кг","code":14},{"id":47,"fullName":"Метр квадратный","shortName":"м2","code":15},{"id":48,"fullName":"Погонный метр","shortName":"пог.м","code":16},{"id":49,"fullName":"Комплект","shortName":"компл.","code":17}]
Response fields-
Path Type Description

id

Number

The Unit id.

fullName

String

The full name of Unit.

shortName

String

The short name of Unit.

code

Number

The code of WoodSort. Optional.

1.5.10. Get Lengths

A GET request to get all Lengths.

Required LENGTHS_PRODUCTS_VIEW(110,3) role.

Curl request
$ curl 'http://localhost:8801/api/lengths' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/lengths HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 15831

[{"id":1,"shortName":"1 м.","lengthValue":1.0},{"id":2,"shortName":"1,2 м.","lengthValue":1.2},{"id":3,"shortName":"1,1 м.","lengthValue":1.1},{"id":4,"shortName":"1,3 м.","lengthValue":1.3},{"id":5,"shortName":"1,4 м.","lengthValue":1.4},{"id":6,"shortName":"1,5 м.","lengthValue":1.5},{"id":7,"shortName":"1,6 м.","lengthValue":1.6},{"id":8,"shortName":"1,7 м.","lengthValue":1.7},{"id":9,"shortName":"1,8 м.","lengthValue":1.8},{"id":10,"shortName":"1,9 м.","lengthValue":1.9},{"id":11,"shortName":"2 м.","lengthValue":2.0},{"id":12,"shortName":"2,1 м.","lengthValue":2.1},{"id":13,"shortName":"2,2 м.","lengthValue":2.2},{"id":14,"shortName":"2,25 м.","lengthValue":2.25},{"id":15,"shortName":"2,3 м.","lengthValue":2.3},{"id":16,"shortName":"2,4 м.","lengthValue":2.4},{"id":17,"shortName":"2,5 м.","lengthValue":2.5},{"id":18,"shortName":"2,6 м.","lengthValue":2.6},{"id":19,"shortName":"2,7 м.","lengthValue":2.7},{"id":20,"shortName":"2,75 м.","lengthValue":2.75},{"id":21,"shortName":"2,8 м.","lengthValue":2.8},{"id":22,"shortName":"2,9 м.","lengthValue":2.9},{"id":23,"shortName":"3 м.","lengthValue":3.0},{"id":24,"shortName":"3,1 м.","lengthValue":3.1},{"id":25,"shortName":"3,2 м.","lengthValue":3.2},{"id":26,"shortName":"3,25 м.","lengthValue":3.25},{"id":27,"shortName":"3,3 м.","lengthValue":3.3},{"id":28,"shortName":"3,4 м.","lengthValue":3.4},{"id":29,"shortName":"3,5 м.","lengthValue":3.5},{"id":30,"shortName":"3,6 м.","lengthValue":3.6},{"id":31,"shortName":"3,7 м.","lengthValue":3.7},{"id":32,"shortName":"3,75 м.","lengthValue":3.75},{"id":33,"shortName":"3,8 м.","lengthValue":3.8},{"id":34,"shortName":"3,9 м.","lengthValue":3.9},{"id":35,"shortName":"4 м.","lengthValue":4.0},{"id":36,"shortName":"4,1 м.","lengthValue":4.1},{"id":37,"shortName":"4,2 м.","lengthValue":4.2},{"id":38,"shortName":"4,25 м.","lengthValue":4.25},{"id":39,"shortName":"4,3 м.","lengthValue":4.3},{"id":40,"shortName":"4,4 м.","lengthValue":4.4},{"id":41,"shortName":"4,5 м.","lengthValue":4.5},{"id":42,"shortName":"4,6 м.","lengthValue":4.6},{"id":43,"shortName":"4,7 м.","lengthValue":4.7},{"id":44,"shortName":"4,75 м.","lengthValue":4.75},{"id":45,"shortName":"4,8 м.","lengthValue":4.8},{"id":46,"shortName":"4,9 м.","lengthValue":4.9},{"id":47,"shortName":"5 м.","lengthValue":5.0},{"id":48,"shortName":"5,1 м.","lengthValue":5.1},{"id":49,"shortName":"5,2 м.","lengthValue":5.2},{"id":50,"shortName":"5,25 м.","lengthValue":5.25},{"id":51,"shortName":"5,3 м.","lengthValue":5.3},{"id":52,"shortName":"5,4 м.","lengthValue":5.4},{"id":53,"shortName":"5,5 м.","lengthValue":5.5},{"id":54,"shortName":"5,6 м.","lengthValue":5.6},{"id":55,"shortName":"5,7 м.","lengthValue":5.7},{"id":56,"shortName":"5,75 м.","lengthValue":5.75},{"id":57,"shortName":"5,8 м.","lengthValue":5.8},{"id":58,"shortName":"5,9 м.","lengthValue":5.9},{"id":59,"shortName":"6 м.","lengthValue":6.0},{"id":60,"shortName":"6,1 м.","lengthValue":6.1},{"id":61,"shortName":"6,2 м.","lengthValue":6.2},{"id":62,"shortName":"6,25 м.","lengthValue":6.25},{"id":63,"shortName":"6,3 м.","lengthValue":6.3},{"id":64,"shortName":"6,4 м.","lengthValue":6.4},{"id":65,"shortName":"6,5 м.","lengthValue":6.5},{"id":66,"shortName":"6,6 м.","lengthValue":6.6},{"id":67,"shortName":"6,7 м.","lengthValue":6.7},{"id":68,"shortName":"6,75 м.","lengthValue":6.75},{"id":69,"shortName":"6,8 м.","lengthValue":6.8},{"id":70,"shortName":"6,9 м.","lengthValue":6.9},{"id":71,"shortName":"7 м.","lengthValue":7.0},{"id":72,"shortName":"7,1 м.","lengthValue":7.1},{"id":73,"shortName":"7,2 м.","lengthValue":7.2},{"id":74,"shortName":"7,25 м.","lengthValue":7.25},{"id":75,"shortName":"7,3 м.","lengthValue":7.3},{"id":76,"shortName":"7,4 м.","lengthValue":7.4},{"id":77,"shortName":"7,5 м.","lengthValue":7.5},{"id":78,"shortName":"7,6 м.","lengthValue":7.6},{"id":79,"shortName":"7,7 м.","lengthValue":7.7},{"id":80,"shortName":"7,75 м.","lengthValue":7.75},{"id":81,"shortName":"7,8 м.","lengthValue":7.8},{"id":82,"shortName":"7,9 м.","lengthValue":7.9},{"id":83,"shortName":"8 м.","lengthValue":8.0},{"id":84,"shortName":"8,1 м.","lengthValue":8.1},{"id":85,"shortName":"8,2 м.","lengthValue":8.2},{"id":86,"shortName":"8,25 м.","lengthValue":8.25},{"id":87,"shortName":"8,3 м.","lengthValue":8.3},{"id":88,"shortName":"8,4 м.","lengthValue":8.4},{"id":89,"shortName":"8,5 м.","lengthValue":8.5},{"id":90,"shortName":"8,6 м.","lengthValue":8.6},{"id":91,"shortName":"8,7 м.","lengthValue":8.7},{"id":92,"shortName":"8,75 м.","lengthValue":8.75},{"id":93,"shortName":"8,8 м.","lengthValue":8.8},{"id":94,"shortName":"8,9 м.","lengthValue":8.9},{"id":95,"shortName":"9 м.","lengthValue":9.0},{"id":96,"shortName":"9,1 м.","lengthValue":9.1},{"id":97,"shortName":"9,2 м.","lengthValue":9.2},{"id":98,"shortName":"9,25 м.","lengthValue":9.25},{"id":99,"shortName":"9,3 м.","lengthValue":9.3},{"id":100,"shortName":"9,4 м.","lengthValue":9.4},{"id":101,"shortName":"9,5 м.","lengthValue":9.5},{"id":102,"shortName":"10 м.","lengthValue":10.0},{"id":103,"shortName":"10,5 м.","lengthValue":10.5},{"id":104,"shortName":"11 м.","lengthValue":11.0},{"id":105,"shortName":"11,5 м.","lengthValue":11.5},{"id":106,"shortName":"12 м.","lengthValue":12.0},{"id":107,"shortName":"12,5 м.","lengthValue":12.5},{"id":108,"shortName":"13 м.","lengthValue":13.0},{"id":109,"shortName":"13,5 м.","lengthValue":13.5},{"id":113,"shortName":"14 м","lengthValue":14.0},{"id":114,"shortName":"17 м","lengthValue":17.0},{"id":115,"shortName":"15 м","lengthValue":15.0},{"id":116,"shortName":"16 м","lengthValue":16.0},{"id":117,"shortName":"18 м","lengthValue":18.0},{"id":118,"shortName":"19 м","lengthValue":19.0},{"id":119,"shortName":"20 м","lengthValue":20.0},{"id":120,"shortName":"25 м","lengthValue":25.0},{"id":121,"shortName":"21 м","lengthValue":21.0},{"id":122,"shortName":"22 м","lengthValue":22.0},{"id":123,"shortName":"23 м","lengthValue":23.0},{"id":124,"shortName":"24 м","lengthValue":24.0},{"id":125,"shortName":"1,91 м.","lengthValue":1.91},{"id":126,"shortName":"2,23 м.","lengthValue":2.23},{"id":127,"shortName":"1,65 м","lengthValue":1.65},{"id":128,"shortName":"1,75 м","lengthValue":1.75},{"id":129,"shortName":"11,10 м.","lengthValue":11.1},{"id":130,"shortName":"11,20 м.","lengthValue":11.2},{"id":131,"shortName":"11,30 м.","lengthValue":11.3},{"id":132,"shortName":"11,40 м.","lengthValue":11.4},{"id":133,"shortName":"11,60 м.","lengthValue":11.6},{"id":134,"shortName":"11,70 м.","lengthValue":11.7},{"id":135,"shortName":"11,80 м.","lengthValue":11.8},{"id":136,"shortName":"11,90 м.","lengthValue":11.9},{"id":137,"shortName":"12,10 м.","lengthValue":12.1},{"id":138,"shortName":"12,20 м.","lengthValue":12.2},{"id":139,"shortName":"12,30 м.","lengthValue":12.3},{"id":140,"shortName":"12,40 м.","lengthValue":12.4},{"id":141,"shortName":"12,60 м.","lengthValue":12.6},{"id":142,"shortName":"12,70 м.","lengthValue":12.7},{"id":143,"shortName":"12,80 м.","lengthValue":12.8},{"id":144,"shortName":"12,90 м.","lengthValue":12.9},{"id":145,"shortName":"13,10 м.","lengthValue":13.1},{"id":146,"shortName":"13,20 м.","lengthValue":13.2},{"id":147,"shortName":"13,30 м.","lengthValue":13.3},{"id":148,"shortName":"13,40 м.","lengthValue":13.4},{"id":149,"shortName":"13,60 м.","lengthValue":13.6},{"id":150,"shortName":"13,70 м.","lengthValue":13.7},{"id":151,"shortName":"13,80 м.","lengthValue":13.8},{"id":152,"shortName":"13,90 м.","lengthValue":13.9},{"id":153,"shortName":"10,10 м.","lengthValue":10.1},{"id":154,"shortName":"10,20 м.","lengthValue":10.2},{"id":155,"shortName":"10,30 м.","lengthValue":10.3},{"id":156,"shortName":"10,40 м.","lengthValue":10.4},{"id":157,"shortName":"10,60 м.","lengthValue":10.6},{"id":158,"shortName":"10,70 м.","lengthValue":10.7},{"id":159,"shortName":"10,80 м.","lengthValue":10.8},{"id":160,"shortName":"10,90 м.","lengthValue":10.9},{"id":161,"shortName":"14,10 м.","lengthValue":14.1},{"id":162,"shortName":"14,20 м.","lengthValue":14.2},{"id":163,"shortName":"14,30 м.","lengthValue":14.3},{"id":164,"shortName":"14,40 м.","lengthValue":14.4},{"id":165,"shortName":"14,50 м.","lengthValue":14.5},{"id":166,"shortName":"14,60 м.","lengthValue":14.6},{"id":167,"shortName":"14,70 м.","lengthValue":14.7},{"id":168,"shortName":"14,80 м.","lengthValue":14.8},{"id":169,"shortName":"14,90 м.","lengthValue":14.9},{"id":170,"shortName":"15,10 м.","lengthValue":15.1},{"id":171,"shortName":"15,20 м.","lengthValue":15.2},{"id":172,"shortName":"15,30 м.","lengthValue":15.3},{"id":173,"shortName":"15,40 м.","lengthValue":15.4},{"id":174,"shortName":"15,50 м.","lengthValue":15.5},{"id":175,"shortName":"15,60 м.","lengthValue":15.6},{"id":176,"shortName":"15,70 м.","lengthValue":15.7},{"id":177,"shortName":"15,80 м.","lengthValue":15.8},{"id":178,"shortName":"15,90 м.","lengthValue":15.9},{"id":179,"shortName":"16,10 м.","lengthValue":16.1},{"id":180,"shortName":"16,20 м.","lengthValue":16.2},{"id":181,"shortName":"16,30 м.","lengthValue":16.3},{"id":182,"shortName":"16,40 м.","lengthValue":16.4},{"id":183,"shortName":"16,50 м.","lengthValue":16.5},{"id":184,"shortName":"16,60 м.","lengthValue":16.6},{"id":185,"shortName":"16,70 м.","lengthValue":16.7},{"id":186,"shortName":"16,80 м.","lengthValue":16.8},{"id":187,"shortName":"16,90 м.","lengthValue":16.9},{"id":188,"shortName":"17,10 м.","lengthValue":17.1},{"id":189,"shortName":"17,20 м.","lengthValue":17.2},{"id":190,"shortName":"17,30 м.","lengthValue":17.3},{"id":191,"shortName":"17,40 м.","lengthValue":17.4},{"id":192,"shortName":"17,50 м.","lengthValue":17.5},{"id":193,"shortName":"17,60 м.","lengthValue":17.6},{"id":194,"shortName":"17,70 м.","lengthValue":17.7},{"id":195,"shortName":"17,80 м.","lengthValue":17.8},{"id":196,"shortName":"17,90 м.","lengthValue":17.9},{"id":197,"shortName":"18,10 м.","lengthValue":18.1},{"id":198,"shortName":"18,20 м.","lengthValue":18.2},{"id":199,"shortName":"18,30 м.","lengthValue":18.3},{"id":200,"shortName":"18,40 м.","lengthValue":18.4},{"id":201,"shortName":"18,50 м.","lengthValue":18.5},{"id":202,"shortName":"18,60 м.","lengthValue":18.6},{"id":203,"shortName":"18,70 м.","lengthValue":18.7},{"id":204,"shortName":"18,80 м.","lengthValue":18.8},{"id":205,"shortName":"18,90 м.","lengthValue":18.9},{"id":206,"shortName":"19,10 м.","lengthValue":19.1},{"id":207,"shortName":"19,20 м.","lengthValue":19.2},{"id":208,"shortName":"19,30 м.","lengthValue":19.3},{"id":209,"shortName":"19,40 м.","lengthValue":19.4},{"id":210,"shortName":"19,50 м.","lengthValue":19.5},{"id":211,"shortName":"19,60 м.","lengthValue":19.6},{"id":212,"shortName":"19,70 м.","lengthValue":19.7},{"id":213,"shortName":"19,80 м.","lengthValue":19.8},{"id":214,"shortName":"19,90 м.","lengthValue":19.9},{"id":215,"shortName":"20,10 м.","lengthValue":20.1},{"id":216,"shortName":"20,20 м.","lengthValue":20.2},{"id":217,"shortName":"20,30 м.","lengthValue":20.3},{"id":218,"shortName":"20,40 м.","lengthValue":20.4},{"id":219,"shortName":"20,50 м.","lengthValue":20.5},{"id":220,"shortName":"20,60 м.","lengthValue":20.6},{"id":221,"shortName":"20,70 м.","lengthValue":20.7},{"id":222,"shortName":"20,80 м.","lengthValue":20.8},{"id":223,"shortName":"20,90 м.","lengthValue":20.9},{"id":224,"shortName":"21,10 м.","lengthValue":21.1},{"id":225,"shortName":"21,20 м.","lengthValue":21.2},{"id":226,"shortName":"21,30 м.","lengthValue":21.3},{"id":227,"shortName":"21,40 м.","lengthValue":21.4},{"id":228,"shortName":"21,50 м.","lengthValue":21.5},{"id":229,"shortName":"21,60 м.","lengthValue":21.6},{"id":230,"shortName":"21,70 м.","lengthValue":21.7},{"id":231,"shortName":"21,80 м.","lengthValue":21.8},{"id":232,"shortName":"21,90 м.","lengthValue":21.9},{"id":233,"shortName":"22,10 м.","lengthValue":22.1},{"id":234,"shortName":"22,20 м.","lengthValue":22.2},{"id":235,"shortName":"22,30 м.","lengthValue":22.3},{"id":236,"shortName":"22,40 м.","lengthValue":22.4},{"id":237,"shortName":"22,50 м.","lengthValue":22.5},{"id":238,"shortName":"22,60 м.","lengthValue":22.6},{"id":239,"shortName":"22,70 м.","lengthValue":22.7},{"id":240,"shortName":"22,80 м.","lengthValue":22.8},{"id":241,"shortName":"22,90 м.","lengthValue":22.9},{"id":242,"shortName":"23,10 м.","lengthValue":23.1},{"id":243,"shortName":"23,20 м.","lengthValue":23.2},{"id":244,"shortName":"23,30 м.","lengthValue":23.3},{"id":245,"shortName":"23,40 м.","lengthValue":23.4},{"id":246,"shortName":"23,50 м.","lengthValue":23.5},{"id":247,"shortName":"23,60 м.","lengthValue":23.6},{"id":248,"shortName":"23,70 м.","lengthValue":23.7},{"id":249,"shortName":"23,80 м.","lengthValue":23.8},{"id":250,"shortName":"23,90 м.","lengthValue":23.9},{"id":251,"shortName":"24,10 м.","lengthValue":24.1},{"id":252,"shortName":"24,20 м.","lengthValue":24.2},{"id":253,"shortName":"24,30 м.","lengthValue":24.3},{"id":254,"shortName":"24,40 м.","lengthValue":24.4},{"id":255,"shortName":"24,50 м.","lengthValue":24.5},{"id":256,"shortName":"24,60 м.","lengthValue":24.6},{"id":257,"shortName":"24,70 м.","lengthValue":24.7},{"id":258,"shortName":"24,80 м.","lengthValue":24.8},{"id":259,"shortName":"24,90 м.","lengthValue":24.9},{"id":260,"shortName":"25,10 м.","lengthValue":25.1},{"id":261,"shortName":"25,20 м.","lengthValue":25.2},{"id":262,"shortName":"25,30 м.","lengthValue":25.3},{"id":263,"shortName":"25,40 м.","lengthValue":25.4},{"id":264,"shortName":"25,50 м.","lengthValue":25.5},{"id":265,"shortName":"25,60 м.","lengthValue":25.6},{"id":266,"shortName":"25,70 м.","lengthValue":25.7},{"id":267,"shortName":"25,80 м.","lengthValue":25.8},{"id":268,"shortName":"25,90 м.","lengthValue":25.9},{"id":269,"shortName":"26,00 м.","lengthValue":26.0},{"id":270,"shortName":"26,10 м.","lengthValue":26.1},{"id":271,"shortName":"26,20 м.","lengthValue":26.2},{"id":272,"shortName":"26,30 м.","lengthValue":26.3},{"id":273,"shortName":"26,40 м.","lengthValue":26.4},{"id":274,"shortName":"26,50 м.","lengthValue":26.5},{"id":275,"shortName":"26,60 м.","lengthValue":26.6},{"id":276,"shortName":"26,70 м.","lengthValue":26.7},{"id":277,"shortName":"26,80 м.","lengthValue":26.8},{"id":278,"shortName":"26,90 м.","lengthValue":26.9},{"id":279,"shortName":"27,00 м.","lengthValue":27.0},{"id":280,"shortName":"27,10 м.","lengthValue":27.1},{"id":281,"shortName":"27,20 м.","lengthValue":27.2},{"id":282,"shortName":"27,30 м.","lengthValue":27.3},{"id":283,"shortName":"27,40 м.","lengthValue":27.4},{"id":284,"shortName":"27,50 м.","lengthValue":27.5},{"id":285,"shortName":"27,60 м.","lengthValue":27.6},{"id":286,"shortName":"27,70 м.","lengthValue":27.7},{"id":287,"shortName":"27,80 м.","lengthValue":27.8},{"id":288,"shortName":"27,90 м.","lengthValue":27.9},{"id":289,"shortName":"28,00 м.","lengthValue":28.0},{"id":290,"shortName":"28,10 м.","lengthValue":28.1},{"id":291,"shortName":"28,20 м.","lengthValue":28.2},{"id":292,"shortName":"28,30 м.","lengthValue":28.3},{"id":293,"shortName":"28,40 м.","lengthValue":28.4},{"id":294,"shortName":"28,50 м.","lengthValue":28.5},{"id":295,"shortName":"28,60 м.","lengthValue":28.6},{"id":296,"shortName":"28,70 м.","lengthValue":28.7},{"id":297,"shortName":"28,80 м.","lengthValue":28.8},{"id":298,"shortName":"28,90 м.","lengthValue":28.9},{"id":299,"shortName":"29,00 м.","lengthValue":29.0},{"id":300,"shortName":"0,25 м.","lengthValue":0.25},{"id":301,"shortName":"0,33 м.","lengthValue":0.33},{"id":302,"shortName":"0,50 м.","lengthValue":0.5},{"id":303,"shortName":"0,75 м.","lengthValue":0.75},{"id":304,"shortName":"2,15 м.","lengthValue":2.15},{"id":305,"shortName":"0,8 м.","lengthValue":0.8}]
Response fields-
Path Type Description

id

Number

The Length id.

shortName

String

The short name of Length.

lengthValue

Number

The value of Length.

1.5.11. Get WoodWhipClasses

A GET request to get all WoodWhipClasses.

Required DISCHARGE_WHIPLASH_VIEW(121,3) role.

Curl request
$ curl 'http://localhost:8801/api/wood-whip-classes' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wood-whip-classes HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 293

[{"id":1,"fullName":"I","shortName":"I"},{"id":2,"fullName":"II","shortName":"II"},{"id":3,"fullName":"III","shortName":"III"},{"id":4,"fullName":"IV","shortName":"IV"},{"id":5,"fullName":"V","shortName":"V"},{"id":8,"fullName":"1a","shortName":"1a"},{"id":9,"fullName":"Va","shortName":"Va"}]
Response fields-
Path Type Description

id

Number

The WoodWhipClass id.

fullName

String

The full name of WoodWhipClass. Optional.

shortName

String

The short name of WoodWhipClass.

1.6. Employees

1.6.1. Get Employee

A GET request to get employee by organization id and employee id. Employee must belong User’s organization and received organization.

Required EMPLOYEES_VIEW(202,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/3045/employees/46697' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/3045/employees/46697 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/{organizationId}/employees/{employeeId}
Parameter Description

organizationId

The id of Organization.

employeeId

The id of Employee.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 199

{"id":46697,"post":39,"lastName":"Тестовый","firstName":"Google","middleName":"Play","prettyShortName":"Тестовый G.P.","organization":3045,"dateRecruitment":"2023-01-01","users":null}
Response fields
Path Type Description

id

Number

The id of Employee.

lastName

String

The last name of Employee. Optional.

firstName

String

The first name of Employee. Optional

middleName

String

The middle name of Employee. Optional.

prettyShortName

String

The short name of Employee. Optional.

tabNumber

String

The personal number of Employee. Optional.

dateRecruitment

String

The LocalDate of hiring Employee. Optional.

dateDismissal

String

The LocalDate of dismissal Employee. Optional.

1.6.2. Get Employees

A GET request to get all employees of organization. Response fields are the same as in the previous request.

Required EMPLOYEES_VIEW(202,3) role.

/api/organizations/{organizationId}/employees

GET /api/organizations/3030/employees HTTP/1.1
Authorization: 9D412264A84416A6B2626AEEF78AA199DEBA9BA7
Host: localhost:8801

1.7. Get User

A GET request to find user details by organization id and user id. User must belong User’s organization and received organization. The result excludes password and token.

Required USERS_VIEW(215,3) role.

Curl request

$ curl 'http://localhost:8801/api/organizations/3045/users/21940' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'

HTTP request

GET /api/organizations/3045/users/21940 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801

Request headers

Name Description

Authorization

(User) token

Path parameters

Table 1. /api/organizations/{organizationId}/users/{userId}
Parameter Description

organizationId

The id of Organization

userId

The id of User

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 232

{"id":21940,"login":"dummy","firstName":"Google","middleName":"Play","lastName":"Тестовый","prettyShortName":"Тестовый G.P.","firstActivityDate":"2024-03-28T12:05:57.602","lastActivityDate":"2024-03-28T12:06:56.196"}

Response fields

Path Type Description

id

Number

User id.

login

String

User login.

shortName

String

User shortName.

firstName

String

User firstName.

middleName

String

User middleName.

lastName

String

User lastName.

prettyShortName

String

User prettyShortName.

dateBlock

String

Null if user enabled or LocalDate of disabling.

firstActivityDate

String

LocalDateTime of first activity.

lastActivityDate

String

LocalDateTime of last activity.

1.8. Storages

1.8.1. Get Storage

A GET request to get storage for organization. Organization must belong to the User.

Required WAREHOUSES_VIEW(302,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/3046/storages/627608' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/3046/storages/627608 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/{organizationId}/storages/{storageId}
Parameter Description

organizationId

The id of Organization.

storageId

The id of Storage.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 380

{"id":627608,"quarter":"33","outlined":"48","geoLatitude":53.8745,"geoLongitude":27.5035,"dateOn":"2022-12-09","dateOff":"2023-09-01","isWork":false,"isWoodRadiation":false,"fioWoodUse":"Иванов И.И.","departmentId":40,"operationsStorages":null,"activityKind":2,"shortName":"ФВС кв.33, выд.48 (ЛС кв.12, выд.18,20, №1)","organization":3046,"storageType":1}
Response fields
Path Type Description

id

Number

The id of Storage.

shortName

String

The full name of Storage.

quarter

String

The quarter of Storage. Optional.

outlined

String

The outlined of Storage. Optional.

addressStorage

String

The address of Storage. Optional.

storageType

Number

The Id of Storage type[1-10]. Optional.

activityKind

Number

The id of activity kind[1,2,6]. Optional.

geoLatitude

Number

The latitude of storage. Optional.

geoLongitude

Number

The longitude of storage. Optional.

dateOn

String

Storage opening LocalDate.

dateOff

String

Storage closing LocalDate. Optional.

isWork

Boolean

True when storage is working. Optional.

isWoodRadiation

Boolean

True when wood is hardened in a radioactive zone. Optional.

fioWoodUse

String

The full name of forest user. Optional.

departmentId

Number

The Department Id. Optional.

1.8.2. Get Storages

A GET request to get storages for organization. Organization must belong to the User.
Response fields are the same as in the previous request plus optional cuttingAreaId

It is strongly recommended to call this request only after 1.8.3(Get invalid Storages)
For example /api/organizations/{organizationId}/storages/invalid returns:
* [] then /api/organizations/{organizationId}/storages
* [250959,256305] then /api/organizations/{organizationId}/storages?except=250959,256305

Error codes:
403 "Forbidden" in case of given storage does not belong to any of user’s organizations.
409 "Conflict" when there are more than 1 cutting areas for storage.

Required WAREHOUSES_VIEW(302,3) role.

/api/organizations/{organizationId}/storages
optional request parameter except comma separated storageId

GET /api/organizations/3030/storages HTTP/1.1
Authorization: 9D412264A84416A6B2626AEEF78AA199DEBA9BA7
Host: localhost:8801

1.8.3. Get invalid Storages

A GET request to get invalid storages ids for organization. Returns empty array [] when all storages are valid.

Organization must belong to the User.

Required WAREHOUSES_VIEW(302,3) role.

Curl request
$ curl 'http://localhost:8801/api/organizations/3046/storages/invalid' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/organizations/3046/storages/invalid HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/organizations/{organizationId}/storages/invalid
Parameter Description

organizationId

The id of Organization.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2

[]

1.9. Labels

1.9.1. Get Labels

A GET request provides all labels for current user organizations(departments) view scope.

All parameters are mandatory. Date range must be within a month.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels?dateStart=2021-02-01&dateEnd=2021-02-05&statusId=1' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels?dateStart=2021-02-01&dateEnd=2021-02-05&statusId=1 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Query parameters
Parameter Description

dateStart

LocalDate of start period.

dateEnd

LocalDate of end period.

statusId

Label status id.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1123

[{"id":332991,"labelNumber":"A099900000131","departmentId":38,"statusId":1},{"id":332992,"labelNumber":"A099900000132","departmentId":38,"statusId":1},{"id":332993,"labelNumber":"A099900000133","departmentId":38,"statusId":1},{"id":332994,"labelNumber":"A099900000134","departmentId":38,"statusId":1},{"id":332995,"labelNumber":"A099900000135","departmentId":38,"statusId":1},{"id":332996,"labelNumber":"A099900000136","departmentId":38,"statusId":1},{"id":332997,"labelNumber":"A099900000137","departmentId":38,"statusId":1},{"id":332998,"labelNumber":"A099900000138","departmentId":38,"statusId":1},{"id":332999,"labelNumber":"A099900000139","departmentId":38,"statusId":1},{"id":333000,"labelNumber":"A099900000140","departmentId":38,"statusId":1},{"id":333001,"labelNumber":"A099900000141","departmentId":38,"statusId":1},{"id":333002,"labelNumber":"A099900000142","departmentId":38,"statusId":1},{"id":333003,"labelNumber":"A099900000143","departmentId":38,"statusId":1},{"id":333004,"labelNumber":"A099900000144","departmentId":38,"statusId":1},{"id":356647,"labelNumber":"A999000155","departmentId":38,"statusId":1}]
Response fields-
Path Type Description

id

Number

The id of Label.

labelNumber

String

The number of label. Optional.

organizationId

Number

The Organization id of label holder. Optional.

departmentId

Number

The department id of label holder. Optional.

userId

Number

The User id of label holder. Optional.

statusId

Number

The id of status[1-7].

1.9.2. Get Labels for Organization

A GET request provides labels by organizationId, (optionally) statusId within the date range.

Date range must be within a year. if statusId is missing returns labels with all statuses.

Returns 403 "Forbidden" in case of organization does not belong to user.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels/organizations/3046?dateStart=2021-03-24&dateEnd=2021-04-15&statusId=4' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels/organizations/3046?dateStart=2021-03-24&dateEnd=2021-04-15&statusId=4 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/labels/organizations/{organizationId}
Parameter Description

organizationId

The id of Organization
Query parameters
Parameter Description

dateStart

LocalDate of start period.

dateEnd

LocalDate of end period.

statusId

Label status id. Optional. Labels with all statuses if missing.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 955

[{"id":332988,"labelNumber":"999000152","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":332989,"labelNumber":"999000153","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":332990,"labelNumber":"999000154","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606789,"labelNumber":"999000155","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606790,"labelNumber":"999000156","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606791,"labelNumber":"999000157","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606792,"labelNumber":"999000158","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606793,"labelNumber":"999000159","organizationId":3046,"departmentId":38,"userId":138,"statusId":4},{"id":606794,"labelNumber":"999000160","organizationId":3046,"departmentId":38,"userId":138,"statusId":4}]

Response fields are the same as in 1.9.1

1.9.3. Get Labels for Department

A GET request provides labels by departmentId, (optionally) statusId within the date range.

Date range must be within a year. if statusId is missing returns labels with all statuses.

Returns 403 "Forbidden" in case of department does not belong to user.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels/departments/38?dateStart=2022-01-10&dateEnd=2022-01-11&statusId=3' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels/departments/38?dateStart=2022-01-10&dateEnd=2022-01-11&statusId=3 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/labels/departments/{departmentId}
Parameter Description

departmentId

The id of Department
Query parameters
Parameter Description

dateStart

LocalDate of start period.

dateEnd

LocalDate of end period.

statusId

Label status id. Optional. Labels with all statuses if missing.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1091

[{"id":2392428,"labelNumber":"999001201","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392429,"labelNumber":"999001202","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392430,"labelNumber":"999001203","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392431,"labelNumber":"999001204","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392432,"labelNumber":"999001205","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392433,"labelNumber":"999001206","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392434,"labelNumber":"999001207","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392435,"labelNumber":"999001208","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392436,"labelNumber":"999001209","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3},{"id":2392437,"labelNumber":"999001210","organizationId":3051,"departmentId":38,"userId":11527,"statusId":3}]

Response fields are the same as in 1.9.1

1.9.4. Get Label by ID

A GET request to get label by id.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels/336523' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels/336523 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/labels/{id}
Parameter Description

id

The id of Label
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 71

{"id":336523,"labelNumber":"A999000155","departmentId":38,"statusId":7}

Response fields are the same as in 1.9.1

1.9.5. Get LabelStatuses

A GET request to get all labels statuses.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels/statuses' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels/statuses HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 328

[{"id":7,"statusName":"Удалена"},{"id":1,"statusName":"Свободна"},{"id":2,"statusName":"Закреплена"},{"id":3,"statusName":"Распределена"},{"id":4,"statusName":"Использована"},{"id":5,"statusName":"Аннулирована"},{"id":6,"statusName":"Зарезервирована"}]
Response fields-
Path Type Description

id

Number

The Label Status id.

statusName

String

The Label Status name.

1.9.6. Get LabelSeries

A GET request to get all labels series.

Required TAGS_VIEW(318,3) role.

Curl request
$ curl 'http://localhost:8801/api/labels/series' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/labels/series HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 55

[{"id":1,"seriesName":"A"},{"id":2,"seriesName":"---"}]
Response fields-
Path Type Description

id

Number

The Label Series id.

seriesName

String

The Label Series name.

1.10. CuttingAreas

1.10.1. Get CuttingAreaStatuses

A GET request to get all statuses for cutting areas.

Required LESOSKI_VIEW(205,3) role.

Curl request
$ curl 'http://localhost:8801/api/cutting-areas/statuses' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/cutting-areas/statuses HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 183

[{"id":1,"statusName":"Доступна"},{"id":2,"statusName":"Действующая"},{"id":3,"statusName":"Завершена"},{"id":4,"statusName":"Заблокирована"}]
Response fields-
Path Type Description

id

Number

The Status id

statusName

String

The Status name

1.10.2. Get CuttingArea for Storage

A GET request to get cutting area by storageId.

Error codes:
403 "Forbidden" in case of given storage does not belong to any of user’s organizations.
404 "Not Found" when there is no cutting area for given storage.
409 "Conflict" when there are more than 1 cutting areas.
412 "Precondition Failed" when there is no such storage.

Required LESOSKI_VIEW(205,3) role.

Curl request
$ curl 'http://localhost:8801/api/cutting-areas/storages/627608' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/cutting-areas/storages/627608 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/cutting-areas/storages/{storageId}
Parameter Description

storageId

The id of Storage.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 228

{"id":360859,"numberCuttingArea":"1","numberQuarter":"12","numberTaxation":"18,20","yardage":1.5,"woodGroupType":4,"woodGroupTypeMain":7,"cuttingAreaStatus":3,"determiningVolumeProcess":1,"dateStart":"2022-12-09","isWork":false}
Response fields
Path Type Description

id

Number

The id of CuttingArea.

numberCuttingArea

String

The number of CuttingArea. Optional.

numberQuarter

String

The number of quarter. Optional.

numberTaxation

String

The number of section. Optional.

yardage

Number

The cutting area. Optional.

woodGroupType

Number

The WoodGroupType id[2-302]. Optional.

woodGroupTypeMain

Number

The MainWoodGroupType id[2-302]. Optional.

cuttingAreaStatus

Number

The Status id[1-4]. Optional.

determiningVolumeProcess

Number

The DeterminingVolumeProcess id[1-3]. Optional.

woodDocTypePermitMake

Number

The WoodDocTypePermitMake id[1-11]. Optional.

dateStart

String

The LocalDate of start. Optional.

isWork

Boolean

True when CuttingArea is working. Optional.

1.10.3. Get CuttingAreas for Organization

A GET request to get cutting areas by organization. Organization must belong to the User. Response fields are the same as in the previous request.

Required LESOSKI_VIEW(205,3) role.

/api/organizations/{organizationId}/cutting-areas

GET /api/organizations/2879/cutting-areas HTTP/1.1
Authorization: 9D412264A84416A6B2626AEEF78AA199DEBA9BA7
Host: localhost:8801

1.11. WoodDocs

1.11.1. Get ActivityKinds

A GET request to get all ActivityKinds for WoodDoc.

Required TYPE_ACTIVITY_VIEW(108,3) role.

Curl request
$ curl 'http://localhost:8801/api/activity-kinds' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/activity-kinds HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 394

[{"id":1,"fullName":"Лесохозяйственная деятельность","shortName":"Лесохозяйственная"},{"id":2,"fullName":"Коммерческая деятельность","shortName":"Коммерческая"},{"id":6,"fullName":"ЛХ/Коммерческая деятельность","shortName":"Лесохозяйственная/Коммерческая"}]
Response fields-
Path Type Description

id

Number

The ActivityKind id.

fullName

String

The full name of ActivityKind. Optional.

shortName

String

The short name of ActivityKind.

1.11.2. Get DeterminingVolumeProcesses

A GET request to get all DeterminingVolumeProcesses.

Required METHOD_OF_DETERMINING_CHOP_VOLUME_VIEW(116,3) role.

Curl request
$ curl 'http://localhost:8801/api/determining-volume-processes' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/determining-volume-processes HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 618

[{"id":1,"fullName":"по числу деревьев, назначаемых в рубку","shortName":"По пням","percentExcessCutting":10},{"id":2,"fullName":"по площади","shortName":"По площади","percentExcessCutting":10},{"id":3,"fullName":"по количеству заготовленной древесины","shortName":"По количеству","percentExcessCutting":20},{"id":4,"fullName":"по количеству заготовленной древесины на буреломах","shortName":"По количеству на буреломах","percentExcessCutting":50}]
Response fields-
Path Type Description

id

Number

The DeterminingVolumeProcess id.

fullName

String

The full name of DeterminingVolumeProcess. Optional.

shortName

String

The short name of DeterminingVolumeProcess.

percentExcessCutting

Number

Exceeding felling percentage.

1.11.3. Get FellingTypes

A GET request to get all FellingTypes for WoodDoc.

Required TYPES_OF_USE_AND_CHOP_TYPES_VIEW(207,3) role.

Curl request
$ curl 'http://localhost:8801/api/felling-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/felling-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 18023

[{"id":1,"fullName":"главного пользования","shortName":"главного пользования","code":1,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false},{"id":2,"fullName":"промежуточного пользования","shortName":"промежуточного пользования","code":2,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false},{"id":3,"fullName":"прочие рубки","shortName":"прочие рубки","code":3,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false},{"id":4,"fullName":"сплошная","shortName":"сплошная","code":1210,"dateOn":"2019-06-11","checkWoodGroupTypeMain":true,"parent":1},{"id":5,"fullName":"группово-постепенная 2-х приемная","shortName":"группово-постепенная 2","code":1220,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":6,"fullName":"длительно-постепенная 2-х приемная","shortName":"длительно-постепенная 2","code":1320,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":7,"fullName":"добровольно-выборочная","shortName":"добровольно-выборочная","code":1250,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":8,"fullName":"рубки в зоне загрязн. 15-40 ku/km2","shortName":"рубки в зоне загрязн. 15-40 ku/km2","code":1260,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":9,"fullName":"полосно-постепенная 2-х приемная","shortName":"полосно-постепенная 2","code":1290,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":10,"fullName":"равномерно-постепенная 2-х приемная","shortName":"равномерно-постепенная 2","code":1240,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":1},{"id":11,"fullName":"осветление","shortName":"осветление","code":1450,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":12,"fullName":"прочистка","shortName":"прочистка","code":1460,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":13,"fullName":"прореживание","shortName":"прореживание","code":1470,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":14,"fullName":"проходные рубки","shortName":"проходные рубки","code":1480,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":15,"fullName":"выборочная санитарная рубка","shortName":"выборочная санитарная рубка","code":2080,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":16,"fullName":"рубки реконструкции","shortName":"рубки реконструкции","code":1430,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":17,"fullName":"рубка обновления и переформирования ( переформирования)","shortName":"рубка обновления и переформирования","code":1440,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":2},{"id":18,"fullName":"сплошные санитарные рубки","shortName":"сплошные санитарные рубки","code":1810,"dateOn":"2019-06-11","checkWoodGroupTypeMain":true,"parent":3},{"id":19,"fullName":"уборка захламленности","shortName":"уборка захламленности","code":1820,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":22,"fullName":"рубки, проводимые в целях проведения подготовительных работ;","shortName":"рубки, проводимые в целях проведения подготовительных работ;","code":1860,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":23,"fullName":"рубки деревьев, являющихся промежуточными хозяевами вредителей и болезней лесов, по периметру существующих и проектируемых лесных питомников и лесосеменных плантаций","shortName":"рубки деревьев, являющихся промежуточными хозяевами вредителей и болезней лесов, по периметру сущест","code":1880,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":24,"fullName":"рубки деревьев, оставленных на лесосеке в целях воспроизводства лесов (семенных деревьев);","shortName":"рубки деревьев, оставленных на лесосеке в целях воспроизводства лесов (семенных деревьев);","code":1890,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":26,"fullName":"рубки деревьев на лесосеменных плантациях","shortName":"рубки деревьев на лесосеменных плантациях","code":1910,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":35,"fullName":"рубки деревьев при отводе лесосек, закладке пробных площадей, лесоустройстве, проведении лесопатологического мониторинга, осуществлении радиационного контроля в лесах","shortName":"рубки деревьев при отводе лесосек, закладке пробных площадей, лесоустройстве, проведении лесопатолог","code":2050,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":36,"fullName":"рубки деревьев при тушении лесных пожаров, ремонте и реконструкции лесохозяйственных дорог, мелиоративных систем; рубки деревьев при проведении научно-исследовательских, поисковых, геодезических работ","shortName":"рубки деревьев при тушении лесных пожаров, ремонте и реконструкции лесохозяйственных дорог, мелиорат","code":2060,"dateOn":"2019-06-11","checkWoodGroupTypeMain":false,"parent":3},{"id":41,"fullName":"группово-постепенная 3-х приемная","shortName":"группово-постепенная 3","code":1230,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":42,"fullName":"равномерно-постепенная 3-х приемная","shortName":"равномерно-постепенная 3","code":1280,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":43,"fullName":"полосно-постепенная 3-х приемная","shortName":"полосно-постепенная 3","code":1310,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":44,"fullName":"длительно-постепенная 3-х приемная","shortName":"длительно-постепенная 3-х приемная","code":1330,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":45,"fullName":"равномерно-постепенная 4-х приемная","shortName":"равномерно-постепенная 4","code":1340,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":46,"fullName":"полосно-постепенная 4-х приемная","shortName":"полосно-постепенная 4","code":1350,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":47,"fullName":"длительно-постепенная 4-х приемная","shortName":"длительно-постепенная 4","code":1360,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":48,"fullName":"группово-постепенная 4-х приемная","shortName":"группово-постепенная 4","code":1370,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":1},{"id":49,"fullName":"рубки проводимые при прокладке кварт. просек и их содержание","shortName":"рубки проводимые при прокладке кварт. просек и их содержание","code":1830,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":63,"fullName":"разрубка подъездных путей к лесосеке","shortName":"разрубка подъездных путей к лесосеке","code":1850,"dateOn":"2019-11-25","checkWoodGroupTypeMain":false,"parent":3},{"id":64,"fullName":"рубка плантационных лесных культур","shortName":"рубка плантационных лесных культур","code":1870,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":65,"fullName":"рубка леса при расчистке от лесных насаждений участков лесного фонда для строительства и содержания лесных питомников, лесосеменных плантаций, селекционно-генетических объектов, дорог, инженерных комм","shortName":"рубка леса при расчистке","code":1920,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":66,"fullName":"разрубка стрелковых линий","shortName":"разрубка стрелковых линий","code":1930,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":67,"fullName":"рубка деревьев для подкормки диких животных","shortName":"рубка деревьев для подкормки диких животных","code":1940,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":69,"fullName":"рубка деревьев, представляющих опасность для жизни граждан","shortName":"рубка деревьев, представляющих опасность для жизни граждан","code":1960,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":70,"fullName":"рубка единичных деревьев на лесных землях, не покрытых лесами","shortName":"рубка единичных деревьев на лесных землях, не покрытых лесами","code":1970,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":71,"fullName":"рубка единичных деревьев в пограничной полосе и пограничной зоне","shortName":"рубка единичных деревьев в пограничной полосе и пограничной зоне","code":1980,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":77,"fullName":"рубка опасных в отношении автомоб. дорог, воздушных линий связи и электропередач деревьев","shortName":"рубка опасных в отношении автомоб. дорог, воздушных линий связи и электропередач деревьев","code":1950,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":79,"fullName":"рубки деревьев при проведении научно-исследовательских, поисковых, геодезических работ","shortName":"рубки деревьев при проведении научно-исследовательских, поисковых, геодезических работ","code":2070,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":80,"fullName":"рубки леса, проводимые при проведении мероприятий по сохранению и восстановлению (реинтродукции) популяций диких животных и дикорастущих растений, относящихся к видам, включенным в Красную книгу Респу","shortName":"рубки леса, проводимые при проведении мероприятий по сохранению","code":2040,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":85,"fullName":"рубки малоценных лесных насаждений для заготовки древесины в топливно-энергетических целях","shortName":"рубки малоценных лесных насаждений для заготовки древесины в топливно-энергетических целях","code":2020,"dateOn":"2019-12-03","checkWoodGroupTypeMain":false,"parent":3},{"id":86,"fullName":"рубки проводимые при созд. противопож. разрывов и их содержание","shortName":"рубки проводимые при созд. противопож. разрывов и их содержание","code":2010,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":99,"fullName":"рубка полос растущих хвойных насаждений в вмежочаговом простр-ве и по опушкам усыхающих хвойных насаждений","shortName":"рубка растущих хвойных насаждени","code":1990,"dateOn":"2019-11-19","checkWoodGroupTypeMain":false,"parent":3},{"id":100,"fullName":"рубки леса, проводимые при проведении мероприятий по предотвращению зарастания открытых болот древесно-кустарниковой растительностью","shortName":"рубки леса при проведении мероприятий по предотвращению зарастания","code":2030,"dateOn":"2019-11-26","checkWoodGroupTypeMain":false,"parent":3},{"id":101,"fullName":"Рубка деревьев, мешающих прохождению лесовозной техники при вывозке","shortName":"Рубка деревьев, мешающих прохождению лесовозной техники при вывозке","code":1840,"dateOn":"2020-01-01","checkWoodGroupTypeMain":false,"parent":3},{"id":102,"fullName":"выборочная санитарная рубка по состоянию","shortName":"выборочная санитарная рубка по состоянию","code":2082,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":103,"fullName":"выборочная санитарная рубка в очагах корневой губки","shortName":"выборочная санитарная рубка в очагах корневой губки","code":2083,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":104,"fullName":"выборочная санитарная рубка опасных деревьев","shortName":"выборочная санитарная рубка опасных деревьев","code":2084,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":105,"fullName":"выборочная санитарная рубка свежезаселенных деревьев","shortName":"выборочная санитарная рубка свежезаселенных деревьев","code":2085,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":106,"fullName":"выборочная санитарная рубка ловчих деревьев","shortName":"выборочная санитарная рубка ловчих деревьев","code":2086,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":107,"fullName":"рубка деревьев и кустарников инвазивных видов","shortName":"рубка деревьев и кустарников инвазивных видов","code":2090,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":108,"fullName":"рубка леса, проводимые при удалении препятствий в виде лесных насаждений и (или) отдельных деревьев, представляющих угрозу для безопасности полетов воздушных судов","shortName":"рубка при удалении препятствий, представляющих угрозу для безопасности полетов","code":2110,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":109,"fullName":"рубка подлеска и (или) кустарника","shortName":"рубка подлеска и (или) кустарника","code":2120,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3},{"id":110,"fullName":"рубки деревьев и кустарников для ухода за растениями, относящимися к видам, включенным в Красную книгу РБ или охраняемым в соответствии с международными договорами РБ, и (или) их частей","shortName":"рубки для ухода за растениями, включенными в Красную книгу или охраняемым по международным договорам","code":2130,"dateOn":"2024-01-25","checkWoodGroupTypeMain":false,"parent":3}]
Response fields-
Path Type Description

id

Number

The FellingType id.

parent

Number

The parent id. Optional.

fullName

String

The full name of FellingType.

shortName

String

The short name of FellingType. Optional.

dateOn

String

The effective LocalDate of FellingType.

code

Number

The code of FellingType.

checkWoodGroupTypeMain

Boolean

True, when it is necessary to check whether any CuttingAreaSpecification has WoodGroupTypeMain.

1.11.4. Get StorageTypes

A GET request to get all StorageTypes.

Required WAREHOUSE_TYPES_VIEW(115,3) role.

Curl request
$ curl 'http://localhost:8801/api/storage-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/storage-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1273

[{"id":0,"fullName":"Франко-лесосека","shortName":"Франко-лесосека","storageCode":1},{"id":1,"fullName":"Франко-верхний лесосклад","shortName":"Франко-верхний лесосклад","storageCode":1},{"id":2,"fullName":"Промежуточный лесопромышленный склад","shortName":"Промежуточный лесопромышленный склад","storageCode":1},{"id":3,"fullName":"Цех деревообработки","shortName":"Цех деревообработки","storageCode":2},{"id":4,"fullName":"Лесопункт","shortName":"Лесопункт","storageCode":-2},{"id":7,"fullName":"Станция отгрузки","shortName":"Станция отгрузки","storageCode":2},{"id":8,"fullName":"Нижний склад","shortName":"Нижний склад","storageCode":2},{"id":10,"fullName":"Склад хранения","shortName":"Склад хранения","storageCode":2},{"id":11,"fullName":"Временный склад по случаю поломки ТС","shortName":"Временный склад поломки ТС","storageCode":2},{"id":12,"fullName":"Склад изъятия","shortName":"Склад изъятия","storageCode":2}]
Response fields-
Path Type Description

id

Number

The StorageType id.

fullName

String

The full name of StorageType. Optional.

shortName

String

The short name of StorageType.

storageCode

Number

The StorageType code [1-2].

1.11.5. Get WoodGroupTypes

A GET request to get all WoodGroupTypes.

Required TREE_SPECIES_AND_WOOD_GROUPS_VIEW(206,3) role.

Curl request
$ curl 'http://localhost:8801/api/wooddocs/group-types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wooddocs/group-types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 14453

[{"id":2,"fullName":"Хвойные","shortName":"ХВ","code":1,"dateOn":"2019-06-06","productCode":"1","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.8,"priority":999},{"id":3,"fullName":"Твердолиственные","shortName":"ТВ","code":2,"dateOn":"2019-06-06","productCode":"2","pieceMethod":false,"groupTypesCode":3,"weightCoefficient":1.0,"priority":999},{"id":4,"fullName":"Мягколиственные","shortName":"МЛ","code":3,"dateOn":"2019-06-06","productCode":"3","pieceMethod":false,"groupTypesCode":2,"weightCoefficient":0.9,"priority":999},{"id":5,"fullName":"Акация белая","shortName":"А","code":2,"dateOn":"2019-06-06","productCode":"1","pieceMethod":false,"groupTypesCode":281,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":6,"fullName":"Берест","shortName":"БР","code":2,"dateOn":"2019-06-06","productCode":"3","pieceMethod":false,"groupTypesCode":9999,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":7,"fullName":"Береза","shortName":"Б","code":3,"dateOn":"2019-06-06","productCode":"5","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":1.01,"priority":12,"parent":4},{"id":8,"fullName":"Береза бородавчатая","shortName":"ББ","code":3,"dateOn":"2019-06-26","productCode":"6","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":1.01,"priority":999,"parent":4},{"id":9,"fullName":"Береза пушистая","shortName":"БП","code":3,"dateOn":"2019-06-06","productCode":"7","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":1.01,"priority":999,"parent":4},{"id":10,"fullName":"Береза каменная","shortName":"БК","code":2,"dateOn":"2019-06-06","productCode":"8","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":1.01,"priority":999,"parent":3},{"id":11,"fullName":"Береза карельская","shortName":"БКР","code":3,"dateOn":"2019-06-06","productCode":"9","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":1.01,"priority":999,"parent":4},{"id":12,"fullName":"Бук","shortName":"БУК","code":2,"dateOn":"2019-06-06","productCode":"13","pieceMethod":true,"groupTypesCode":9999,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":13,"fullName":"Вяз","shortName":"В","code":2,"dateOn":"2019-06-06","productCode":"16","pieceMethod":false,"groupTypesCode":38,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":14,"fullName":"Вишня","shortName":"ВШ","code":3,"dateOn":"2019-06-06","productCode":"18","pieceMethod":false,"groupTypesCode":227,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":15,"fullName":"Граб","shortName":"Г","code":2,"dateOn":"2019-06-06","productCode":"19","pieceMethod":false,"groupTypesCode":12,"weightCoefficient":0.88,"priority":26,"parent":3},{"id":16,"fullName":"Дуб","shortName":"Д","code":2,"dateOn":"2019-06-06","productCode":"21","pieceMethod":true,"groupTypesCode":10,"weightCoefficient":1.01,"priority":20,"parent":3},{"id":17,"fullName":"Дуб летний","shortName":"ДЛ","code":2,"dateOn":"2019-06-06","productCode":"22","pieceMethod":true,"groupTypesCode":10,"weightCoefficient":1.01,"priority":999,"parent":3},{"id":18,"fullName":"Дуб низкоствольный","shortName":"ДН","code":2,"dateOn":"2019-06-06","productCode":"23","pieceMethod":true,"groupTypesCode":10,"weightCoefficient":1.01,"priority":999,"parent":3},{"id":19,"fullName":"Дуб черешчатый","shortName":"ДЧ","code":2,"dateOn":"2019-06-06","productCode":"24","pieceMethod":true,"groupTypesCode":10,"weightCoefficient":1.01,"priority":999,"parent":3},{"id":20,"fullName":"Дуб красный","shortName":"ДК","code":2,"dateOn":"2019-06-06","productCode":"25","pieceMethod":true,"groupTypesCode":186,"weightCoefficient":1.01,"priority":999,"parent":3},{"id":21,"fullName":"Ель","shortName":"Е","code":1,"dateOn":"2019-06-06","productCode":"27","pieceMethod":false,"groupTypesCode":2,"weightCoefficient":0.76,"priority":14,"parent":2},{"id":22,"fullName":"Ель европейская","shortName":"ЕЕ","code":1,"dateOn":"2019-06-06","productCode":"28","pieceMethod":false,"groupTypesCode":236,"weightCoefficient":0.76,"priority":999,"parent":2},{"id":23,"fullName":"Ель сибирская","shortName":"ЕС","code":1,"dateOn":"2019-06-06","productCode":"29","pieceMethod":false,"groupTypesCode":2,"weightCoefficient":0.76,"priority":999,"parent":2},{"id":24,"fullName":"Ива","shortName":"ИВ","code":3,"dateOn":"2019-06-06","productCode":"32","pieceMethod":false,"groupTypesCode":46,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":25,"fullName":"Ива ломкая","shortName":"ИВЛ","code":3,"dateOn":"2019-06-06","productCode":"34","pieceMethod":false,"groupTypesCode":46,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":26,"fullName":"Ива белая","shortName":"ИВБ","code":3,"dateOn":"2019-06-06","productCode":"35","pieceMethod":false,"groupTypesCode":46,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":27,"fullName":"Ива древовидная","shortName":"ИВД","code":3,"dateOn":"2019-06-06","productCode":"36","pieceMethod":false,"groupTypesCode":46,"weightCoefficient":0.88,"priority":30,"parent":4},{"id":28,"fullName":"Ива остролистная","shortName":"ИВО","code":3,"dateOn":"2019-06-06","productCode":"37","pieceMethod":false,"groupTypesCode":46,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":29,"fullName":"Чозения","shortName":"ЧЗ","code":3,"dateOn":"2019-06-06","dateOff":"2020-11-16","productCode":"38","pieceMethod":false,"groupTypesCode":9999,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":30,"fullName":"Ильм","shortName":"ИЛ","code":2,"dateOn":"2019-06-06","productCode":"39","pieceMethod":false,"groupTypesCode":9999,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":31,"fullName":"Клен","shortName":"КЛ","code":2,"dateOn":"2019-06-06","productCode":"41","pieceMethod":true,"groupTypesCode":9,"weightCoefficient":0.88,"priority":24,"parent":3},{"id":32,"fullName":"Клен полевой","shortName":"КЛП","code":2,"dateOn":"2019-06-06","productCode":"42","pieceMethod":true,"groupTypesCode":9,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":33,"fullName":"Клен остролистный","shortName":"КЛО","code":2,"dateOn":"2019-06-06","productCode":"43","pieceMethod":true,"groupTypesCode":9,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":34,"fullName":"Клен белый","shortName":"КЛБ","code":2,"dateOn":"2019-06-06","productCode":"44","pieceMethod":true,"groupTypesCode":9,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":35,"fullName":"Каштан","shortName":"КШ","code":2,"dateOn":"2019-06-06","productCode":"45","pieceMethod":false,"groupTypesCode":50,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":36,"fullName":"Кедр","shortName":"К","code":1,"dateOn":"2019-06-06","productCode":"47","pieceMethod":false,"groupTypesCode":51,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":37,"fullName":"Кедр сибирский","shortName":"КС","code":1,"dateOn":"2019-06-06","productCode":"48","pieceMethod":false,"groupTypesCode":192,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":38,"fullName":"Лиственница","shortName":"Л","code":1,"dateOn":"2019-06-06","productCode":"52","pieceMethod":false,"groupTypesCode":3,"weightCoefficient":0.88,"priority":32,"parent":2},{"id":39,"fullName":"Лиственница сибирская","shortName":"ЛСБ","code":1,"dateOn":"2019-06-06","productCode":"53","pieceMethod":false,"groupTypesCode":3,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":40,"fullName":"Липа","shortName":"ЛП","code":3,"dateOn":"2019-06-06","productCode":"54","pieceMethod":false,"groupTypesCode":8,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":41,"fullName":"Липа крупнолистная","shortName":"ЛПК","code":3,"dateOn":"2019-06-06","productCode":"55","pieceMethod":false,"groupTypesCode":277,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":42,"fullName":"Липа мелколистная","shortName":"ЛПМ","code":3,"dateOn":"2019-06-06","productCode":"56","pieceMethod":false,"groupTypesCode":8,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":43,"fullName":"Ольха серая","shortName":"ОЛС","code":3,"dateOn":"2019-06-06","productCode":"61","pieceMethod":false,"groupTypesCode":6,"weightCoefficient":0.83,"priority":18,"parent":4},{"id":44,"fullName":"Ольха черная","shortName":"ОЛЧ","code":3,"dateOn":"2019-06-06","productCode":"62","pieceMethod":false,"groupTypesCode":5,"weightCoefficient":0.83,"priority":16,"parent":4},{"id":45,"fullName":"Ольха","shortName":"ОЛ","code":3,"dateOn":"2019-06-06","productCode":"63","pieceMethod":false,"groupTypesCode":286,"weightCoefficient":0.83,"priority":999,"parent":4},{"id":46,"fullName":"Осина","shortName":"ОС","code":3,"dateOn":"2019-06-06","productCode":"64","pieceMethod":false,"groupTypesCode":7,"weightCoefficient":0.82,"priority":22,"parent":4},{"id":47,"fullName":"Пихта","shortName":"П","code":1,"dateOn":"2019-06-06","productCode":"66","pieceMethod":false,"groupTypesCode":69,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":48,"fullName":"Пихта сибирская","shortName":"ПС","code":1,"dateOn":"2019-06-06","productCode":"67","pieceMethod":false,"groupTypesCode":69,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":49,"fullName":"Сосна","shortName":"С","code":1,"dateOn":"2019-06-06","productCode":"71","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":10,"parent":2},{"id":50,"fullName":"Сосна банкса","shortName":"СБ","code":1,"dateOn":"2019-06-06","productCode":"72","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":51,"fullName":"Сосна веймутова","shortName":"СВ","code":1,"dateOn":"2019-06-06","productCode":"73","pieceMethod":false,"groupTypesCode":191,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":52,"fullName":"Сосна обыкновенная","shortName":"СО","code":1,"dateOn":"2019-06-06","productCode":"74","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":53,"fullName":"Сосна крымская","shortName":"СК","code":1,"dateOn":"2019-06-06","productCode":"75","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":54,"fullName":"Тополь","shortName":"Т","code":3,"dateOn":"2019-06-06","productCode":"82","pieceMethod":false,"groupTypesCode":85,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":55,"fullName":"Тополь белый","shortName":"ТБ","code":3,"dateOn":"2019-06-06","productCode":"83","pieceMethod":false,"groupTypesCode":85,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":56,"fullName":"Тополь черный","shortName":"ТЧ","code":3,"dateOn":"2019-06-06","productCode":"84","pieceMethod":false,"groupTypesCode":85,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":57,"fullName":"Тополь душистый","shortName":"ТД","code":3,"dateOn":"2019-06-06","productCode":"85","pieceMethod":false,"groupTypesCode":85,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":58,"fullName":"Ясень","shortName":"Я","code":2,"dateOn":"2019-06-06","productCode":"89","pieceMethod":true,"groupTypesCode":11,"weightCoefficient":0.88,"priority":28,"parent":3},{"id":59,"fullName":"Сосна после подсочки","shortName":"СП","code":1,"dateOn":"2019-06-06","productCode":"92","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":60,"fullName":"Береза после подсочки","shortName":"БПС","code":3,"dateOn":"2019-06-06","productCode":"93","pieceMethod":false,"groupTypesCode":4,"weightCoefficient":0.88,"priority":999,"parent":4},{"id":294,"fullName":"бук карпатский","shortName":"ББК","code":2,"dateOn":"2019-11-26","productCode":"94","pieceMethod":true,"groupTypesCode":9999,"weightCoefficient":0.88,"priority":999,"parent":3},{"id":295,"fullName":"Иные породы","shortName":"ПДЛ","code":7,"dateOn":"2020-05-04","productCode":"0","pieceMethod":false,"groupTypesCode":0,"weightCoefficient":0.88,"priority":999},{"id":296,"fullName":"Лещина","shortName":"ЛЩ","code":7,"dateOn":"2020-04-27","productCode":"57","pieceMethod":false,"groupTypesCode":104,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":297,"fullName":"Боярышник","shortName":"БЯР","code":7,"dateOn":"2020-05-04","productCode":"11","pieceMethod":false,"groupTypesCode":33,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":298,"fullName":"Черешня","shortName":"ЧШ","code":9,"dateOn":"2020-05-18","productCode":"95","pieceMethod":false,"groupTypesCode":285,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":299,"fullName":"Яблоня","shortName":"ЯБ","code":5,"dateOn":"2020-05-18","productCode":"90","pieceMethod":false,"groupTypesCode":103,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":300,"fullName":"Груша","shortName":"ГШ","code":5,"dateOn":"2020-05-18","productCode":"20","pieceMethod":false,"groupTypesCode":97,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":301,"fullName":"Рябина","shortName":"Р","code":5,"dateOn":"2020-05-18","productCode":"68","pieceMethod":false,"groupTypesCode":74,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":302,"fullName":"Черемуха","shortName":"ЧР","code":5,"dateOn":"2020-06-25","productCode":"87","pieceMethod":false,"groupTypesCode":92,"weightCoefficient":0.88,"priority":999,"parent":295},{"id":303,"fullName":"Туя западная","shortName":"ТУЗ","code":1,"dateOn":"2021-09-01","productCode":"212","groupTypesCode":212,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":304,"fullName":"Псевдотсуга","shortName":"ПС","code":1,"dateOn":"2019-06-06","productCode":"1","pieceMethod":false,"groupTypesCode":1,"weightCoefficient":0.88,"priority":999,"parent":2},{"id":305,"fullName":"Слива","shortName":"СЛ","code":5,"dateOn":"2023-03-20","productCode":"78","pieceMethod":false,"groupTypesCode":0,"weightCoefficient":0.88,"priority":999,"parent":295}]
Response fields-
Path Type Description

id

Number

The WoodGroupType id.

parent

Number

The parent id. Optional.

fullName

String

The full name of WoodGroupType.

shortName

String

The short name of WoodGroupType.

dateOn

String

The effective LocalDate.

dateOff

String

The expiration LocalDate. Optional.

code

Number

The code of WoodGroupType.

productCode

String

The product code of WoodGroupType. Optional.

pieceMethod

Boolean

True when the piecemeal accounting method. Optional.

groupTypesCode

Number

Code 1C

weightCoefficient

Number

Coefficient for weight calculation

priority

Number

Most popular usage(999 rare)

1.11.6. Get WoodDocTypes

A GET request to get all WoodDocTypes for WoodDoc.

Required PERMIT_TYPES_VIEW(105,3) role.

Curl request
$ curl 'http://localhost:8801/api/wooddocs/types' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wooddocs/types HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 541

[{"id":1,"fullName":"Лесорубочный билет","shortName":"Лесорубочный билет"},{"id":2,"fullName":"Ордер","shortName":"Ордер"},{"id":6,"fullName":"Приказ  руководителя","shortName":"Приказ  руководителя"},{"id":16,"fullName":"Решение исполкома","shortName":"Решение исполкома"},{"id":17,"fullName":"План лесозаготовительных работ","shortName":"План лесозаготовительных работ"}]
Response fields-
Path Type Description

id

Number

The WoodDocType id.

fullName

String

The full name of WoodDocType. Optional.

shortName

String

The short name of WoodDocType.

1.11.7. Get WoodDocTypePermits

A GET request to get all WoodDocTypePermits.

Required BASIS_FOREST_VIEW(106,3) role.

Curl request
$ curl 'http://localhost:8801/api/wooddocs/permits' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wooddocs/permits HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1538

[{"id":1,"fullName":"решение государственного органа","shortName":"решение государственного органа"},{"id":3,"fullName":"концессионный договор","shortName":"концессионный договор"},{"id":4,"fullName":"акт освидетельствования лесосеки","shortName":"акт освидетельствования лесосеки"},{"id":5,"fullName":"биржевой договор","shortName":"биржевой договор"},{"id":6,"fullName":"договор на оказание услуг по проведению лесохозяйственных мероприятий и лесопользования","shortName":"договор на мероприятия и лесопользование"},{"id":7,"fullName":"договор на оказание услуг по рубке опасных деревьев","shortName":"договор на рубку опасных деревьев"},{"id":8,"fullName":"заявление","shortName":"заявление"},{"id":9,"fullName":"договор на оказание услуг по заготовке древесины","shortName":"договор на оказание услуг по заготовке древесины"},{"id":11,"fullName":"договор аренды участка лесного фонда (в случае заготовки древесины)","shortName":"договор аренды участка лесного фонда"}]
Response fields-
Path Type Description

id

Number

The WoodDocTypePermit id.

fullName

String

The full name of WoodDocTypePermit. Optional.

shortName

String

The short name of WoodDocTypePermit.

1.11.8. Get WoodDocStatuses

A GET request to get all WoodDocStatus.

Required PERMIT_DOCUMENT_VIEW(200,3) role.

Curl request
$ curl 'http://localhost:8801/api/wooddocs/statuses' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wooddocs/statuses HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 173

[{"id":1,"statusName":"Проект"},{"id":2,"statusName":"Действующий"},{"id":3,"statusName":"Завершен"},{"id":4,"statusName":"Аннулирован"}]
Response fields-
Path Type Description

id

Number

The WoodDocStatus id.

statusName

String

The WoodDocStatus name.

1.11.9. Get WoodDoc for Storage

A GET request to get WoodDoc by storageId.

Error codes:
403 "Forbidden" in case of given storage does not belong to any of user’s organizations.
404 "Not Found" when there is no woodDoc for given storage.
409 "Conflict" when there are more than 1 woodDocs.
412 "Precondition Failed" when there is no such storage.

Required PERMIT_DOCUMENT_VIEW(200,3) role.

Curl request
$ curl 'http://localhost:8801/api/wooddocs/storages/627608' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/wooddocs/storages/627608 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
Path parameters
Table 1. /api/wooddocs/storages/{storageId}
Parameter Description

storageId

The id of Storage.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 449

{"id":254058,"seriesWoodDoc":"ОК","numberWoodDoc":149,"dateWoodDoc":"2022-12-09","fullNameWoodUse":"Иванов И.И.","addressWoodUse":"д. Старый млын","dateEndUse":"2022-12-31","dateEndCuttingArea":"2023-09-30","systemNumber":"2-2022-149-40","bsoNumber":"32432","cuttingAreas":null,"storages":null,"woodDocType":2,"woodDocTypePermitUse":8,"department":40,"fellingType":14,"activityKind":1,"departmentForestry":38,"woodDocsStatus":3}
Response fields
Path Type Description

id

Number

The id of WoodDoc.

department

Number

The Department id.

woodDocType

Number

The WoodDocType id[1-17]. Optional.

numberWoodDoc

Number

The number of WoodDoc. Optional.

seriesWoodDoc

String

The series of WoodDoc. Optional.

dateWoodDoc

String

The LocalDate of WoodDoc. Optional.

fellingType

Number

The FellingType id[1-114]. Optional.

organizationUse

Number

The Organization id of forest user. Optional.

activityKind

Number

The ActivityKind id[1,2,6]. Optional.

fullNameWoodUse

String

The full name of natural person. Optional.

addressWoodUse

String

The address of natural person. Optional.

dateEndUse

String

The LocalDate end of use. Optional.

woodDocTypePermitUse

Number

The basis of use. Optional.

numberDocUse

String

Founding document number. Optional.

dateUse

String

The LocalDate of use. Optional.

dateEndCuttingArea

String

The LocalDate end of removal. Optional.

departmentForestry

Number

The Department parent id. Optional.

woodDocsStatus

Number

The Status of WoodDoc id[1-4]. Optional.

systemNumber

String

The system number of WoodDoc. Optional.

bsoNumber

String

The bso number of WoodDoc. Optional.

1.11.10. Create a new WoodDoc ticket

A POST request to create new WoodDoc ticket. All fields are required, except for the fields in CuttingAreaSpecification (only woodGroupType is required). At least one cuttingAreaSpecification must contain a main woodGroupType, if specified and ticket contains the appropriate fellingType(checkWoodGroupTypeMain = true). CuttingAreaSpecifications without volumes will be ignored. The field "storages" should be located in the cutting area block. By default, cuttingAreaStatus will be set 2(Active) and woodDocStatus will be set 1(Project). It’s allowed to create only for the user’s organizations/departments. The woodDoc number is unique within one year for one departmentForestry.

The dateWoodDoc range: from the beginning of the current year to one month ahead of the current date.
All dates must be after or equals then dateWoodDoc except dateUse. dateUse must be before or equals then dateWoodDoc.
dateEndCuttingArea must be after or equals then the dateEndUse, but no longer than 4 months.
dateStart must be between woodDocDate and dateEndUse, inclusive.

Should not contain a field "fioWoodUse". If any incorrect provided dates or cuttingAreas, cuttingAreaSpecifications, storages, woodGroupType are not provided or woodDoc already exists or fioWoodUse is provided the response would be with status 406. If department blocked, or department haven’t 4 level, or woodGroupType blocked, the response would be with status 409.

Request may provide an Accept-Language header for preferable response language. By default, response has English locale. There are two locales available: Russian(ru) and English(en).
For example:
'Accept-Language: ru, en;q=0.8, *;q=0.5'

Required PERMIT_DOCUMENT_ADD(200,1),

LESOSKI_ADD(205,1),

SPECIFICATIONS_FORESTER_ADD(208,1),

WAREHOUSES_ADD(302,1) roles.

Curl request
$ curl 'http://localhost:8801/api/wooddocs' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e' \
    -H 'Accept-Language: ru, en;q=0.8, *;q=0.5' \
    -d '{      "department": 40,
      "woodDocType": 1,
      "numberWoodDoc": 1000018,
      "dateWoodDoc": "2024-04-29",
      "fellingType": 18,
      "organizationUse": 3113,
      "activityKind": 1,
      "dateEndUse": "2024-06-29",
      "dateEndCuttingArea": "2024-07-29",
      "numberDocUse": "ЕН875",
      "dateUse": "2024-04-14",
      "woodDocTypePermitUse": 7,
      "cuttingAreas":[
              {
                  "woodGroupType": 2,
                  "woodGroupTypeMain": 49,
                  "determiningVolumeProcess": 1,
                  "woodDocTypePermitMake": 5,
                  "numberQuarter": "57",
                  "numberTaxation": "2",
                  "numberCuttingArea": "2",
                  "yardage": 1.9,
                  "dateStart": "2024-05-09",
                  "cuttingAreaSpecifications": [
                      {
                          "woodGroupType": 49,
                          "volumeIndustrialWood": 9.6,
                          "volumeFireWood": 7.73
                      },
                      {
                          "woodGroupType": 50,
                          "volumeIndustrialWood": 9.6,
                          "volumeFireWood": 7.73
                      }
                  ],
                  "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  },
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 58",
                          "isWoodRadiation": false
                  }
                  ]
              }
      ]
}'
HTTP request
POST /api/wooddocs HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Accept-Language: ru, en;q=0.8, *;q=0.5
Content-Length: 1920
Host: localhost:8801

{      "department": 40,
      "woodDocType": 1,
      "numberWoodDoc": 1000018,
      "dateWoodDoc": "2024-04-29",
      "fellingType": 18,
      "organizationUse": 3113,
      "activityKind": 1,
      "dateEndUse": "2024-06-29",
      "dateEndCuttingArea": "2024-07-29",
      "numberDocUse": "ЕН875",
      "dateUse": "2024-04-14",
      "woodDocTypePermitUse": 7,
      "cuttingAreas":[
              {
                  "woodGroupType": 2,
                  "woodGroupTypeMain": 49,
                  "determiningVolumeProcess": 1,
                  "woodDocTypePermitMake": 5,
                  "numberQuarter": "57",
                  "numberTaxation": "2",
                  "numberCuttingArea": "2",
                  "yardage": 1.9,
                  "dateStart": "2024-05-09",
                  "cuttingAreaSpecifications": [
                      {
                          "woodGroupType": 49,
                          "volumeIndustrialWood": 9.6,
                          "volumeFireWood": 7.73
                      },
                      {
                          "woodGroupType": 50,
                          "volumeIndustrialWood": 9.6,
                          "volumeFireWood": 7.73
                      }
                  ],
                  "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  },
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 58",
                          "isWoodRadiation": false
                  }
                  ]
              }
      ]
}
Request headers
Name Description

Authorization

(User) token

Accept-Language

The Locale for response message.
Request fields
Path Type Description

department

Number

The Department id.

woodDocType

Number

The WoodDocType id[1-17].

numberWoodDoc

Number

The number of WoodDoc.

dateWoodDoc

String

The LocalDate of WoodDoc.

fellingType

Number

The FellingType id[1-114].

organizationUse

Number

The Organization id of forest user.

activityKind

Number

The ActivityKind id[1,2,6].

dateEndUse

String

The LocalDate end of use.

numberDocUse

String

Founding document number.

dateUse

String

The LocalDate of use.

woodDocTypePermitUse

Number

The basis of use.

dateEndCuttingArea

String

The LocalDate end of removal. Optional.

cuttingAreas[].woodGroupType

Number

The WoodGroupType id[2-302].

cuttingAreas[].woodGroupTypeMain

Number

The MainWoodGroupType id[2-302]. Optional.

cuttingAreas[].determiningVolumeProcess

Number

The DeterminingVolumeProcess id[1-3].

cuttingAreas[].woodDocTypePermitMake

Number

The WoodDocTypePermitMake id[1-11].

cuttingAreas[].numberQuarter

String

The number of quarter. Optional.

cuttingAreas[].numberTaxation

String

The number of section. Optional.

cuttingAreas[].numberCuttingArea

String

The number of CuttingArea. Optional.

cuttingAreas[].yardage

Number

The cutting area. Optional.

cuttingAreas[].dateStart

String

The LocalDate of start.

cuttingAreas[].cuttingAreaSpecifications[].woodGroupType

Number

The WoodGroupType id[2-302].

cuttingAreas[].cuttingAreaSpecifications[].volumeIndustrialWood

Number

The volume of commercial wood. Optional.

cuttingAreas[].cuttingAreaSpecifications[].volumeFireWood

Number

The volume of firewood. Optional.

cuttingAreas[].cuttingAreaSpecifications[].volumeLiquidWood

Number

The volume of liquid wood. Optional.

cuttingAreas[].cuttingAreaSpecifications[].volumeNoliquidWood

Number

The volume of other wood. Optional.

cuttingAreas[].storages[].quarter

String

The quarter of Storage.

cuttingAreas[].storages[].outlined

String

The section of Storage.

cuttingAreas[].storages[].storageType

Number

The StorageTypeId[0-2].

cuttingAreas[].storages[].shortName

String

The short name of Storage.

cuttingAreas[].storages[].isWoodRadiation

Boolean

True when wood has radiation.
HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

1.11.11. Create a new WoodDoc order

A POST request to create new WoodDoc order. All fields are mandatory except for dateEndCuttingArea. The field "storages" should be located at the root. An array of unit length storages is expected. By default, woodDocStatus will be set 1(Project). It’s allowed to create only for individuals. The woodDoc number is unique within one year for one department.

The dateWoodDoc range: from the beginning of the current year to one month ahead of the current date.

All dates must be after or equals then dateWoodDoc except dateUse. dateUse must be before or equals then dateWoodDoc.

dateEndCuttingArea must be after or equals then the dateEndUse, but no longer than 4 months.

dateStart must be between woodDocDate and dateEndUse, inclusive.

Should not contain fields "cuttingAreas" and "organizationUse". If any incorrect provided dates or cuttingAreas or organizationUse are provided or received more than one storage or woodDoc already exists the response would be with status 406. If department blocked, or department haven’t 4 level the response would be with status 409.

Request may provide an Accept-Language header for preferable response language. By default, response has English locale. There are two locales available: Russian(ru) and English(en).
For example:
'Accept-Language: ru, en;q=0.8, *;q=0.5'

Required PERMIT_DOCUMENT_ADD(200,1),

LESOSKI_ADD(205,1),

SPECIFICATIONS_FORESTER_ADD(208,1),

WAREHOUSES_ADD(302,1) roles.

Curl request
$ curl 'http://localhost:8801/api/wooddocs' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e' \
    -H 'Accept-Language: ru, en;q=0.8, *;q=0.5' \
    -d '{      "department": 40,
      "woodDocType": 2,
      "numberWoodDoc": 1000016,
      "dateWoodDoc": "2024-04-29",
      "fellingType": 99,
      "activityKind": 1,
      "fullNameWoodUse": "Иванов Иван Иванович",
      "dateEndUse": "2024-06-29",
      "numberDocUse": "ЕR875",
      "dateUse": "2024-04-14",
      "woodDocTypePermitUse": 7,
      "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  }
      ]
}'
HTTP request
POST /api/wooddocs HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Accept-Language: ru, en;q=0.8, *;q=0.5
Content-Length: 682
Host: localhost:8801

{      "department": 40,
      "woodDocType": 2,
      "numberWoodDoc": 1000016,
      "dateWoodDoc": "2024-04-29",
      "fellingType": 99,
      "activityKind": 1,
      "fullNameWoodUse": "Иванов Иван Иванович",
      "dateEndUse": "2024-06-29",
      "numberDocUse": "ЕR875",
      "dateUse": "2024-04-14",
      "woodDocTypePermitUse": 7,
      "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  }
      ]
}
Request headers
Name Description

Authorization

(User) token

Accept-Language

The Locale for response message.
Request fields
Path Type Description

department

Number

The Department id.

woodDocType

Number

The WoodDocType id[1-17].

numberWoodDoc

Number

The number of WoodDoc.

dateWoodDoc

String

The LocalDate of WoodDoc.

fellingType

Number

The FellingType id[1-114].

activityKind

Number

The ActivityKind id[1,2,6].

fullNameWoodUse

String

The full name of natural person.

dateEndUse

String

The LocalDate end of use.

numberDocUse

String

Founding document number.

dateUse

String

The LocalDate of use.

woodDocTypePermitUse

Number

The basis of use.

dateEndCuttingArea

String

The LocalDate end of removal. Optional.

storages[].quarter

String

The quarter of Storage.

storages[].outlined

String

The section of Storage.

storages[].storageType

Number

The StorageTypeId[0-2].

storages[].shortName

String

The short name of Storage.

storages[].isWoodRadiation

Boolean

True when wood has radiation.
HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

1.11.12. Error messages when creating a WoodDoc

This example specified an invalid fellingType(399) for a WoodDoc order.

Curl request
$ curl 'http://localhost:8801/api/wooddocs' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e' \
    -H 'Accept-Language: ru, en;q=0.8, *;q=0.5' \
    -d '{      "department": 40,
      "woodDocType": 2,
      "dateWoodDoc": "2024-04-29",
      "numberWoodDoc": 1000017,
      "fellingType": 399,
      "activityKind": 1,
      "dateEndUse": "2024-06-29",
      "fullNameWoodUse": "Ivanov Ivan",
      "dateUse": "2024-04-14",
      "numberDocUse": "ЕR875",
      "woodDocTypePermitUse": 7,
      "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  }
      ]
}'
HTTP request
POST /api/wooddocs HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Accept-Language: ru, en;q=0.8, *;q=0.5
Content-Length: 643
Host: localhost:8801

{      "department": 40,
      "woodDocType": 2,
      "dateWoodDoc": "2024-04-29",
      "numberWoodDoc": 1000017,
      "fellingType": 399,
      "activityKind": 1,
      "dateEndUse": "2024-06-29",
      "fullNameWoodUse": "Ivanov Ivan",
      "dateUse": "2024-04-14",
      "numberDocUse": "ЕR875",
      "woodDocTypePermitUse": 7,
      "storages":[
                  {
                          "quarter": "57",
                          "outlined": "2,11,12",
                          "storageType": 2,
                          "shortName": "short 57",
                          "isWoodRadiation": false
                  }
      ]
}
Request headers
Name Description

Authorization

(User) token

Accept-Language

The Locale for response message.
HTTP response
HTTP/1.1 406 Not Acceptable
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 187

{"error":"Not Acceptable","timestamp":"2024-04-29T17:20:18.799656863+03:00","message":"Вид рубки (fellingType) 399 не существует.","status":406,"path":"/api/wooddocs"}
Response fields
Path Type Description

message

String

Error message.

status

Number

HTTP status code.

error

String

HTTP status name.

path

String

URL path.

timestamp

String

The timestamp of error.

1.12. Contracts

1.12.1. Import a new Contract

A POST request to create Contract.

Required CONTRACT_ADD(333,1) or CONTRACT_EDIT(332,1) role.

Curl request
$ curl 'http://localhost:8801/api/contracts' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e' \
    -H 'Accept-Language: ru, en;q=0.8, *;q=0.5' \
    -d '  { "contractId": "2024-test-contract-01",
    "contractTypeId": 1,
    "contractType": "02",
    "contractNumber": "б/н",
    "contractDate": "2024-01-05",
    "startDate": "2024-01-25",
    "endDate": "2025-01-31",
    "active": true,
    "contractVolume": 120,
    "maxVolume": 122.4,
    "contractSum": 9350.99,
    "contractCurrency": 933,
    "organizationSellerId": 3045,
    "organizationSellerUnp": "666555444",
    "organizationBuyerId": 2856,
    "organizationBuyerUnp": "600123313",
    "organizationBuyerCountry": 112
  }
'
HTTP request
POST /api/contracts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Accept-Language: ru, en;q=0.8, *;q=0.5
Content-Length: 537
Host: localhost:8801

  { "contractId": "2024-test-contract-01",
    "contractTypeId": 1,
    "contractType": "02",
    "contractNumber": "б/н",
    "contractDate": "2024-01-05",
    "startDate": "2024-01-25",
    "endDate": "2025-01-31",
    "active": true,
    "contractVolume": 120,
    "maxVolume": 122.4,
    "contractSum": 9350.99,
    "contractCurrency": 933,
    "organizationSellerId": 3045,
    "organizationSellerUnp": "666555444",
    "organizationBuyerId": 2856,
    "organizationBuyerUnp": "600123313",
    "organizationBuyerCountry": 112
  }
Request headers
Name Description

Authorization

(User) token

Accept-Language

The Locale for response message. Optional.
Request fields
Path Type Description

contractId

String

External contract id.

contractTypeId

Number

The contract type id(BasisDocumentType.id). Valid values 1,4,12,13. It has higher priority than contractType. Optional, one of contractTypeID or contractType must be present.

contractType

String

The contract type(BasisDocumentType.externalCode). Valid values '01','02','03','05'. It has lower priority than contractTypeId. Optional, one of contractTypeID or contractType must be present.

contractNumber

String

The contract №.

contractDate

String

The contract date in ISO 8601 'YYYY-MM-DD' format.

startDate

String

The contract start date in ISO 8601 'YYYY-MM-DD' format.

endDate

String

The contract end date in ISO 8601 'YYYY-MM-DD' format. Optional

active

Boolean

Is contract actual. Optional, default false(inactive).

contractVolume

Number

The contract total volume in cubic meters, must be positive.

maxVolume

Number

The contract max volume(contractVolume + %) in cubic meters, must be positive.

contractSum

Number

The contract amount in some currency, must be positive or null. Optional.

contractCurrency

Number

The contract currency, BYN 933.

organizationSellerId

Number

The seller organization id.

organizationSellerUnp

String

The seller organization UNP.

organizationBuyerId

Number

The buyer organization id.

organizationBuyerUnp

String

The buyer organization UNP.

organizationBuyerCountry

Number

The country code in ISO 3166-1 format, Belarus 112. Optional.
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 154

{"2024-test-contract-01":"Идентификатор контракта 2024-test-contract-01 уже существует для продавца  3045."}

1.12.2. Get Contracts for user Organization

A GET request for user organization and its parent active contracts.

Required CONTRACT_VIEW(333,3) role.

Curl request
$ curl 'http://localhost:8801/api/contracts' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/contracts HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4510

[{"id":41,"contractTypeId":12,"contractNumber":"222","contractDate":"2024-03-05","organizationSellerId":3045,"organizationBuyerId":69,"active":true,"currentVolume":0.053,"startDate":"2024-03-05","contractVolume":1.0,"maxVolume":1.06,"contractCurrency":933},{"id":41,"contractTypeId":12,"contractNumber":"222","contractDate":"2024-03-05","organizationSellerId":2748,"organizationBuyerId":69,"active":true,"currentVolume":0.053,"startDate":"2024-03-05","contractVolume":1.0,"maxVolume":1.06,"contractCurrency":933},{"id":40,"contractTypeId":1,"contractNumber":"б/н","contractDate":"2024-01-05","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":9350.99,"currentVolume":0.0,"contractId":"2024-test-contract-01","startDate":"2024-01-25","endDate":"2025-01-31","contractVolume":120.0,"maxVolume":122.4,"contractCurrency":933},{"id":39,"contractTypeId":4,"contractNumber":"656764","contractDate":"2024-02-23","organizationSellerId":3045,"organizationBuyerId":12326,"active":true,"contractSum":2.0,"currentVolume":0.0,"startDate":"2024-02-23","contractVolume":55.0,"maxVolume":60.0,"contractCurrency":933},{"id":32,"contractTypeId":13,"contractNumber":"б/н","contractDate":"2024-02-05","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":9999.99,"currentVolume":0.0,"contractId":"2024-test-contract-05","startDate":"2024-02-06","endDate":"2025-01-31","contractVolume":120.0,"maxVolume":122.4,"contractCurrency":933},{"id":31,"contractTypeId":12,"contractNumber":"123","contractDate":"2024-02-09","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":200.0,"currentVolume":0.0,"startDate":"2024-02-09","contractVolume":200.0,"maxVolume":210.0,"contractCurrency":840},{"id":30,"contractTypeId":13,"contractNumber":"123","contractDate":"2024-02-09","organizationSellerId":3045,"organizationBuyerId":3078,"active":true,"currentVolume":0.0,"startDate":"2024-02-09","contractVolume":100.0,"maxVolume":110.0,"contractCurrency":933},{"id":28,"contractTypeId":13,"contractNumber":"123","contractDate":"2024-02-09","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":1.11111111112E9,"currentVolume":0.0,"startDate":"2024-02-09","contractVolume":100.0,"maxVolume":100.0,"contractCurrency":933},{"id":27,"contractTypeId":12,"contractNumber":"123123","contractDate":"2024-02-07","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":999.99,"currentVolume":0.003,"startDate":"2024-02-07","contractVolume":9999.999,"maxVolume":9999.999,"contractCurrency":978},{"id":25,"contractTypeId":12,"contractNumber":"3333","contractDate":"2024-02-01","organizationSellerId":3045,"organizationBuyerId":3073,"active":true,"contractSum":3000.0,"currentVolume":0.0,"startDate":"2024-02-01","contractVolume":3000.0,"maxVolume":3000.0,"contractCurrency":933},{"id":15,"contractTypeId":13,"contractNumber":"555","contractDate":"2024-02-05","organizationSellerId":2856,"organizationBuyerId":3045,"active":true,"contractSum":9350.99,"currentVolume":4.861,"contractId":"2024-test-contract-05","startDate":"2024-02-06","endDate":"2025-01-31","contractVolume":120.0,"maxVolume":122.4,"contractCurrency":933},{"id":10,"contractTypeId":1,"contractNumber":"3","contractDate":"2023-11-01","organizationSellerId":2856,"organizationBuyerId":3045,"active":true,"contractSum":555.0,"currentVolume":60.0,"startDate":"2023-11-02","contractVolume":50.0,"maxVolume":60.0,"contractCurrency":933},{"id":9,"contractTypeId":13,"contractNumber":"б/н","contractDate":"2024-01-05","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":9350.99,"currentVolume":56.942,"contractId":"2024-test-contract-02","startDate":"2024-01-25","endDate":"2025-01-30","contractVolume":121.0,"maxVolume":126.0,"contractCurrency":933},{"id":4,"contractTypeId":13,"contractNumber":"323","contractDate":"2024-01-05","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":350.0,"currentVolume":0.6,"contractId":"122-123","startDate":"2024-01-08","contractVolume":122.0,"maxVolume":124.06,"contractCurrency":840},{"id":3,"contractTypeId":1,"contractNumber":"4 must be 50 symbols, but 75 ........................................","contractDate":"2024-01-16","organizationSellerId":3045,"organizationBuyerId":2748,"active":true,"contractSum":555.0,"currentVolume":8.942,"startDate":"2024-01-18","endDate":"2024-12-31","contractVolume":300.0,"maxVolume":400.0,"contractCurrency":933}]
Response fields-
Path Type Description

id

Number

Internal contract id.

contractId

String

External contract id. Optional.

contractTypeId

Number

The contract type id(BasisDocumentType.id).

contractNumber

String

The contract №.

contractDate

String

The contract date in ISO 8601 'YYYY-MM-DD' format.

startDate

String

The contract start date in ISO 8601 'YYYY-MM-DD' format.

endDate

String

The contract end date in ISO 8601 'YYYY-MM-DD' format. Optional

active

Boolean

Is contract actual.

contractVolume

Number

The contract total volume in cubic meters, must be positive.

maxVolume

Number

The contract max volume(contractVolume + 50%) in cubic meters, must be positive.

currentVolume

Number

The amount of volume already shipped.

contractSum

Number

The contract amount in some currency, must be positive or null. Optional.

contractCurrency

Number

The contract currency, BYN 933.

organizationSellerId

Number

The seller organization id.

organizationBuyerId

Number

The buyer organization id.

1.12.3. Get Contract by seller Organization ID and Contract ID

A GET request for contract by seller organization id and contract external id.

Required CONTRACT_VIEW(333,3) role.

Curl request
$ curl 'http://localhost:8801/api/contracts/3045/2024-test-contract-02' -i -X GET \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'
HTTP request
GET /api/contracts/3045/2024-test-contract-02 HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801
Request headers
Name Description

Authorization

(User) token
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 344

{"id":9,"contractTypeId":13,"contractNumber":"б/н","contractDate":"2024-01-05","organizationSellerId":3045,"organizationBuyerId":2856,"active":true,"contractSum":9350.99,"currentVolume":56.942,"contractId":"2024-test-contract-02","startDate":"2024-01-25","endDate":"2025-01-30","contractVolume":121.0,"maxVolume":126.0,"contractCurrency":933}
Response fields
Path Type Description

id

Number

Internal contract id.

contractId

String

External contract id. Optional.

contractTypeId

Number

The contract type id(BasisDocumentType.id).

contractNumber

String

The contract №.

contractDate

String

The contract date in ISO 8601 'YYYY-MM-DD' format.

startDate

String

The contract start date in ISO 8601 'YYYY-MM-DD' format.

endDate

String

The contract end date in ISO 8601 'YYYY-MM-DD' format. Optional

active

Boolean

Is contract actual.

contractVolume

Number

The contract total volume in cubic meters, must be positive.

maxVolume

Number

The contract max volume(contractVolume + %) in cubic meters, must be positive.

currentVolume

Number

The amount of volume already shipped.

contractSum

Number

The contract amount in some currency, must be positive or null. Optional.

contractCurrency

Number

The contract currency, BYN 933.

organizationSellerId

Number

The seller organization id.

organizationBuyerId

Number

The buyer organization id.

1.13. Logout

A DELETE request to log out.

Authentication is required.

Curl request

$ curl 'http://localhost:8801/api/auth/logout' -i -X DELETE \
    -H 'Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e'

HTTP request

DELETE /api/auth/logout HTTP/1.1
Authorization: 5cfe4621604eb3a56d3cd7d9a30520711f33b091-0008fe78-8bd6-4f15-9b24-e90e07ac538e
Host: localhost:8801

Request headers

Name Description

Authorization

(User) token

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

2. Appendix

2.1. HTTP verbs

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT, PATCH

Used to update an existing resource, including partial updates

DELETE

Used to delete an existing resource

2.2. Response status codes

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The request completed successfully

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s Location header.

204 No Content

An update to an existing resource has been applied successfully.

400 Bad Request

The request was malformed. The response body will include an error providing further information.

401 Unauthorized

The request has not been applied because it lacks valid authentication credentials.

403 Forbidden

The request was understood, but the server refuses to authorize it.

404 Not Found

The requested resource did not exist.

406 Not Acceptable

The requested resource did not have acceptable representation.

409 Conflict

The requested resource have conflict with the current state of the target resource.

410 Gone

The requested resource is no longer available.

412 Precondition Failed

The request conditions did not meet server expectation.