Logistics Management
Endpoints for managing logistics configurations
Parameters
| Name |
In |
Type |
Required |
Description |
| orgId |
path |
string |
true |
Organization name as it is registered in Mas-Stack |
| body |
body |
Obsolescence |
true |
‘none’ |
Request body - instance of Obsolescence
1
2
3
4
5
6
|
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}
|
| Name |
Type |
Required |
Description |
| reference |
string |
true |
Unique reference identifier (primary key) |
| obsolete |
boolean¦null |
false |
Whether the device is considered obsolete |
| breakdowns_maximum |
integer(int32)¦null |
false |
Maximum number of breakdowns allowed before considering obsolete |
| days_obsolescence |
integer(int32)¦null |
false |
Number of days since creation to mark as obsolete |
Request example
1
2
3
4
5
6
7
8
9
10
11
12
|
curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
--data-raw "{
'reference': 'DEV-1234',
'obsolete': true,
'breakdowns_maximum': 3,
'days_obsolescence': 365
}"
|
| Name |
In |
Type |
Required |
Description |
| orgId |
path |
string |
true |
Organization name as it is registered in Mas-Stack |
| size |
query |
integer |
true |
Page size |
| page |
query |
integer |
true |
Page number |
Request example
1
2
3
4
5
|
curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence?size='100'&page='1'?size=100&page=1 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
|
| Code |
Meaning |
Description |
Schema |
| 200 |
OK |
Success |
ArrayOfObsolescences |
| 4XX |
Unknown |
Response for client error when some field in the request is missing or invalid. |
[Error] |
| 5XX |
Unknown |
Response when an internal or unexpected error occurs. |
[Error] |
Parameters
| Name |
In |
Type |
Required |
Description |
| orgId |
path |
string |
true |
Organization name as it is registered in Mas-Stack |
| reference |
path |
string |
true |
‘none’ |
Request example
1
2
3
4
5
|
curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/{reference} \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
|
Responses
| Code |
Meaning |
Description |
Schema |
| 200 |
OK |
Obsolescence record found |
Obsolescence |
| 4XX |
Unknown |
Response for client error when some field in the request is missing or invalid. |
[Error] |
| 5XX |
Unknown |
Response when an internal or unexpected error occurs. |
[Error] |
Parameters
| Name |
In |
Type |
Required |
Description |
| orgId |
path |
string |
true |
Organization name as it is registered in Mas-Stack |
| reference |
path |
string |
true |
‘none’ |
| body |
body |
Obsolescence |
true |
‘none’ |
Request body - instance of Obsolescence
1
2
3
4
5
6
|
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}
|
| Name |
Type |
Required |
Description |
| reference |
string |
true |
Unique reference identifier (primary key) |
| obsolete |
boolean¦null |
false |
Whether the device is considered obsolete |
| breakdowns_maximum |
integer(int32)¦null |
false |
Maximum number of breakdowns allowed before considering obsolete |
| days_obsolescence |
integer(int32)¦null |
false |
Number of days since creation to mark as obsolete |
Request example
1
2
3
4
5
6
7
8
9
10
11
12
|
curl -X PUT https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/{reference} \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
--data-raw "{
'reference': 'DEV-1234',
'obsolete': true,
'breakdowns_maximum': 3,
'days_obsolescence': 365
}"
|
Responses
| Code |
Meaning |
Description |
Schema |
| 200 |
OK |
Obsolescence record updated |
Obsolescence |
| 4XX |
Unknown |
Response for client error when some field in the request is missing or invalid. |
[Error] |
| 5XX |
Unknown |
Response when an internal or unexpected error occurs. |
[Error] |
Parameters
| Name |
In |
Type |
Required |
Description |
| orgId |
path |
string |
true |
Organization name as it is registered in Mas-Stack |
| reference |
path |
string |
true |
‘none’ |
Request example
1
2
3
4
5
|
curl -X DELETE https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/{reference} \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
|
Responses
| Code |
Meaning |
Description |
Schema |
| 200 |
OK |
Obsolescence record deleted successfully |
DeleteResponse |
| 4XX |
Unknown |
Response for client error when some field in the request is missing or invalid. |
[Error] |
| 5XX |
Unknown |
Response when an internal or unexpected error occurs. |
[Error] |