Server

<back to all web services

GetObjektList

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

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

        <DataContract>
        Public Partial Class CustomerObjekt
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As String

            <DataMember(Name:="ZeitraumVon")>
            Public Overridable Property RangeFrom As Date

            <DataMember(Name:="ZeitraumBis")>
            Public Overridable Property RangeTo As Nullable(Of Date)

            <DataMember(Name:="IstKunde")>
            Public Overridable Property IsCustomer As Boolean

            <DataMember(Name:="IstEigentümer")>
            Public Overridable Property IsOwner As Boolean

            <DataMember(Name:="IstEigentümerPseudo")>
            Public Overridable Property IsOwnerPseudo As Boolean

            <DataMember(Name:="ObjektGuid")>
            Public Overridable Property ObjektGuid As String

            <DataMember(Name:="KundeGuid")>
            Public Overridable Property CustomerGuid As String
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetObjektList
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            <ApiMember(ParameterType:="query")>
            Public Overridable Property Include As String

            '''<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 Overridable Property FilterByCustomer As Guid

            '''<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 Overridable Property FilterByNumber As String

            '''<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 Overridable Property FilterByAddress As String
        End Class

        Public Partial Class GetObjektListResponse
            Public Overridable Property CustomerObjekteList As IEnumerable(Of CustomerObjekt)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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: andreiuologmbh-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"}}}