This API retrieves the locations of a project from Smart Materials. You can either retrieve a single location using location ID or all the 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')/Locations({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 location ID (LocId).
To retrieve all the locations of a project, use the following URL.
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Locations
Sample Code
GET https://{host}/Smat/V1/Projects(‘DEMO’)/Disciplines(‘PIPING’)/Nls(‘English’)/Locations(5000)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://in-smatapisp.ingrnet.com/ServicePack/SMAT/V1/$metadata#Projects('DEMO')/Disciplines('PIPING')/Nls('English')/Locations",
"value": [
{
"LocId": 5000,
"LocCode": "A1",
"LocType": null,
"ProjId": "DEMO",
"DpId": 5081,
"MaxWeight": 0,
"X_Dimension": 0,
"Y_Dimension": 0,
"Z_Dimension": 0,
"WeightUnit": null,
"DimensionUnit": null,
"QuarantLocInd": "N",
"CableDrumInd": "N"
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
LocId |
Unique ID of the retrieved location |
Integer |
|
LocCode |
Name of the location |
String |
|
QuarantLocInd |
Indicates whether the bin location can act as quarantine location or not? Available values are Y and N. |
String |
|
LocType |
Type of the location |
String |
|
ProjId |
Unique ID of the Project. Retrieved location belongs to this project. |
String |
|
DpId |
Unique ID of the Discipline. Retrieved location belongs to this discipline. |
Integer |
|
MaxWeight |
Maximum weight in this location |
Integer |
|
X_Dimension |
X- dimension of this location |
Integer |
|
Y_Dimension |
Y- dimension of this location |
Integer |
|
Z_Dimension |
Z- dimension of this location |
Integer |
|
WeightUnit |
Weight unit of this location |
Integer |
|
DimensionUnit |
Dimension unit of this location |
Integer |
|
CableDrumInd |
Indicates whether the bin location is a cable drum or not? Available values are Y and N. |
String |