Methods

getGroups

Get a list of account groups.

Response

WmGroupsResult

getAccountsByGroupID

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to findAccountsByGroupId(). Both service calls have identical parameters, response type, and behavior.

findAccountsByGroupId

Get a list of accounts by group and/or status. Legacy groups must be enabled on the platform for this method to function correctly.

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

Please, use findAccountsBy() instead.

Parameters

name	type	required	nillable	description
`groupID`	`long`	`true`	`false`	A valid account group ID (5-19).
`active`	`boolean`	`false`	`true`	FALSE — inactive (disabled) TRUE — active By default returns all.

Response

WmAccountsResult

findAccountsByLocation

Get a list of user accounts by location UUID.

Deprecation Notice

As of SOAP API v7.1 this method is deprecated and will be removed in the future versions.

Please, use findAccountsBy() instead.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing country, or area, or store.
`page`	`int`	`false`	`true`	The page to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

A list of user accounts, which belong to the given country, area, or store.

WmAccountsResult

findAccountsUpdatedSince

Get a list of user accounts which were updated since the given timestamp.

Deprecation Notice

As of SOAP API v7.1 this method is deprecated and will be removed in the future versions.

Please, use findAccountsBy() instead.

Parameters

name	type	required	nillable	description
`timestamp`	`string`	`true`	`false`	A date/time string in ISO 8601 format.
`page`	`int`	`false`	`true`	The page to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

WmAccountsResult

findAccountsByCustomField

Get a list of user accounts by custom field reference and value.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing custom field. File and Text Box custom fields cannot be retrieved.
`value`	`string`	`true`	`false`	Value of the custom field. If the field is a checkbox, the string value will be converted to a boolean. If the field is a date, the date string in must be in ISO 8601 format.
`page`	`int`	`false`	`true`	The `page` to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

WmAccountsResult

findAccountsBy

Get a list of user accounts based on the criteria provided

Parameters

name	type	required	nillable	description
`criteria`	`WmAccountCriteriaInput`	`true`	`false`	Criteria to identify accounts required. All criteria provided will be utilised using intersection (and) statements.
`page`	`int`	`false`	`true`	The page to start searching from (each page is limited to 1000 records). The value must be a natural number less than 23¹. If no page is provided, all results will be returned.

Response

WmAccountsResult

getAccountByUuid

Get user account by UUID.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.

Response

WmAccountResult

getAccountsByUuids

Get a list of user accounts by UUIDs.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUIDs of existing user accounts.

Response

WmAccountsResult

addAccount

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to createAccount(). Both service calls have identical parameters, response type, and behavior.

createAccount

Add a new account.

Currently, it is not possible to add/update the following account groups (applies to updateAccountPassword method as well):

ID	Name
4	Universal Manager
20	Mystery Shopper
50	T2 Admin
51	T2 Teacher
52	T2 AAC

Parameters

name	type	required	nillable	description
`account`	`WmAccountInput`	`true`	`false`

Response

WmAccountResult

updateAccount

Update an account.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.
`account`	`WmAccountInput`	`true`	`false`

Response

WmAccountResult

updateAccountStatus

Update an account’s status as well as sending an exit interview (if chosen to).

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.
`active`	`boolean`	`true`	`false`	Set the active status of the account.
`skipExitInterview`	`boolean`	`false`	`true`	Flag indicating whether or not to send an exit interview. This will only send an exit interview when updating status from active to inactive. Defaults to `false`.

Response

WmTextResult

changePassword

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to updateAccountPassword(). Both service calls have identical parameters, response type, and behavior.

updateAccountPassword

Change the password for a user.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.
`password`	`string`	`true`	`false`	The new password.

Response

WmTextResult

sendExitInterview

Send exit interview to a user.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.

Response

WmTextResult

getCountries

Get a list of all countries in the system.

Response

WmCountriesResult

findAreasByLocation

Get a list of areas by location UUID.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing user account.
`page`	`int`	`false`	`true`	The `page` to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

If the given UUID represents a store, the method will return a list with a single area — the one that the store belongs to.

If the given UUID represents an area, the method will return a list with a single area — the area itself.

If the given UUID represents a country, the method will return a list of all areas, which belong to the country.

WmAreasResult

findAreasUpdatedSince

Get a list of areas which were updated since the given timestamp.

Parameters

name	type	required	nillable	description
`timestamp`	`string`	`true`	`false`	A date/time string in ISO 8601 format.
`page`	`int`	`false`	`true`	The `page` to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

WmAreasResult

getAreaByUuid

Get an area by UUID.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing area.

