Trendsic Platform Service

<back to all web services

SearchUsers

The following routes are available for this service:
GET/users/search
"use strict";
export class UserSummary {
    /** @param {{UserId?:string,UserName?:string,Email?:string,CreatedUtc?:string,LastActivityUtc?:string,FirstName?:string,LastName?:string,DisplayName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    UserName;
    /** @type {string} */
    Email;
    /** @type {?string} */
    CreatedUtc;
    /** @type {?string} */
    LastActivityUtc;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
}
export class SearchUsersResponse {
    /** @param {{Results?:UserSummary[],Page?:number,PageSize?:number,Total?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserSummary[]} */
    Results = [];
    /** @type {number} */
    Page;
    /** @type {number} */
    PageSize;
    /** @type {number} */
    Total;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SearchUsers {
    /** @param {{Q?:string,Page?:number,PageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Q;
    /** @type {?number} */
    Page;
    /** @type {?number} */
    PageSize;
}

JavaScript SearchUsers 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 /users/search HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			UserId: 00000000000000000000000000000000,
			UserName: String,
			Email: String,
			CreatedUtc: 0001-01-01,
			LastActivityUtc: 0001-01-01,
			FirstName: String,
			LastName: String,
			DisplayName: String String
		}
	],
	Page: 0,
	PageSize: 0,
	Total: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}