Smart Data Solutions Data Api

<back to all web services

Asset

Get (list of) asset(s)

The following routes are available for this service:
GET/assetsShow list of all assets/meteringpoints linked to the provided ApiKey
GET/assets/{Id}Get detailed info of single asset
Asset Parameters:
NameParameterData TypeRequiredDescription
IdpathString/GuidYesThe id of the asset the usages are requested for
ShowDetailedInListqueryBooleanNoCreate a list of asset objects with detailed info. Default value: FALSE
SkipqueryIntegerNoSkip first ... assets, can be used for paging purposes. Default value: 0
TakequeryIntegerNoTake next ... assets, can be used for paging purposes. Default value: 25
CacheKeyquerystringNo
Generic Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformStringYesApi-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
OnlyPayloadformBooleanNoNormally the result of the request is put inside a resultobject with some status information about the request. If you want the output as csv this outer object can be irritating. Default value: FALSE
ShowRequestformBooleanNoShow the request as interpreted by the api. Useful to see how filters / dates are parsed. If no value us provided, the default value is: FALSE
DateTimeFormatformEnumNoFormat all DateTime in the response object. If used in browser, sometimes ISO8601 is not correctly transformed. Enum options: ISO8601 (DEFAULT), UTC, NL, NLOffset, Unix, UnixMillis

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/oneway/Asset HTTP/1.1 
Host: data.smartdatasolutions.nl 
Content-Type: application/xml
Content-Length: length

<Asset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SDS.Backend.APIs.DataApi.DTO.Request">
  <ApiKey>String</ApiKey>
  <DateTimeFormat>ISO8601</DateTimeFormat>
  <OnlyPayload>false</OnlyPayload>
  <ShowRequest>false</ShowRequest>
  <Id>String</Id>
  <ShowDetailedInList>false</ShowDetailedInList>
  <Skip>0</Skip>
  <Take>0</Take>
</Asset>