Server

<back to all web services

GetNutzerList

Nutzer
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzer
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetNutzerList : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null
}

open class GetNutzerListResponse
{
    var nutzerList:ArrayList<Nutzer> = ArrayList<Nutzer>()
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Nutzer
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var name1:String? = null

    @DataMember
    var name2:String? = null

    @DataMember
    var name3:String? = null

    @DataMember
    var name4:String? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var nutzerType:NutzerType? = null

    @DataMember
    var nutzeinheitNumberExternal:String? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var nutzerInNutzeinheitSequence:Long? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var rangeFrom:Date? = null

    @DataMember
    var rangeTo:Date? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember(Name="IstUvi")
    @SerializedName("IstUvi")
    var isUviRecieved:String? = null

    @DataMember(Name="EigentuemerBewohnt")
    @SerializedName("EigentuemerBewohnt")
    var isNutzerOwner:String? = null

    @DataMember(Name="Email")
    @SerializedName("Email")
    var email:String? = null

    @DataMember(Name="Mobil")
    @SerializedName("Mobil")
    var mobilePhone:String? = null

    @DataMember
    var title:String? = null

    @DataMember
    @ApiMember(IsRequired=true, ParameterType="body")
    var salutation:String? = null
}

enum class NutzerType
{
    Leerstand,
    Gewerblich,
    Privat,
    AllgemeineNutzung,
}

Kotlin GetNutzerList 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/nutzer HTTP/1.1 
Host: marneth-messdienst-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNutzerListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <NutzerList 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>
</GetNutzerListResponse>