Server

<back to all web services

GetObjektList

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models;

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models
{
    [DataContract]
    public partial class CustomerObjekt
    {
        [DataMember(Name="Guid")]
        public virtual string Guid { get; set; }

        [DataMember(Name="ZeitraumVon")]
        public virtual DateTime RangeFrom { get; set; }

        [DataMember(Name="ZeitraumBis")]
        public virtual DateTime? RangeTo { get; set; }

        [DataMember(Name="IstKunde")]
        public virtual bool IsCustomer { get; set; }

        [DataMember(Name="IstEigentümer")]
        public virtual bool IsOwner { get; set; }

        [DataMember(Name="IstEigentümerPseudo")]
        public virtual bool IsOwnerPseudo { get; set; }

        [DataMember(Name="ObjektGuid")]
        public virtual string ObjektGuid { get; set; }

        [DataMember(Name="KundeGuid")]
        public virtual string CustomerGuid { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
{
    public partial class GetObjektList
        : IHasBearerToken
    {
        [ApiMember(IsRequired=true, ParameterType="query")]
        public virtual string BearerToken { get; set; }

        [ApiMember(ParameterType="query")]
        public virtual string Include { 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")]
        public virtual Guid FilterByCustomer { 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")]
        public virtual string FilterByNumber { 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")]
        public virtual string FilterByAddress { get; set; }
    }

    public partial class GetObjektListResponse
    {
        public virtual IEnumerable<CustomerObjekt> CustomerObjekteList { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetObjektList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}