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}
namespace Portal.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ResponseBase() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ModifyRequestBase() = 
        member val ConcurrencyStamp:String = null with get,set

    type ApplicationUserStatus =
        | Registered = 0
        | ConfirmedByUser = 1
        | SupplierUserRegistered = 2
        | AwaitingSupplierConfirmation = 3
        | AwaitingVeoliaConfirmation = 4
        | Active = 5
        | Rejected = 6
        | Deleted = 7

    [<AllowNullLiteral>]
    type UserDetails() = 
        inherit ModifyRequestBase()
        member val Id:Int32 = new Int32() with get,set
        member val Email:String = null with get,set
        member val UserName:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val DisplayName:String = null with get,set
        member val PhoneNumberExtension:String = null with get,set
        member val PhoneNumberCountryCodeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PhoneNumberCountryCode:String = null with get,set
        member val MobilePhoneNumber:String = null with get,set
        member val MobilePhoneNumberCountryCodeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MobilePhoneNumberCountryCode:String = null with get,set
        member val OrganizationUnit:String = null with get,set
        member val Position:String = null with get,set
        member val Status:ApplicationUserStatus = new ApplicationUserStatus() with get,set
        member val SupplierId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SupplierOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val IsSupplierAdmin:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BrowseUserResponse() = 
        inherit ResponseBase()
        member val User:UserDetails = null with get,set

    [<AllowNullLiteral>]
    type BrowseUser() = 
        interface IGet
        member val UserId:Int32 = new Int32() with get,set

F# 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>