Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetObjektList : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    @ApiMember(ParameterType="query")
    var include:String? = null

    /**
    * Optional! Follow the format : /api/v1/objekte?filter[Customer]=*
    */
    @DataMember(Name="filter[Customer]")
    @SerializedName("filter[Customer]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Customer]=*", ParameterType="query")
    var filterByCustomer:UUID? = null

    /**
    * Optional! Follow the format : /api/v1/objekte?filter[Number]=*
    */
    @DataMember(Name="filter[Number]")
    @SerializedName("filter[Number]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Number]=*", ParameterType="query")
    var filterByNumber:String? = null

    /**
    * Optional! Follow the format : /api/v1/objekte?filter[Address]=*
    */
    @DataMember(Name="filter[Address]")
    @SerializedName("filter[Address]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Address]=*", ParameterType="query")
    var filterByAddress:String? = null
}

open class GetObjektListResponse
{
    var customerObjekteList:ArrayList<CustomerObjekt> = ArrayList<CustomerObjekt>()
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class CustomerObjekt
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="ZeitraumVon")
    @SerializedName("ZeitraumVon")
    var rangeFrom:Date? = null

    @DataMember(Name="ZeitraumBis")
    @SerializedName("ZeitraumBis")
    var rangeTo:Date? = null

    @DataMember(Name="IstKunde")
    @SerializedName("IstKunde")
    var isCustomer:Boolean? = null

    @DataMember(Name="IstEigentümer")
    @SerializedName("IstEigentümer")
    var isOwner:Boolean? = null

    @DataMember(Name="IstEigentümerPseudo")
    @SerializedName("IstEigentümerPseudo")
    var isOwnerPseudo:Boolean? = null

    @DataMember(Name="ObjektGuid")
    @SerializedName("ObjektGuid")
    var objektGuid:String? = null

    @DataMember(Name="KundeGuid")
    @SerializedName("KundeGuid")
    var customerGuid:String? = null
}

Kotlin GetObjektList DTOs

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.

GET /api/v1/objekte/ HTTP/1.1 
Host: marneth-messdienst-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjektListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <CustomerObjekteList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetObjektListResponse>