Features - Connectors Framework - Inbound REST API - Recurrent Services
Add Recurrent Service
Overview
Creates a Recurrent Service in MobiWork
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/recurrentService/add.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
userId
optional
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
Return
Returns a Recurrent Service Object if recurrent service creation is successful, otherwise errors will be returned
Curl Example
HTTP Method: POST
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/recurrentService/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request>
<recurrentService>
<customerId>3178692</customerId>
<description>Test Recurrent Service</description>
<frequencyTypeId>15</frequencyTypeId>
<frequencyType>EVERY_5_WEEKS</frequencyType>
<workOrderTypeId>25121</workOrderTypeId>
<intervalDays>0</intervalDays>
<warnDays>2</warnDays>
<tardyDays>3</tardyDays>
<lastServiceDate>2020/12/01</lastServiceDate>
<nextServiceDate>2021/01/05</nextServiceDate>
</recurrentService>
</request>
'
Response: <?xml version="1.0" encoding="UTF-8" ?>
<response version="5.0.156" statusCode="1">
<recurrentService>
<recurrentServiceId>69</recurrentServiceId>
<customerId>3178692</customerId>
<customer>customer2</customer>
<locationId>4373022</locationId>
<location>123, 123 Florida 123</location>
<description>Test Recurrent Service</description>
<frequencyTypeId>15</frequencyTypeId>
<frequencyType>EVERY_5_WEEKS</frequencyType>
<workOrderTypeId>25121</workOrderTypeId>
<workOrderType>testworkordertype </workOrderTypeId>
<intervalDays>0</intervalDays>
<warnDays>2</warnDays>
<tardyDays>3</tardyDays>
<lastServiceDate>2020/12/01</lastServiceDate>
<nextServiceDate>2021/01/05</nextServiceDate>
<assignedTo></assignedTo>
<assetList></assetList>
<serviceList></serviceList>
</recurrentService>
</response>