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.*;

public class dtos
{

    public static class GetObjektList implements IHasBearerToken
    {
        @ApiMember(IsRequired=true, ParameterType="query")
        public String bearerToken = null;

        @ApiMember(ParameterType="query")
        public String include = 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")
        public UUID filterByCustomer = 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")
        public String filterByNumber = 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")
        public String filterByAddress = null;
        
        public String getBearerToken() { return bearerToken; }
        public GetObjektList setBearerToken(String value) { this.bearerToken = value; return this; }
        public String getInclude() { return include; }
        public GetObjektList setInclude(String value) { this.include = value; return this; }
        public UUID getFilterByCustomer() { return filterByCustomer; }
        public GetObjektList setFilterByCustomer(UUID value) { this.filterByCustomer = value; return this; }
        public String getFilterByNumber() { return filterByNumber; }
        public GetObjektList setFilterByNumber(String value) { this.filterByNumber = value; return this; }
        public String getFilterByAddress() { return filterByAddress; }
        public GetObjektList setFilterByAddress(String value) { this.filterByAddress = value; return this; }
    }

    public static class GetObjektListResponse
    {
        public ArrayList<CustomerObjekt> customerObjekteList = null;
        public ResponseStatus responseStatus = null;
        
        public ArrayList<CustomerObjekt> getCustomerObjekteList() { return customerObjekteList; }
        public GetObjektListResponse setCustomerObjekteList(ArrayList<CustomerObjekt> value) { this.customerObjekteList = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetObjektListResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class CustomerObjekt
    {
        @DataMember(Name="Guid")
        @SerializedName("Guid")
        public String guid = null;

        @DataMember(Name="ZeitraumVon")
        @SerializedName("ZeitraumVon")
        public Date rangeFrom = null;

        @DataMember(Name="ZeitraumBis")
        @SerializedName("ZeitraumBis")
        public Date rangeTo = null;

        @DataMember(Name="IstKunde")
        @SerializedName("IstKunde")
        public Boolean isCustomer = null;

        @DataMember(Name="IstEigentümer")
        @SerializedName("IstEigentümer")
        public Boolean isOwner = null;

        @DataMember(Name="IstEigentümerPseudo")
        @SerializedName("IstEigentümerPseudo")
        public Boolean isOwnerPseudo = null;

        @DataMember(Name="ObjektGuid")
        @SerializedName("ObjektGuid")
        public String objektGuid = null;

        @DataMember(Name="KundeGuid")
        @SerializedName("KundeGuid")
        public String customerGuid = null;
        
        public String getGuid() { return guid; }
        public CustomerObjekt setGuid(String value) { this.guid = value; return this; }
        public Date getRangeFrom() { return rangeFrom; }
        public CustomerObjekt setRangeFrom(Date value) { this.rangeFrom = value; return this; }
        public Date getRangeTo() { return rangeTo; }
        public CustomerObjekt setRangeTo(Date value) { this.rangeTo = value; return this; }
        public Boolean getIsCustomer() { return isCustomer; }
        public CustomerObjekt setIsCustomer(Boolean value) { this.isCustomer = value; return this; }
        public Boolean getIsOwner() { return isOwner; }
        public CustomerObjekt setIsOwner(Boolean value) { this.isOwner = value; return this; }
        public Boolean getIsOwnerPseudo() { return isOwnerPseudo; }
        public CustomerObjekt setIsOwnerPseudo(Boolean value) { this.isOwnerPseudo = value; return this; }
        public String getObjektGuid() { return objektGuid; }
        public CustomerObjekt setObjektGuid(String value) { this.objektGuid = value; return this; }
        public String getCustomerGuid() { return customerGuid; }
        public CustomerObjekt setCustomerGuid(String value) { this.customerGuid = value; return this; }
    }

}

Java 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: heat-syke-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>