Response

WmAreaResult

getAreasByUuids

Get a list of areas by UUIDs.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUIDs of an existing area.

Response

WmAreasResult

addArea

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to createArea(). Both service calls have identical parameters, response type, and behavior.

createArea

Add a new area.

Parameters

name	type	required	nillable	description
`area`	`WmAreaInput[]`	`true`	`false`

Response

WmAreaResult

updateArea

Update an existing area.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing area.
`area`	`WmAreaInput`	`true`	`false`

Response

WmAreaResult

findStoresByLocation

Get a list of stores by location UUID.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing country, or area, or store.
`page`	`int`	`false`	`true`	The `page` to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

If the given UUID represents a country or an area, the method will return a list of all stores, which belong to the country or the area, respectively.

If the given UUID represents a store, the method will return a list with a single store — the store itself.

WmStoresResult

findStoresByCustomField

Get a list of stores by custom field reference and value.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing custom field. File custom fields cannot be retrieved.
`value`	`string`	`true`	`false`	Value of the custom field. If the field is a checkbox, the string value will be converted to a boolean. If the field is a date, the date string in must be in ISO 8601 format.
`page`	`int`	`false`	`true`	The page to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

WmStoresResult

findStoresUpdatedSince

Get a list of stores which were updated since the given timestamp.

Parameters

name	type	required	nillable	description
`timestamp`	`string`	`true`	`false`	A date/time string in ISO 8601 format.
`page`	`int`	`false`	`true`	The page to start searching from (each page is limited to 1000 records). The value must be a natural number less than 2³¹. If no page is provided, all results will be returned.

Response

WmStoresResult

getLocationByUuid

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to getStoreByUuid(). Both service calls have identical parameters, response type, and behavior.

getStoreByUuid

Get a store by UUID.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing store.

Response

WmStoreResult

getStoresByUuids

Get a list of stores by UUIDs.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUIDs of existing stores.

Response

WmStoresResult

addLocation

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to createStore(). Both service calls have identical parameters, response type, and behavior.

createStore

Add a new location.

Parameters

name	type	required	nillable	description
`location`	`WmStoreInput`	`true`	`false`

Response

WmStoreResult

updateLocation

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

This method has been renamed to updateStore(). Both service calls have identical parameters, response type, and behavior.

updateStore

Update an existing location.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUID of an existing store.
`location`	`WmStoreInput[]`	`true`	`false`

Response

WmStoreResult

getLocationInfo

Get a list of location info options for the type, concept, ownership and placement fields.

Parameters

name	type	required	nillable	description
`section`	`string`	`true`	`false`	Can be type, concept, ownership and location.

Response

WmLocationInfoResult

getPositions

Get a list of valid positions to use when adding or updating an account.

Response

WmPositionsResult

getLanguages

Get a list of active languages to use when adding or updating an account.

Response

WmLanguagesResult

getTimezones

Get a list of valid languages to use when adding or updating an account, country or store.

Response

WmTimezonesResult

getErrors

Get a list of error messages. We can use this to create documentation later on.

Response

WmErrorsResult

findCustomFieldsByAccountUuid

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

Find a list of available custom fields for an account.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing account.

Response

WmDataFieldsResult

findCustomFieldsByStoreUuid

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

Find a list of available custom fields for a store.

Parameters

name	type	required	nillable	description
`uuid`	`WmUuidInput`	`true`	`false`	UUID of an existing store.

Response

WmDataFieldsResult

getCustomFields

Get a list of custom fields.

Response

WmCustomFieldOutput[]

getCustomFieldDataByAccountUuids

Get custom fields data by user account UUIDs.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUIDs of existing user accounts.

Response

WmCustomFieldDataOutput[]

getCustomFieldDataByStoreUuids

Get custom fields data by user account UUIDs.

Parameters

name	type	required	nillable	description
`uuids`	`WmUuidInput[]`	`true`	`false`	UUIDs of existing stores.

Response

WmCustomFieldDataOutput

getDataFieldValidValuesByUuid

Deprecation Notice

As of SOAP API v7 this method is deprecated and will be removed in the future versions.

Please, use getCustomFields() instead.

Get an range of valid values of an active dropdown custom field.

Parameters

name	type	required	nillable	description
`datafieldUuid`	`WmUuidInput`	`true`	`false`	UUID of an existing custom field.

Response

WmDataFieldResult

getAccountUuidByUsername

Get the account’s UUID by their username.

Parameters

name	type	required	nillable	description
`username`	`string`	`true`	`false`	Username of an existing account.

Response

WmUuidResult