Work Order Export Web Service - WebTMA 7

The service uses JSON-formatted request and response messages to exchange data. Please note that the order of the JSON elements in request messages should match the examples below, though optional elements may be omitted.

The following documentation assumes you know the existing rules for UI. This is merely a new source / destination for the data. Otherwise all existing UI rules apply.

Authenticate Method

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://[WebTMAdomain]/uiservice/webservice/RequestInterface.svc/AuthenticateJSON

REQUEST FORMAT:

{

"Username":"dev",

"Password":"dev",

"Client":"core"

}

RESPONSE Format:

{

<Success>true</Success>

<Message>User Authenticated.</Message>

<Token> fEKG8PMWoIWgeJ27Oi4xUpq6dzffxOvdPdJVRwqKiC%2b41S5gnuf5nHS1i%2fY5qL%2bG9JcZHsufRz7BZzBRcYTNNgrpXUeRaW%2bN</Token>

<ExpDate>2020-11-10T17:55:14.4457027Z</ExpDate>

}

UI_WO_Export_WebSVC_Post.png

UPIWorkOrderExport

This service method is used to export work orders. The POST request must include a TMAAuth HTTP header with a valid authentication token from the AuthenticateJSON method.

POST URL:

https://www.webtma.com/uiservice/webservice/RequestInterface.svc/UPIWorkOrderExport

 

REQUEST Format:

{"UISetupCode":"WOExp"}

 

REPONSE Format:

{

"Success": true,

"WorkOrderList": [

{

"PrimaryKey": 2950,

"WorkOrderNumber": "rettt-118",

"TagNumber": "09284",

"FacilityCode": "Central",

"PriorityCode": "4",

"RepairCenterCode": "100000",

"WOTypeCode": "20362",

"DepartmentCode": "ST",

"RequestorName": "321321 13231313",

"RequestDate": "2020-04-16 17:54:14Z",

"ActionRequested": "TestBiraj - Test",

"Supervisor": "John Smith",

"Chargeable": false,

"CreatedDate": "2020-04-16 17:54:23Z",

"ModifiedDate": "2020-04-18 14:38:54Z",

"CreatorName": "Developer User",

"ModifierName": "Developer User",

"NotifyMe": false,

"WorkNotDone": false,

"TaskCode": "105601",

"TaskDescription": "Check",

"TechnicianName": "",

"UdfValues": [

{

"Name": "WO?",

"Value": ""

},

{

"Name": "Textbox",

"Value": ""

}

]

},

{

"PrimaryKey": 2969,

"WorkOrderNumber": "PP-1111",

"TagNumber": "Z1-100",

"LocationID": "Z1-100",

"BuildingCode": "213",

"BuildingName": "3213",

"FacilityCode": "Birajtest",

"PriorityCode": "1",

"RepairCenterCode": "PP",

"WOTypeCode": "20362",

"chargeAccountNumber": "A100-B100-C100-D100",

"DepartmentCode": "BNF",

"RequestDate": "2020-05-05 15:57:00Z",

"ActionRequested": "TRest",

"Chargeable": false,

"CreatedDate": "2020-05-05 15:58:02Z",

"CreatorName": "Developer User",

"ModifierName": "",

"NotifyMe": true,

"WorkNotDone": false,

"TaskCode": "10578",

"TaskDescription": "Roof Construction",

"TechnicianName": "",

"UdfValues": [

{

"Name": "WO?",

"Value": ""

},

{

"Name": "Textbox",

"Value": ""

}

]

}

},

}

]

UI_WO_Export_WebSVC_Post2.png

Want to Learn More?

Visit the WebTMA Help Page

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

2024 Client Training Schedule
See the full list of web training events.