HTTP Basic authentication is used for access .
Login and password for Eurocement access: login_from_pilot: password_from_pilot
1. Working with the vehicle directory
To work with the directory, use the URL /vehicle with methods GET, POST, PUT, DELETE
Getting a list of vehicles, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the PARUS system)
- number - vehicle number
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Vehicle creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Vehicle number
|
number*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
A record for editing with the specified identifier was not found (there is a comparison with a device from the PILOT and PTM monitoring system)
|
|
server error
|
500
|
Unknown server side error
| |
Vehicle editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Vehicle number
|
number*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a vehicle, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
2. Working with the trailer directory
To work with the directory, use the /trailer URL with GET, POST, PUT, DELETE methods
Getting a list of vehicles, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the SAIL system)
- number - trailer number
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Vehicle creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
trailer number
|
number*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
A record for editing with the specified identifier was not found (there is a comparison with a device from the PILOT and PTM monitoring system)
|
|
server error
|
500
|
Unknown server side error
| |
Vehicle editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
trailer number
|
number*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a vehicle, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
3. Working with the driver's guide
To work with the directory, use the URL /driver with GET, POST, PUT, DELETE methods
Getting a list of drivers, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with sample data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, is filtered out during sampling)
- externalId - external identifier (id in the PARUS system)
- name - full name of the driver
- phone - driver's phone
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Driver creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Full name of the driver
|
name*
|
Line
|
|
Driver phone
|
phone
|
String, NULL by default
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
A record for editing with the specified identifier was not found (there is a comparison with drivers from the PILOT and PTM monitoring system)
|
|
server error
|
500
|
Unknown server side error
| |
Driver editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Full name of the driver
|
name*
|
Line
|
|
Driver phone
|
phone
|
String, NULL by default
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a driver, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
4. Work with the directory of counterparties
To work with the directory, use the /partner URL with GET, POST, PUT, DELETE methods
Getting a list of counterparties, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the SAIL system)
- name - short name
- fullName - full name
- emails - company email
- phone - phone
- types - counterparty attribute:
1 - carrier
2 - buyer
3 - customer
4 - recipient
5 - forwarder
6 - shipper
- entityType - type:
1 - individual
2 - legal entity
- banc - bank
- bancBic - BIC of the bank
- accountNumber - account number
- correspondentNumber - correspondent account
- inn - TIN
- kpp - KPP
- okpo - OKPO
- addresses - addresses, Json with array of addresses:
1 - postal
2 - actual
3 - legal
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Creating a counterparty, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Short name
|
name*
|
Line
|
|
Full name
|
fullName*
|
Line
|
|
Company email
|
emails
|
Array of email addresses, NULL by default
|
|
Telephone
|
phone
|
String, NULL by default
|
|
Counterparty attribute
|
types*
|
Array of counterparty types:
1 - carrier
2 - buyer
3 - customer
4 - recipient
5 - freight forwarder
6 - shipper
|
|
Type of
|
entityType*
|
1 - individual
2 - legal entity
|
|
Bank
|
banc
|
String, NULL by default
|
|
Bank BIC
|
bancBic
|
String, NULL by default
|
|
Account number
|
accountNumber
|
String, NULL by default
|
|
Correspondent account
|
correspondentNumber
|
String, NULL by default
|
|
TIN
|
inn
|
String, NULL by default
|
|
checkpoint
|
kpp
|
String, NULL by default
|
|
OKPO
|
okpo
|
String, NULL by default
|
|
Addresses
|
addresses*
|
Json with an array of addresses:
1 - postal
2 - actual
3 - legal
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Editing an account, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Short name
|
name*
|
Line
|
|
Full name
|
fullName*
|
Line
|
|
Company email
|
emails
|
Array of email addresses, NULL by default
|
|
Telephone
|
phone
|
String, NULL by default
|
|
Counterparty attribute
|
types*
|
Array of counterparty types:
1 - carrier
2 - buyer
3 - customer
4 - recipient
5 - freight forwarder
6 - shipper
|
|
Type of
|
entityType*
|
1 - individual
2 - legal entity
|
|
Bank
|
banc
|
String, NULL by default
|
|
Bank BIC
|
bancBic
|
String, NULL by default
|
|
Account number
|
accountNumber
|
String, NULL by default
|
|
Correspondent account
|
correspondentNumber
|
String, NULL by default
|
|
TIN
|
inn
|
String, NULL by default
|
|
checkpoint
|
kpp
|
String, NULL by default
|
|
OKPO
|
okpo
|
String, NULL by default
|
|
Addresses
|
addresses*
|
Json with an array of addresses:
1 - postal
2 - actual
3 - legal
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a counterparty, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
5. Work with the directory of contracts
To work with the directory, use the /contract URL with GET, POST, PUT, DELETE methods
Getting a list of contracts, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the PARUS system)
- number - Contract number
- date - Contract date
- startDate - Validity start
- endDate - Validity end
- partnerId - Counterparty
- subject - Contract subject
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Creating a contract, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Contract number
|
number*
|
Line
|
|
agreement date
|
date*
|
agreement date
|
|
Start of action
|
startDate*
|
Contract start date (Ymd format)
|
|
End of action
|
endDate*
|
Contract expiration date (Ymd format)
|
|
counterparty
|
[ partnerId*]
|
Identifier from the directory of counterparties
|
|
Subject of the contract
|
subject
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
An entry was not found in the associated reference for the parameter value being passed
|
|
server error
|
500
|
Unknown server side error
| |
Editing a contract, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Contract number
|
number*
|
Line
|
|
agreement date
|
date*
|
agreement date
|
|
Start of action
|
startDate*
|
Contract start date (Ymd format)
|
|
End of action
|
endDate*
|
Contract expiration date (Ymd format)
|
|
counterparty
|
[ partnerId*]
|
Identifier from the directory of counterparties
|
|
Subject of the contract
|
subject
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
An entry was not found in the associated reference for the passed parameter value.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a contract, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
6. Working with the directory of regions
To work with the directory, use the /region URL with GET, POST, PUT, DELETE methods
Getting a list of regions, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, it is filtered out during selection)
- externalId - external identifier (id in the PARUS system)
- region - name of the region
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Region creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Region name
|
region*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Region editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Region name
|
region*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a region, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
7. Working with the reference book of units of measurement
To work with the directory, use the /measure URL with GET, POST, PUT, DELETE methods
Getting a list of units of measure, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
An array with sample data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, it is filtered out during sampling)
- externalId - external identifier (id in the SAIL system)
- measure - unit of measurement
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Creating a unit of measure, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
unit of measurement
|
measure*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Edit unit of measure, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
unit of measurement
|
measure*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a unit of measure, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
8. Working with the directory types of shipments
To work with the directory, use the /shipment URL with GET, POST, PUT, DELETE methods
Getting a list of shipment types, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the SAIL system)
- shipment - type of shipment
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Creating a shipping type, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Type of shipment
|
shipment*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Editing the type of shipment, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Type of shipment
|
shipment*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting a shipping type, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
9. Working with the nomenclature reference book
To work with the directory, use the /nomenclature URL with GET, POST, PUT, DELETE methods
Getting a list of items, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the SAIL system)
- nomenclature - name of the nomenclature
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Item creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Item name
|
nomenclature*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Item editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Item name
|
nomenclature*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting an item, the DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
10. Work with the directory of factories
To work with the directory, use the /factory URL with GET, POST, PUT, DELETE methods
Getting a list of factories, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with sample data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, it is filtered out during sampling)
- externalId - external identifier (id in the PARUS system)
- name - name of the plant
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Plant creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Factory name
|
name*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Plant editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Factory name
|
name*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting an item, the DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
11. Working with the transshipment directory
To work with the directory, use the /transshipment URL with GET, POST, PUT, DELETE methods
Getting a list of transshipments, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the entry
- is_deleted - flag indicating the deletion of the entry (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the PARUS system)
- name - transshipment name
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Creating a transshipment, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Transshipment name
|
name*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
server error
|
500
|
Unknown server side error
| |
Transshipment editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Transshipment name
|
name*
|
Line
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting transshipment, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
12. Work with orders
To work, use the URL /order with methods GET, POST, PUT, DELETE
Getting orders, GET method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
Page
|
page
|
Page number, default 1
|
|
Starting position
|
start
|
Starting position for selection, default 0
|
|
Number of lines
|
limit
|
Number of rows to select, NULL by default (select all records)
|
|
Filter
|
filter
|
Configuration for filtering the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "operator": "=", "value": "1"}, ...],
where:
- property - name of the column (parameter) by which the filtering is performed
- operator - filter operator (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - filter value
|
|
Sorting
|
sort
|
Configuration for sorting the selection in JSON format, NULL by default.
Configuration example: [{"property": "id", "direction": "asc"}, ...],
where:
- property - name of the column (parameter) by which sorting is performed
- direction - sorting direction (asc, desc )
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method
|
|
server error
|
500
|
Unknown server side error
|
|
Response Options
|
|
Name
|
Parameter
|
Description
|
|
Sample data
|
items
|
Array with selection data with the following columns:
- id - internal identifier of the record
- is_deleted - flag indicating the deletion of the record (TRUE value, if deleted, is filtered out during selection)
- externalId - external identifier (id in the SAIL system) of the order
- status - Status
- statusImp - Execution status
- carrierId - carrier
- trailerId - list of trailers
- driverId - list of drivers
- clientId - Customer
- documentId - Contract
- PlantID - Plant
- recipientId - Consignee
- shipperId - Shipper
- shipmentId - Type of shipment
- deliveryRegionId - Delivery region
- deliveryAddress - Delivery address
- unloadRegionId - Loading region
- unloadAddress - Loading address
- nomenclatureId - Nomenclature
- quantity - Order volume, t
- measureId - Unit of measure
- perioddataFrom - Delivery date from
- perioddataTo - Delivery date to
- periodtimeFrom - Delivery time from
- periodtimeTo - Delivery time to
- Contactname - Contact person
- Contactphone - Phone number
- RouteName - routeName
- RouteDistance- routeDistance
|
|
Total Rows
|
total
|
Total number of records
|
|
Page
|
page
|
Page number provided by the client
|
|
Message
|
msg
|
Query result message text
| |
Order creation, POST method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Status
|
status
|
Line
|
|
Execution status
|
statusImp
|
Line
|
|
carrier
|
[ carrierId*]
|
Array of assigned machine IDs
|
|
Trailer
|
[ trailerId]
|
Array of IDs of assigned trailers or NULL
|
|
Driver
|
[ driverId*]
|
Array of IDs of assigned drivers
|
|
Customer
|
[ clientId*]
|
externalId of the counterparty from the "Counterparties" directory. The main counterparty that manages the order.
|
|
Treaty
|
[ documentID*]
|
Contract ID
|
|
Factory
|
[ PlantID*]
|
Plant ID from the Plants directory.
|
|
Consignee
|
[ recipientId*]
|
externalId of the counterparty from the "Counterparties" directory.
|
|
Shipper
|
[ shipperId*]
|
externalId of the counterparty from the "Counterparties" directory.
|
|
Type of shipment
|
[ shipmentId*]
|
externalId of the shipment type from the "Types of shipments" directory.
|
|
Delivery region
|
[ deliveryRegionId]
|
externalId of the region from the "Regions" directory.
|
|
Delivery address
|
deliveryAddress
|
Shipping address string
|
|
Loading region
|
[ unloadRegionId*]
|
externalId of the region from the "Regions" directory.
|
|
Loading address
|
unloadAddress*
|
Line
|
|
Nomenclature
|
[ nomenclatureId*]
|
externalId of products from the "Nomenclature" directory.
|
|
Order volume, t
|
quantity*
|
Number
|
|
unit of measurement
|
[ measureId*]
|
externalId of the unit of measurement from the "Units of measurements" reference book.
|
|
Delivery date from
|
perioddataFrom
|
Date limiting the start of the delivery period (Ymd format)
|
|
Delivery date to
|
perioddataTo
|
Date limiting the end of the delivery period (Ymd format)
|
|
Delivery time from
|
periodtimeFrom
|
Time limiting the start of the delivery period (H:i:s format)
|
|
Delivery time up to
|
periodtimeTo
|
Time limiting the end of the delivery period (H:i:s format)
|
|
The contact person
|
Contactname
|
Name of the contact person on the application
|
|
Phone number
|
Contactphone
|
Phone number of the contact person on request
|
|
Route name
|
routeName
|
Line
|
|
RouteDistance
|
routeDistance
|
float number
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
An entry with the specified identifier already exists (violation of the unique key of the directory)
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
An entry was not found in the associated reference for the parameter value being passed
|
|
server error
|
500
|
Unknown server side error
| |
Order editing, PUT method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Status
|
status
|
Line
|
|
Execution status
|
statusImp
|
Line
|
|
carrier
|
[ carrierId*]
|
Array of assigned machine IDs
|
|
Trailer
|
[ trailerId]
|
Array of IDs of assigned trailers or NULL
|
|
Driver
|
[ driverId*]
|
Array of IDs of assigned drivers
|
|
Customer
|
[ clientId*]
|
externalId of the counterparty from the "Counterparties" directory. The main counterparty that manages the order.
|
|
Treaty
|
[ documentID*]
|
Contract ID
|
|
Factory
|
[ PlantID*]
|
Plant ID from the Plants directory.
|
|
Consignee
|
[ recipientId*]
|
externalId of the counterparty from the "Counterparties" directory.
|
|
Shipper
|
[ shipperId*]
|
externalId of the counterparty from the "Counterparties" directory.
|
|
Type of shipment
|
[ shipmentId*]
|
externalId of the shipment type from the "Types of shipments" directory.
|
|
Delivery region
|
[ deliveryRegionId]
|
externalId of the region from the "Regions" directory.
|
|
Delivery address
|
deliveryAddress
|
Shipping address string
|
|
Loading region
|
[ unloadRegionId*]
|
externalId of the region from the "Regions" directory.
|
|
Loading address
|
unloadAddress*
|
Line
|
|
Nomenclature
|
[ nomenclatureId*]
|
externalId of products from the "Nomenclature" directory.
|
|
Order volume, t
|
quantity*
|
Number
|
|
unit of measurement
|
[ measureId*]
|
externalId of the unit of measurement from the "Units of measurements" reference book.
|
|
Delivery date from
|
perioddataFrom
|
Date limiting the start of the delivery period (Ymd format)
|
|
Delivery date to
|
perioddataTo
|
Date limiting the end of the delivery period (Ymd format)
|
|
Delivery time from
|
periodtimeFrom
|
Time limiting the start of the delivery period (H:i:s format)
|
|
Delivery time up to
|
periodtimeTo
|
Time limiting the end of the delivery period (H:i:s format)
|
|
The contact person
|
Contactname
|
Name of the contact person on the application
|
|
Phone number
|
Contactphone
|
Phone number of the contact person on request
|
|
Route name
|
routeName
|
Line
|
|
RouteDistance
|
routeDistance
|
float number
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request.
Required parameter with an empty value.
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
An entry was not found in the associated reference for the passed parameter value.
No entry found to edit
|
|
server error
|
500
|
Unknown server side error
| |
Deleting an order, DELETE method :
|
Request parameters
|
|
Name
|
Parameter
|
Meaning and Description
|
|
External identifier
|
externalId*
|
order id in the SAIL system
|
|
Status codes
|
|
Name
|
The code
|
Description
|
|
Success
|
200
|
The request was completed successfully
|
|
Bad Request
|
400
|
Missing required parameters in the request or a required parameter with an empty value
|
|
Not authorized
|
401
|
Lack of valid user authentication
|
|
Not found
|
404
|
Directory not found in database. Created automatically when using the POST method.
No entry found to delete.
|
|
server error
|
500
|
Unknown server side error
| |
field* - required field marking
[field] - marking the field, the value of which is associated with another dictionary
Ymd - date format, example: 2022-05-23
H:i:s - time format, example: 22:33:58
Deleting an entry (DELETE) - deletion does not mean the physical removal of an entry from the directory, but editing the entry with the sign "deleted"
Record creation (POST) - creation means: checking for the existence of a directory in the database, if it does not exist, then it is created; updating the entry in the directory, if it does not exist, then it is added to the directory, otherwise editing takes place with the "deleted" attribute reset
Editing an entry (PUT) - editing means updating an entry in the directory with resetting the "deleted" attribute
|