This API retrieves the bin locations and related bin location warehouses of a project from Smart Materials. You can either retrieve a single bin location using bin location ID or all the bin locations of a project.
Required Privilege: API_READONLY
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/BinLocations({key})
Specify the values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment. The key parameter defines the bin location ID (BnlId).
To retrieve all the bin locations of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/BinLocations
Sample Code
GET https://{host}/Smat/V1/Projects('DEMO')/Disciplines('PIPING')/Nls('English')/BinLocations(5020)
Use Odata query to expand bin location warehouses.
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/BinLocations",
"value":[
{
"BnlId":5020,
"BnlCode":"SITE_CODE_001",
"ProjId":"RS",
"DefaultInd": "N",
"BinLocWarehouses":[
{
"BnlId":5020,
"WhId":5981,
"ProjId":"RS"
}]
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
BnlId |
Unique ID of the retrieved bin location |
Integer |
|
BnlCode |
Name of the bin location |
String |
|
ProjId |
Unique ID of the Project. Retrieved bin location belongs to this Project. |
String |
|
DefaultInd |
Available values ares Y and N. |
String |
|
BinLocWarehouses |
Consists of bin location warehouse details |
Collection |
-
BinLocWarehouses
Element
Description
Type
BnlId
Unique ID of the bin location. Retrieved bin location warehouse belongs to this bin location.
Integer
WhId
Unique ID of the warehouse
Integer
ProjId
Unique ID of the Project. Retrieved bin location warehouse belongs to this project.
String