Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
import Foundation
import ServiceStack

public class GetObjektList : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public var bearerToken:String

    // @ApiMember(ParameterType="query")
    public var include:String

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

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

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

    required public init(){}
}

public class GetObjektListResponse : Codable
{
    public var customerObjekteList:[CustomerObjekt] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class CustomerObjekt : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="ZeitraumVon")
    public var ZeitraumVon:Date

    // @DataMember(Name="ZeitraumBis")
    public var ZeitraumBis:Date?

    // @DataMember(Name="IstKunde")
    public var IstKunde:Bool

    // @DataMember(Name="IstEigentümer")
    public var IstEigent_mer:Bool

    // @DataMember(Name="IstEigentümerPseudo")
    public var IstEigent_merPseudo:Bool

    // @DataMember(Name="ObjektGuid")
    public var ObjektGuid:String

    // @DataMember(Name="KundeGuid")
    public var KundeGuid:String

    required public init(){}
}

Swift GetObjektList DTOs

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: brendle-schneider-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"}}}