GET api/assets/search?skip={skip}&take={take}&sortby={sortby}&sortAscending={sortAscending}&suspended={suspended}&searchString={searchString}

Searches assets.

Request Information

URI Parameters

Name	Description	Type	Additional information
skip	Skip over this numnber of elements in the search results (e.g. 10 will discard the first 10 search results).	integer	Required
take	Return this number of elements in the search results (e.g. 50 will return 50 results).	integer	Required
sortby	The column name we wish to sort by (e.g. Name)	Velappity.Common.Enums.AssetSortableKeyEnum	Required
sortAscending	True for an ascending sort, false for descending.	boolean	Required
suspended	true if we want to include, false if we want to ignore suspended assets.	boolean	Required
searchString	Search string. searching on: Name, serial, number, type, and address	string	None.

Body Parameters

None.

Response Information

Resource Description

Array of asset results.

API.Domain.ViewModels.Asset.AssetPage

Name	Description	Type	Additional information
AssetCount		integer	None.
AssetListItems		Collection of API.Domain.ViewModels.Asset.AssetListItem	None.

Response Formats

application/json, text/json

Sample:

{
  "assetCount": 1,
  "assetListItems": [
    {
      "id": "b141b051-8f02-43fc-aebd-d682097a4f42",
      "name": "sample string 2",
      "assetTypeName": "sample string 3",
      "serialNumber": "sample string 4",
      "assetNumber": "sample string 5",
      "clientName": "sample string 6",
      "siteAddress": {
        "id": "32cfd8b2-874f-4790-b164-28c6f0cb7f04",
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "address4": "sample string 4",
        "city": "sample string 5",
        "county": "sample string 6",
        "country": "sample string 7",
        "zip": "sample string 8"
      },
      "siteName": "sample string 7",
      "suspended": true,
      "locationId": "sample string 9",
      "testTaskCount": 10,
      "uniqueBarcode": "sample string 11"
    },
    {
      "id": "b141b051-8f02-43fc-aebd-d682097a4f42",
      "name": "sample string 2",
      "assetTypeName": "sample string 3",
      "serialNumber": "sample string 4",
      "assetNumber": "sample string 5",
      "clientName": "sample string 6",
      "siteAddress": {
        "id": "32cfd8b2-874f-4790-b164-28c6f0cb7f04",
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "address4": "sample string 4",
        "city": "sample string 5",
        "county": "sample string 6",
        "country": "sample string 7",
        "zip": "sample string 8"
      },
      "siteName": "sample string 7",
      "suspended": true,
      "locationId": "sample string 9",
      "testTaskCount": 10,
      "uniqueBarcode": "sample string 11"
    }
  ]
}

text/html

Sample:

{"assetCount":1,"assetListItems":[{"id":"b141b051-8f02-43fc-aebd-d682097a4f42","name":"sample string 2","assetTypeName":"sample string 3","serialNumber":"sample string 4","assetNumber":"sample string 5","clientName":"sample string 6","siteAddress":{"id":"32cfd8b2-874f-4790-b164-28c6f0cb7f04","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"siteName":"sample string 7","suspended":true,"locationId":"sample string 9","testTaskCount":10,"uniqueBarcode":"sample string 11"},{"id":"b141b051-8f02-43fc-aebd-d682097a4f42","name":"sample string 2","assetTypeName":"sample string 3","serialNumber":"sample string 4","assetNumber":"sample string 5","clientName":"sample string 6","siteAddress":{"id":"32cfd8b2-874f-4790-b164-28c6f0cb7f04","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"siteName":"sample string 7","suspended":true,"locationId":"sample string 9","testTaskCount":10,"uniqueBarcode":"sample string 11"}]}