This API creates a Material Transfer Report (MTR) header in Smart Materials.
Required Privilege: API_CREATE_MTRHEADER
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: POST https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/TransferHeaders
Specify values for project, discipline, and language in the URL. The project, discipline, and language together, define the project environment where the MTR header is created.
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
MtrNumber |
Name or code of the MTR |
String |
Required |
Allowed length is 50. |
|
MtrCreateDate |
Date and time of the MTR creation |
Date Time Offset |
Optional |
In the absence of MtrCreateDate, |
|
TransferDate |
Date and time of the material transfer |
Date Time Offset |
Optional |
In the absence of TransferDate, |
|
EtaDate |
Date and time of the material arrival |
Date Time Offset |
Optional |
Acceptable format is YYYY-MM-DD. |
|
BnlId |
Unique ID of the bin location |
Decimal |
Optional |
To view available bin locations, use: GET https://{host}/Smat/V1/Projects(‘:project’) |
|
WhId |
Unique ID of the warehouse |
Decimal |
Required |
To view available warehouses, use: GET https://{host}/Smat/V1/Projects(‘:project’) |
|
TransferedBy |
Name of the user who has transferred the material |
String |
Optional |
|
|
ShipperRef |
Reference number of the shipper |
String |
Optional |
Sample Code
POST http://localhost:53965/SMAT/V1//Projects('AB')/Disciplines('PIPING')/Nls('English')/TransferHeaders
{
"WhId":6661,
"BnlId":5300,
"MtrCreateDate":"2016-05-28",
"TransferDate":"2016-05-28",
"EtaDate":"2016-06-28",
"TransferedBy":"RW",
"ShipperRef":"Shipper-Ref-001"
}
Success Response
Status: 200 OK
{
"@odata.context": " https://{host}/Smat/V1/$metadata#Edm.Int64",
"value": 10000007995
}
Where value is the Unique ID of the Material Transfer Header (MtrId).