Server

<back to all web services

PutNutzer

Nutzer
Requires Authentication
The following routes are available for this service:
PUT/api/v1/nutzer
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutNutzerResponse:
    response_status: Optional[ResponseStatus] = None


class NutzerType(str, Enum):
    LEERSTAND = 'Leerstand'
    GEWERBLICH = 'Gewerblich'
    PRIVAT = 'Privat'
    ALLGEMEINE_NUTZUNG = 'AllgemeineNutzung'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Nutzer:
    guid: Optional[str] = None
    name1: Optional[str] = None
    name2: Optional[str] = None
    name3: Optional[str] = None
    name4: Optional[str] = None
    # @ApiMember(IsRequired=true)
    nutzer_type: Optional[NutzerType] = None

    nutzeinheit_number_external: Optional[str] = None
    # @ApiMember(IsRequired=true)
    nutzer_in_nutzeinheit_sequence: int = 0

    # @ApiMember(IsRequired=true)
    range_from: datetime.datetime = datetime.datetime(1, 1, 1)

    range_to: Optional[datetime.datetime] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    is_uvi_recieved: Optional[str] = None
    is_nutzer_owner: Optional[str] = None
    email: Optional[str] = None
    mobile_phone: Optional[str] = None
    title: Optional[str] = None
    # @ApiMember(IsRequired=true, ParameterType="body")
    salutation: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelatedTo:
    guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutNutzer(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="body")
    nutzer: Optional[Nutzer] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_nutzeinheit: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    bearer_token: Optional[str] = None

Python PutNutzer 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.

PUT /api/v1/nutzer HTTP/1.1 
Host: korrekt-gera-servdesk.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	nutzer: 
	{
		guid: 00000000000000000000000000000000,
		name1: String,
		name2: String,
		name3: String,
		name4: String,
		nutzerType: Leerstand,
		nutzeinheitNumberExternal: String,
		nutzerInNutzeinheitSequence: 0,
		rangeFrom: 0001-01-01T00:00:00Z,
		rangeTo: 0001-01-01T00:00:00Z,
		isDeleted: False,
		isCreatedByApp: False,
		IstUvi: String,
		EigentuemerBewohnt: String,
		Email: String,
		Mobil: String,
		title: String,
		salutation: String
	},
	relatedToNutzeinheit: 
	{
		guid: 00000000000000000000000000000000
	},
	bearerToken: String
}
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
		}
	}
}