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 .jsv suffix or ?format=jsv

HTTP + JSV

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: elotesch-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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