online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.estimate.title
List Estimates
Overview
Retrieve estimate List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/estimate/list.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
Filter or Search Criteria
description By estimate description
status By status of estimate
externalId By external ID of estimate
category By cateogry of estimate
createdDateFrom By created date of estimate
createdDateTo By created date of estimate
dueDateFrom By due date of estimate
dueDateTo By due date of estimate
Return
Returns a list of estimate Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 estimates will be returned. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: POST
Request: curl -k -X POST "https://www.mobiwork.com/api/rest/12014/5.0.141/estimate/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request><status>Status 1</status></request>'
Response: <?xml version="1.0" encoding="UTF-8" ?>
<response version="5.0.141" statusCode="1">
<estimateList>
<estimate>
<mobiworkEstimateId>123< /mobiworkEstimateId>
<externalId>null</externalId>
<description>test</description>
<status>Status 1</status>
<categoryId>4< /categoryId>
<category>Category 1</category>
<address>
<addressId>12345</addressId>
<address1>160 Congress Park Dr</address1>
< address2>!</address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
< latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary</name>
<baseDistance>123</baseDistance>
</address>
<quoteNumber>null</quoteNumber>
<dueDate>2018/01/04</dueDate>
</estimate>
</estimateList>
</response>