Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
GetObjektList Parameters:
NameParameterData TypeRequiredDescription
BearerTokenquerystringYes
IncludequerystringNo

Allowable Values

  • nutzeinheiten
  • devices
  • consumptions
FilterByCustomerqueryGuidNoOptional! Follow the format : /api/v1/objekte?filter[Customer]=*
FilterByNumberquerystringNoOptional! Follow the format : /api/v1/objekte?filter[Number]=*
FilterByAddressquerystringNoOptional! Follow the format : /api/v1/objekte?filter[Address]=*
GetObjektListResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerObjekteListformIEnumerable<CustomerObjekt>No
ResponseStatusformResponseStatusNo
CustomerObjekt Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
RangeFromformDateTimeNo
RangeToformDateTime?No
IsCustomerformboolNo
IsOwnerformboolNo
IsOwnerPseudoformboolNo
ObjektGuidformstringNo
CustomerGuidformstringNo

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

HTTP + CSV

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

GET /api/v1/objekte/ HTTP/1.1 
Host: demo-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}