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 .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 /users/search HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Page>0</Page>
  <PageSize>0</PageSize>
  <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>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal.Models">
    <d2p1:UserSummary>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastActivityUtc>0001-01-01T00:00:00</d2p1:LastActivityUtc>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:UserSummary>
  </Results>
  <Total>0</Total>
</SearchUsersResponse>