Server

<back to all web services

GetNutzerList

Nutzer
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzer
import Foundation
import ServiceStack

public class GetNutzerList : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public var bearerToken:String

    required public init(){}
}

public class GetNutzerListResponse : Codable
{
    public var nutzerList:[Nutzer] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Nutzer : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var name1:String

    // @DataMember
    public var name2:String

    // @DataMember
    public var name3:String

    // @DataMember
    public var name4:String

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

    // @DataMember
    public var nutzeinheitNumberExternal:String

    // @DataMember
    // @ApiMember(IsRequired=true)
    public var nutzerInNutzeinheitSequence:UInt32

    // @DataMember
    // @ApiMember(IsRequired=true)
    public var rangeFrom:Date

    // @DataMember
    public var rangeTo:Date?

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember(Name="IstUvi")
    public var IstUvi:String

    // @DataMember(Name="EigentuemerBewohnt")
    public var EigentuemerBewohnt:String

    // @DataMember(Name="Email")
    public var Email:String

    // @DataMember(Name="Mobil")
    public var Mobil:String

    // @DataMember
    public var title:String

    // @DataMember
    // @ApiMember(IsRequired=true, ParameterType="body")
    public var salutation:String

    required public init(){}
}

public enum NutzerType : String, Codable
{
    case Leerstand
    case Gewerblich
    case Privat
    case AllgemeineNutzung
}


Swift 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: messdienstservice-stadtwerke-peine-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
		}
	}
}