Skip to main content

Users

A User is an employee of a Company. He can use Retail operations according to his profile and his role.

User methods​

Returns a list of all Users of a store matching some specified search criteria.

Method​

GET/api/externals/v1/users

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • storeID (long): (provided in the path): ID of the Store owning the searched Users
  • keyword (string): Searched keyword
  • idsOnly (boolean, true): If true, returns only a set of User IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Users (e.g. "employeePicturePath")

Body​

(none)

Response​

The search service returns a JSON message with the list of items matching the specified search criteria:

{
  "users": [
    { 
      "id": long, 
      "userWinLangID": long,
      "userRoleName": string,
      "userRoleIsAdmin": boolean,
      "resourceID": long,
      "employeeIsActive": boolean,
      "employeeCode": string,
      "employeeTitle": string,
      "employeeFirstName": string,
      "employeeLastName": string,
      "employeeInfo": string,
      "employeeStreet1": string,
      "employeeStreet2": string,
      "employeeStreet3": string,
      "employeeZipCode": string,
      "employeeCity": string,
      "employeeCountry": string,
      "employeeHomePhone": string,
      "employeeWorkPhone": string,
      "employeeMobilePhone": string,
      "employeeEmail": string,
      "employeePersonalEmail": string,
      "employeePicturePath": string,
      "employeeNotes": string,
      "employeeExternalCode": string,
      "profileDescription": string
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the User which userID is provided in the URL.

Method​

GET/api/externals/v1/users/{userID}

Arguments​

  • userID (long): (provided in the path): ID of the User to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • detailedView (boolean, false): If true, returns additional information about the matching User (e.g. "employeePicturePath")

Body​

(none)

Response​

Same format as the one returned by the « User search » method.