| GET | /api/v1/objekte/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BearerToken | query | string | Yes | |
| Include | query | string | No | Allowable Values
|
| FilterByCustomer | query | Guid | No | Optional! Follow the format : /api/v1/objekte?filter[Customer]=* |
| FilterByNumber | query | string | No | Optional! Follow the format : /api/v1/objekte?filter[Number]=* |
| FilterByAddress | query | string | No | Optional! Follow the format : /api/v1/objekte?filter[Address]=* |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerObjekteList | form | IEnumerable<CustomerObjekt> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| IsCustomer | form | bool | No | |
| IsOwner | form | bool | No | |
| IsOwnerPseudo | form | bool | No | |
| ObjektGuid | form | string | No | |
| CustomerGuid | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: messdienstservice-stadtwerke-peine-servdesk.eras-online.de Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}