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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Portal.ServiceDto
Imports Portal.Common

Namespace Global

    Namespace Portal.Common

        Public Enum ApplicationUserStatus
            Registered = 0
            ConfirmedByUser = 1
            SupplierUserRegistered = 2
            AwaitingSupplierConfirmation = 3
            AwaitingVeoliaConfirmation = 4
            Active = 5
            Rejected = 6
            Deleted = 7
        End Enum
    End Namespace

    Namespace Portal.ServiceDto

        Public Partial Class BrowseUser
            Implements IGet
            Public Overridable Property UserId As Integer
        End Class

        Public Partial Class BrowseUserResponse
            Inherits ResponseBase
            Public Overridable Property User As UserDetails
        End Class

        Public Partial Class ModifyRequestBase
            Implements IConcurrencyStamp
            Public Overridable Property ConcurrencyStamp As String
        End Class

        Public Partial Class ResponseBase
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class UserDetails
            Inherits ModifyRequestBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
                Roles = New List(Of String)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property Email As String
            Public Overridable Property UserName As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property DisplayName As String
            Public Overridable Property PhoneNumberExtension As String
            Public Overridable Property PhoneNumberCountryCodeId As Nullable(Of Integer)
            Public Overridable Property PhoneNumberCountryCode As String
            Public Overridable Property MobilePhoneNumber As String
            Public Overridable Property MobilePhoneNumberCountryCodeId As Nullable(Of Integer)
            Public Overridable Property MobilePhoneNumberCountryCode As String
            Public Overridable Property OrganizationUnit As String
            Public Overridable Property Position As String
            Public Overridable Property Status As ApplicationUserStatus
            Public Overridable Property SupplierId As Nullable(Of Integer)
            Public Overridable Property SupplierOwnerId As Nullable(Of Integer)
            Public Overridable Property Meta As Dictionary(Of String, String)
            Public Overridable Property Roles As List(Of String)
            Public Overridable Property IsSupplierAdmin As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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>