Request Interface Web Service methods are used to implement UPI requests within WebTMA. The service uses JSON-formatted request and response messages to exchange data. All of the methods shown below use POST process to send and/or receive data to/from WebTMA.
The following documentation assumes you know the existing rules for UPI. This is merely a new source / destination for the data, otherwise all existing UPI rules apply.
In each call to either an Import or Export method, the correct Universal Interface Template Code for the corresponding transaction is required ("UISetupCode").
Authenticate JSON
This service method is used to generate an authentication token for use with the other service methods. The POST request must include a Content-Type header of “application/json”.
POST URL:
https://www.webtma.com/UIService/webservice/RequestInterface.svc/AuthenticateJson
REQUEST FORMAT:
{
"Username" : "user name",
"Password" : "password",
"Client" : "login client name"
}
RESPONSE Format:
{
"Success" : true,
"Message" : "User Authenticated.",
"Token" : "KU%2b7j2Lno92o%2bJ3J7IgvBKlnSzMpAuHh2NAqFWgnYytcyknP7ou5OP3O%2bxOVGEOV%2fkaE%2fqFvIM9cdXecfPeeu1%2broPnF",
"ExpDate" : "\/Date(1542814039490)\/"
Purchase Requisition Export JSON
This service method is used to export Purchase Requisitions. The POST request must include a Content-Type header of “application/json” and a TMAAuth HTTP header with a valid authentication token from the Authenticate method.
POST URL:
https://www.webtma.com/UIService/webservice/RequestInterface.svc/UPIPurchaseRequisitionExport
REQUEST FORMAT:
{
"UISetupCode":"UPI_PR_WS"
}
RESPONSE FORMAT:
{
"PurchaseRequisitionList":[
{
"UdfValues":[
{
"Name":"What is Purchase Requisition?",
"Value":""
}
],
"PrimaryKey": 1168,
"RequisitionNumber": "1552",
"RequisitionDate": "2020-11-04 00:00:00Z",
"RequiredDate": "2020-11-20 00:00:00Z",
"VendorCode": "Grainger",
"VendorName": "Grainger",
"PurchaseOrderTypeCode": "Service",
"PurchaseOrderTypeDescription": "Service Provider",
"PartCode": "1002",
"PartManufacturerNumber": "5589",
"PartOTPDescription": "Flexible PVC Coupling Fittings",
"Quantity": 5.0,
"UnitOfMeasure": "Each",
"UnitCost": 2.4376,
"WorkOrderNumber": "",
"IsTaxable": false,
"DistributionQuantity": 0.0,
"BuyerName": "Dave McCullum",
"PartOTPCode": "1002",
"BuyerID": "202"
}
],
"Success": true
}
Want to Know More?
Visit the WebTMA Help Page