Versions Compared

Old Version 6

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.12.0

The User Query REST API is used to query the list of ServiceMobility users.

Note

The result set is filtered based on the security level of the user executing the query.



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel4

Related pages:

  • REST Object Definitions User Related Objects User Object



Resource URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/query/Users/?filter=${filterOptions}&q={queryOptions}sort=${sortOptions}&limit=${limit}&customerid=xxxx&customercode=xxxx

Query Parameters

Include Page
_URI Query Parameters
_URI Query Parameters

Filters

The ${filterOptions} parameter supports the following REST Object Definitions User Related Objects User Object fields:

  • DGroupID
  • EmailFacetime
  • FirstNameIsMobileWorker
  • LanguageCode
  • LastName
  • Locked
  • ServiceTeamID
  • SMS
  • StorageLocation
  • UserID
  • UserStatusWorkCenter

Q

The ${queryOptions} supports the following REST Object Definitions User Related Objects User Object fields:

  • DGroupID
  • EmailFacetime
  • FirstName
  • LanguageCode
  • LastName
  • ServiceTeamID
  • SMS
  • StorageLocation
  • UserID
  • UserStatusWorkCenter

Sort

The ${sortOptions} supports the following REST Object Definitions User Related Objects User Object fields:

  • DGroupID
  • EmailFacetime
  • FirstName
  • LanguageCode
  • LastName
  • ServiceTeamID
  • SMS
  • StorageLocation
  • UserID
  • UserStatusWorkCenter

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Response Body

The response body contains a collection of User Objectst that match the query parameters. 

Include Page
Query Response Object
Query Response Object

Include Page
_REST Response Codes
_REST Response Codes