online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.recurrentservices.title
View Recurrent Service
Overview
Retrieve a Recurrent Service's information
URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/recurrentService/{recurrentServiceId}/view.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
recurrentServiceId
required
The identifier of the recurrent service to be retrieved
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 valid arguments are provided. Returns an error if not a valid request
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/recurrentService/501266/view.html?token=COJL8X2FKSLMMRTYCH2B"
Response: <?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1">
<recurrentService>
<recurrentServiceId>501266</recurrentServiceId>
<customerId>3178692</customerId>
<customer>CustomerName</customer>
<locationId>4373022</locationId>
<location>Street, City State Zip</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>Test User,</assignedTo>
<assetList>
<asset>
<id>512704</id>
<name>asset1</name>
<serialNumber>111</serialNumber>
<assetTag>tag1</assetTag>
</asset>
<asset>
<id>512705</id>
<name>asset2</name>
<serialNumber>222</serialNumber>
<assetTag>tag2</assetTag>
</asset>
</assetList>
<serviceList>
<serviceItem>
<id>3875858</id>
<productId>1399162</productId>
<name>test product</name>
<desc>test description</desc>
<qty>1.0</qty>
<price>4.0</price>
</serviceItem>
<serviceItem>
<id>3875859</id>
<productId>1399163</productId>
<name>test service</name>
<desc>test description</desc>
<qty>2.0</qty>
<price>12.0</price>
</serviceItem>
</serviceList>
</recurrentService>
</response>