This API retrieves the Material Transfer Reports (MTR) of a project from Smart Materials. You can either retrieve a single MTR using MTR Id or all the Material Transfer Reports 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’)/MaterialTransferRpts({key})
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the Material Transfer Report Id (MtrId).
To retrieve all the Material Transfer Reports of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/MaterialTransferRpts
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/MaterialTransferRpts(5021)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#projects('RS')/Disciplines('PIPING')/Nls('English')/MaterialTransferRpts",
"value":[
{
"MtrId":5021,
"ProjId":"RS",
"DpId":5020,
"MtrNumber":"RW000001",
"MtrCreateDate":"2006-05-16T00:00:00+05:30",
"TransferDate":"2006-05-16T00:00:00+05:30",
"EtaDate":null,
"FahId":null,
"LocId":null,
"WhId":5082,
"PostedDate":null,
"TransferedBy":null,
"ShipperRef":null,
"MtrType":"R",
"MtrStatus":null,
"MarLogfileName":null,
"BnlId":null
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
MtrId |
Unique ID of the Material Transfer Report |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved MTR belongs to this Project. |
String |
|
DpId |
Unique ID of the Discipline. Retrieved MTR belongs to this Discipline. |
Integer |
|
MtrNumber |
Name/code of the MTR |
String |
|
MtrCreateDate |
Date and time when the MTR is created |
Date time offset |
|
TransferDate |
Date and time when the material is transferred |
Date time offset |
|
EtaDate |
Date and time of material arrival |
Date time offset |
|
FahId |
Unique ID of the Forecast header. Retrieved MTR belongs to this Forecast header. |
Integer |
|
LocId |
Unique ID of the location |
Integer |
|
WhId |
Unique ID of the warehouse |
Integer |
|
PostedDate |
Date and time when the MTR is posted to the inventory |
Date time offset |
|
TransferedBy |
Name of the user who has transferred the material |
String |
|
ShipperRef |
Reference number of the shipper |
String |
|
MtrType |
Type of MTR. Available options are:
|
String |
|
MtrStatus |
Status of the MTR. Available options are:
|
String |
|
MarLogfileName |
Name of the log file which indicates log file path and location |
String |
|
BnlId |
Unique ID of the bin location |
Integer |