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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	"User": 
	{
		"Id": 0,
		"Email": "String",
		"UserName": "String",
		"PhoneNumber": "String",
		"DisplayName": "String",
		"PhoneNumberExtension": "String",
		"PhoneNumberCountryCodeId": 0,
		"PhoneNumberCountryCode": "String",
		"MobilePhoneNumber": "String",
		"MobilePhoneNumberCountryCodeId": 0,
		"MobilePhoneNumberCountryCode": "String",
		"OrganizationUnit": "String",
		"Position": "String",
		"Status": 0,
		"SupplierId": 0,
		"SupplierOwnerId": 0,
		"Meta": 
		{
			"String": "String"
		},
		"Roles": 
		[
			"String"
		],
		"IsSupplierAdmin": true,
		"ConcurrencyStamp": "String"
	},
	"ResponseStatus": 
	{
		"ErrorCode": "String",
		"Message": "String",
		"StackTrace": "String",
		"Errors": 
		[
			{
				"ErrorCode": "String",
				"FieldName": "String",
				"Message": "String",
				"Meta": 
				{
					"String": "String"
				}
			}
		],
		"Meta": 
		{
			"String": "String"
		}
	}
}