REST Query REST APIs Users Query API

Resource URL

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

Parameter	Description
customerid	Identifies the unique customer id assigned by ServicePower. This value will never change. This property is being deprecated in favor of JSON Web Token support via the x-access-token HTTP header.
customercode	Identifies the unique customer code associated with the Customer and assigned by ServicePower. The Customer should keep this code confidential. If required, such as an IT employee being released from the Customer's organization, a new customer code can be requested. This property is being deprecated in favor of JSON Web Token support via the x-access-token HTTP header.
filter	The `filter` parameter syntax is: filter=field:value,filter:field:value,... `field =` Identified the field name of the object to filter against `value =` Identifies the value to be matched against the field The `filter` parameter is used to quickly reduce the result set based on the field values provided. Although the filter is case-insensitive it does preform an exact match. Example: filter=WorkCenter:EastCoast This will return all objects where the `WorkCenter` field has a value of `EastCoast`
limit	Identifies the maximum number of objects to be returned.
q	The `q` parameter syntax is: q=<search term>::in:field-1,field-2 The `q` (query) parameter supports partial term matches across multiple fields. For example, a search_term of Joh will match John, John's, Johansson, Johansen. The query parameter currently supports one search term, although it can be combined with the `filter` parameter.
sort	Identifies the field name that should be used for sorting. The sort syntax is: sort=[-]field-1,[-]field-2 field-1 = The field name to sort against [ - ] = Optional value that identifies the field is to be sorted in descending order
start	Identifies the number of objects to be skipped. This is used for pagination and allows skipping previously returned objects.

Filters

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

DGroupID
Email
Facetime
FirstName
IsMobileWorker
LanguageCode
LastName
Locked
ServiceTeamID
SMS
StorageLocation
UserID
UserStatus

Q

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

DGroupID
Email
Facetime
FirstName
LanguageCode
LastName
ServiceTeamID
SMS
StorageLocation
UserID
UserStatus

Sort

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

DGroupID
Email
Facetime
FirstName
LanguageCode
LastName
ServiceTeamID
SMS
StorageLocation
UserID
UserStatus

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

HTTP Response Body

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

JSON Format

 {
    "TotalRecords" : 0,
    "Items" : [
		{
			// object definition 
		}
    ]
}

HTTP Response

Response Codes

HTTP Code	Description
200	OK. Request was processed successfully. Even though the request may return a successful code of 200, the body may still contain warning details.
400	Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.
401	Unauthorized. The credentials are incorrect, please verify and try again.
404	Not Found. The URL is incorrect, please verify and try again.
405	The specified HTTP method is not supported for this resource.
409	Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.
410	The specified object does not exists. Please verify the URI.
500	An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

Property

Type

Description

code

integer

The HTTP response code.

detail

object

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

Property	Type	Description
message	string	A human readable message related to the processing of the request.
params	collection	A collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPath	string	Identifies the location within the request body the message refers to.