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}

export class ResponseBase
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ResponseBase>) { (Object as any).assign(this, init); }
}

export class ModifyRequestBase implements IConcurrencyStamp
{
    public ConcurrencyStamp: string;

    public constructor(init?: Partial<ModifyRequestBase>) { (Object as any).assign(this, init); }
}

export enum ApplicationUserStatus
{
    Registered = 0,
    ConfirmedByUser = 1,
    SupplierUserRegistered = 2,
    AwaitingSupplierConfirmation = 3,
    AwaitingVeoliaConfirmation = 4,
    Active = 5,
    Rejected = 6,
    Deleted = 7,
}

export class UserDetails extends ModifyRequestBase
{
    public Id: number;
    public Email: string;
    public UserName: string;
    public PhoneNumber: string;
    public DisplayName: string;
    public PhoneNumberExtension: string;
    public PhoneNumberCountryCodeId?: number;
    public PhoneNumberCountryCode: string;
    public MobilePhoneNumber: string;
    public MobilePhoneNumberCountryCodeId?: number;
    public MobilePhoneNumberCountryCode: string;
    public OrganizationUnit: string;
    public Position: string;
    public Status: ApplicationUserStatus;
    public SupplierId?: number;
    public SupplierOwnerId?: number;
    public Meta: { [index: string]: string; };
    public Roles: string[];
    public IsSupplierAdmin: boolean;

    public constructor(init?: Partial<UserDetails>) { super(init); (Object as any).assign(this, init); }
}

export class BrowseUserResponse extends ResponseBase
{
    public User: UserDetails;

    public constructor(init?: Partial<BrowseUserResponse>) { super(init); (Object as any).assign(this, init); }
}

export class BrowseUser implements IGet
{
    public UserId: number;

    public constructor(init?: Partial<BrowseUser>) { (Object as any).assign(this, init); }
}

TypeScript 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>