Portal

<back to all web services

BrowseCurrentUser

Requires Authentication
The following routes are available for this service:
GET/user/current
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 ResponseBase:
    response_status: Optional[ResponseStatus] = None


class BusinessType(IntEnum):
    COMPANY = 0
    PRIVATE_ENTREPRENEUR = 1
    NON_PROFIT = 2
    LAW_OFFICE = 3


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierSimple:
    id: int = 0
    owner_id: int = 0
    vat_number: Optional[str] = None
    business_type: Optional[BusinessType] = None
    country_id: int = 0
    name: Optional[str] = None
    short_name: Optional[str] = None
    registration_number: Optional[str] = None
    established_date: datetime.datetime = datetime.datetime(1, 1, 1)
    registration_date: datetime.datetime = datetime.datetime(1, 1, 1)
    duns: Optional[str] = None
    operating_license_number: Optional[str] = None
    is_accounting: bool = False
    is_small_tax_payer: bool = False
    email: Optional[str] = None
    phone_number: Optional[str] = None
    website: Optional[str] = None


class SupplierStatus(IntEnum):
    REGISTERED = 0
    AWAITING_VEOLIA_CONFIRMATION = 1
    ACTIVE = 2
    REJECTED = 3
    LOCKED = 4
    DELETED = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CurrentSupplier(SupplierSimple):
    status: Optional[SupplierStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CurrentUser:
    id: int = 0
    email: Optional[str] = None
    user_name: Optional[str] = None
    phone_number: Optional[str] = None
    display_name: Optional[str] = None
    organization_unit: Optional[str] = None
    position: Optional[str] = None
    status: int = 0
    supplier: Optional[CurrentSupplier] = None
    roles: Optional[List[str]] = None
    permissions: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseCurrentUserResponse(ResponseBase):
    user: Optional[CurrentUser] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseCurrentUser(IGet):
    pass

Python BrowseCurrentUser 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 /user/current HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowseCurrentUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <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>
  <User>
    <DisplayName>String</DisplayName>
    <Email>String</Email>
    <Id>0</Id>
    <OrganizationUnit>String</OrganizationUnit>
    <Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Permissions>
    <PhoneNumber>String</PhoneNumber>
    <Position>String</Position>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Roles>
    <Status>0</Status>
    <Supplier>
      <BusinessType>Company</BusinessType>
      <CountryId>0</CountryId>
      <Duns>String</Duns>
      <Email>String</Email>
      <EstablishedDate>0001-01-01T00:00:00</EstablishedDate>
      <Id>0</Id>
      <IsAccounting>false</IsAccounting>
      <IsSmallTaxPayer>false</IsSmallTaxPayer>
      <Name>String</Name>
      <OperatingLicenseNumber>String</OperatingLicenseNumber>
      <OwnerId>0</OwnerId>
      <PhoneNumber>String</PhoneNumber>
      <RegistrationDate>0001-01-01T00:00:00</RegistrationDate>
      <RegistrationNumber>String</RegistrationNumber>
      <ShortName>String</ShortName>
      <VatNumber>String</VatNumber>
      <Website>String</Website>
      <Status>Registered</Status>
    </Supplier>
    <UserName>String</UserName>
  </User>
</BrowseCurrentUserResponse>