Server

<back to all web services

GetNutzerList

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

export enum NutzerType
{
    Leerstand = 'Leerstand',
    Gewerblich = 'Gewerblich',
    Privat = 'Privat',
    AllgemeineNutzung = 'AllgemeineNutzung',
}

// @DataContract
export class Nutzer
{
    // @DataMember
    public guid: string;

    // @DataMember
    public name1: string;

    // @DataMember
    public name2: string;

    // @DataMember
    public name3: string;

    // @DataMember
    public name4: string;

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

    // @DataMember
    public nutzeinheitNumberExternal: string;

    // @DataMember
    // @ApiMember(IsRequired=true)
    public nutzerInNutzeinheitSequence: number;

    // @DataMember
    // @ApiMember(IsRequired=true)
    public rangeFrom: string;

    // @DataMember
    public rangeTo?: string;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember(Name="IstUvi")
    public IstUvi: string;

    // @DataMember(Name="EigentuemerBewohnt")
    public EigentuemerBewohnt: string;

    // @DataMember(Name="Email")
    public Email: string;

    // @DataMember(Name="Mobil")
    public Mobil: string;

    // @DataMember
    public title: string;

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

    public constructor(init?: Partial<Nutzer>) { (Object as any).assign(this, init); }
}

export class GetNutzerListResponse
{
    public nutzerList: Nutzer[];
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetNutzerListResponse>) { (Object as any).assign(this, init); }
}

export class GetNutzerList implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    public constructor(init?: Partial<GetNutzerList>) { (Object as any).assign(this, init); }
}

TypeScript 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: calotec-portal-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
		}
	}
}