Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
"use strict";
export class CustomerObjekt {
    /** @param {{Guid?:string,ZeitraumVon?:string,ZeitraumBis?:string,IstKunde?:boolean,IstEigent_mer?:boolean,IstEigent_merPseudo?:boolean,ObjektGuid?:string,KundeGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    ZeitraumVon;
    /** @type {?string} */
    ZeitraumBis;
    /** @type {boolean} */
    IstKunde;
    /** @type {boolean} */
    IstEigent_mer;
    /** @type {boolean} */
    IstEigent_merPseudo;
    /** @type {string} */
    ObjektGuid;
    /** @type {string} */
    KundeGuid;
}
export class GetObjektListResponse {
    /** @param {{customerObjekteList?:CustomerObjekt[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CustomerObjekt[]} */
    customerObjekteList;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetObjektList {
    /** @param {{bearerToken?:string,include?:string,filter_Customer_?:string,filter_Number_?:string,filter_Address_?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /** @type {string} */
    include;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/objekte?filter[Customer]=* */
    filter_Customer_;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/objekte?filter[Number]=* */
    filter_Number_;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/objekte?filter[Address]=* */
    filter_Address_;
}

JavaScript 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: mi-waerme-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>