Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerObjekt() = 
        [<DataMember(Name="Guid")>]
        member val Guid:String = null with get,set

        [<DataMember(Name="ZeitraumVon")>]
        member val RangeFrom:DateTime = new DateTime() with get,set

        [<DataMember(Name="ZeitraumBis")>]
        member val RangeTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Name="IstKunde")>]
        member val IsCustomer:Boolean = new Boolean() with get,set

        [<DataMember(Name="IstEigentümer")>]
        member val IsOwner:Boolean = new Boolean() with get,set

        [<DataMember(Name="IstEigentümerPseudo")>]
        member val IsOwnerPseudo:Boolean = new Boolean() with get,set

        [<DataMember(Name="ObjektGuid")>]
        member val ObjektGuid:String = null with get,set

        [<DataMember(Name="KundeGuid")>]
        member val CustomerGuid:String = null with get,set

    [<AllowNullLiteral>]
    type GetObjektListResponse() = 
        member val CustomerObjekteList:IEnumerable<CustomerObjekt> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetObjektList() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with get,set

        [<ApiMember(ParameterType="query")>]
        member val Include:String = null with get,set

        ///<summary>
        ///Optional! Follow the format : /api/v1/objekte?filter[Customer]=*
        ///</summary>
        [<DataMember(Name="filter[Customer]")>]
        [<ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Customer]=*", ParameterType="query")>]
        member val FilterByCustomer:Guid = new Guid() with get,set

        ///<summary>
        ///Optional! Follow the format : /api/v1/objekte?filter[Number]=*
        ///</summary>
        [<DataMember(Name="filter[Number]")>]
        [<ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Number]=*", ParameterType="query")>]
        member val FilterByNumber:String = null with get,set

        ///<summary>
        ///Optional! Follow the format : /api/v1/objekte?filter[Address]=*
        ///</summary>
        [<DataMember(Name="filter[Address]")>]
        [<ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Address]=*", ParameterType="query")>]
        member val FilterByAddress:String = null with get,set

F# 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: develop-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>