Features - Connectors Framework - Inbound REST API - Assets
List Assets
Overview
Retrieve Asset List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/asset/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
assetId By assetId
type By asset type, either name or typeId
assignedTo By assignedTo - accepts either name (lastname, firstname) or userId
name By name of asset
sku By SKU of asset
modelNumber By model number of asset
serialNumber By serial number of asset
customer By customer's name or customer's ID of the asset mapped to
Return
Returns a list of Asset Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 assets 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 -H "https://www.mobiwork.com/api/rest/12014/10.0.78/asset/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><type>vehicle</type><assignedTo>Smith, John</assignedTo></request>'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<assetList>
<totalAvailableCount>4</totalAvailableCount>
<count>4</count>
<asset>
<mobiworkAssetId>56136</mobiworkAssetId>
<externalId></externalId>
<name>Electrical Truck 20 w/lift</name>
<description>Mechanic Truck 14' CS Open Yellow</description>
<modelNumber>Mercedes EQXL</modelNumber>
<serialNumber>VIN# JI4JFU985756</serialNumber>
<warrantStartDate>2016/01/31</warrantStartDate>
<warrantEndDate>2017/02/12</warrantEndDate>
<status>Active</status>
<typeId>29</typeId>
<type>Vehicle</type>
<categoryId>4921</categoryId>
<category>Electrical Trucks </category>
<customFieldList>
<customField>
<apiName>LicenseTag</apiName>
<fieldType>1</fieldType>
<value>LIT-65K</value>
<name>License Tag</name>
</customField>
<customField>
<apiName>ServicedBy</apiName>
<fieldType>6</fieldType>
<value>Royal Palm Auto Spa</value>
<name>Serviced By</name>
</customField>
<customField>
<apiName>OilFilterNumber</apiName>
<fieldType>1</fieldType>
<value>32</value>
<name>Oil Filter Number</name>
</customField>
<customField>
<apiName>valueofassets</apiName>
<fieldType>1</fieldType>
<value>100,000</value>
<name>Value of asset</name>
</customField>
<customField>
<apiName>images</apiName>
<fieldType>25</fieldType>
<value>/clientImagesapi/document/436326/view.html?client=9hjpvpLQip4%3D</value>
<name>Additional Images</name>
</customField>
</customFieldList>
</asset>
<asset>
<mobiworkAssetId>56137</mobiworkAssetId>
<externalId></externalId>
<name>Van 26 </name>
<description>2017 Chevy Express Van</description>
<modelNumber>Chevy Express Van</modelNumber>
<serialNumber>VIN# YI8J4GJW</serialNumber>
<warrantStartDate>2016/02/29</warrantStartDate>
<warrantEndDate>2017/03/30</warrantEndDate>
<status>Active</status>
<typeId>29</typeId>
<type>Vehicle</type>
<categoryId>4923</categoryId>
<category>Vans</category>
<customFieldList>
<customField>
<apiName>LicenseTag</apiName>
<fieldType>1</fieldType>
<value>JOI-765</value>
<name>License Tag</name>
</customField>
<customField>
<apiName>ServicedBy</apiName>
<fieldType>6</fieldType>
<value>Royal Palm Auto Spa</value>
<name>Serviced By</name>
</customField>
<customField>
<apiName>OilFilterNumber</apiName>
<fieldType>1</fieldType>
<value>20</value>
<name>Oil Filter Number</name>
</customField>
<customField>
<apiName>valueofassets</apiName>
<fieldType>1</fieldType>
<value>50,000</value>
<name>Value of asset</name>
</customField>
<customField>
<apiName>images</apiName>
<fieldType>25</fieldType>
<value></value>
<name>Additional Images</name>
</customField>
</customFieldList>
</asset>