Portal

<back to all web services

BrowseUser

Requires Authentication
Requires any of the roles:VeoliaAdmin, SupplierAdmin, UserRegistration, User
The following routes are available for this service:
GET/user/{userid}
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


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


class ApplicationUserStatus(IntEnum):
    REGISTERED = 0
    CONFIRMED_BY_USER = 1
    SUPPLIER_USER_REGISTERED = 2
    AWAITING_SUPPLIER_CONFIRMATION = 3
    AWAITING_VEOLIA_CONFIRMATION = 4
    ACTIVE = 5
    REJECTED = 6
    DELETED = 7


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserDetails(ModifyRequestBase):
    id: int = 0
    email: Optional[str] = None
    user_name: Optional[str] = None
    phone_number: Optional[str] = None
    display_name: Optional[str] = None
    phone_number_extension: Optional[str] = None
    phone_number_country_code_id: Optional[int] = None
    phone_number_country_code: Optional[str] = None
    mobile_phone_number: Optional[str] = None
    mobile_phone_number_country_code_id: Optional[int] = None
    mobile_phone_number_country_code: Optional[str] = None
    organization_unit: Optional[str] = None
    position: Optional[str] = None
    status: Optional[ApplicationUserStatus] = None
    supplier_id: Optional[int] = None
    supplier_owner_id: Optional[int] = None
    meta: Optional[Dict[str, str]] = None
    roles: Optional[List[str]] = None
    is_supplier_admin: bool = False


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseUser(IGet):
    user_id: int = 0

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

<BrowseUserResponse 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>
    <ConcurrencyStamp>String</ConcurrencyStamp>
    <DisplayName>String</DisplayName>
    <Email>String</Email>
    <Id>0</Id>
    <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>
    </Meta>
    <MobilePhoneNumber>String</MobilePhoneNumber>
    <MobilePhoneNumberCountryCode>String</MobilePhoneNumberCountryCode>
    <MobilePhoneNumberCountryCodeId>0</MobilePhoneNumberCountryCodeId>
    <OrganizationUnit>String</OrganizationUnit>
    <PhoneNumber>String</PhoneNumber>
    <PhoneNumberCountryCode>String</PhoneNumberCountryCode>
    <PhoneNumberCountryCodeId>0</PhoneNumberCountryCodeId>
    <PhoneNumberExtension>String</PhoneNumberExtension>
    <Position>String</Position>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Roles>
    <Status>Registered</Status>
    <SupplierId>0</SupplierId>
    <SupplierOwnerId>0</SupplierOwnerId>
    <UserName>String</UserName>
  </User>
</BrowseUserResponse>