Server

<back to all web services

GetObjektList

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

// @DataContract
export class CustomerObjekt
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="ZeitraumVon")
    public ZeitraumVon: string;

    // @DataMember(Name="ZeitraumBis")
    public ZeitraumBis?: string;

    // @DataMember(Name="IstKunde")
    public IstKunde: boolean;

    // @DataMember(Name="IstEigentümer")
    public IstEigent_mer: boolean;

    // @DataMember(Name="IstEigentümerPseudo")
    public IstEigent_merPseudo: boolean;

    // @DataMember(Name="ObjektGuid")
    public ObjektGuid: string;

    // @DataMember(Name="KundeGuid")
    public KundeGuid: string;

    public constructor(init?: Partial<CustomerObjekt>) { (Object as any).assign(this, init); }
}

export class GetObjektListResponse
{
    public customerObjekteList: CustomerObjekt[];
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetObjektListResponse>) { (Object as any).assign(this, init); }
}

export class GetObjektList implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    // @ApiMember(ParameterType="query")
    public include: string;

    /** @description 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 filter_Customer_: string;

    /** @description 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 filter_Number_: string;

    /** @description 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 filter_Address_: string;

    public constructor(init?: Partial<GetObjektList>) { (Object as any).assign(this, init); }
}

TypeScript 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: fairtherm-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"}}}