POST api/Operators/Search

Retrieves a list of Operators (or Clerks)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Gender	Optional. Can return only Male Operators, or only Female one.	EskimoClassLibraries.clsOperator+OperatorGenderEnum	None.
Active	Specifies whether the operators are active (still working for the business or not). Most of the time, this will be 1.	EskimoClassLibraries.modEnums+FilterEnum	Required
RegionalManagers	Filters Roaming Operators (Regional Managers that look after multiple sites)	EskimoClassLibraries.modEnums+FilterEnum	Required
Name	Optional. Can filter by the Operator Name. Percentage characters can be used for wildcard searches	string	String length: inclusive between 0 and 25
StoreNumber		string	String length: inclusive between 3 and 3
PermissionRequirements	If populated, then an array of permissions that the user is allowed to perform will be returned. The results will be related to the ApplicationID passed in.	EskimoClassLibraries.clsOperatorPermissionArgs	None.
PasswordEncryptionEngine	The password field that is returned will be encrypted. This denotes the engine that will be used to perform this.	EskimoClassLibraries.OperatorArguments+PasswordEncryptionEngineEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "Gender": 0,
  "Active": 0,
  "RegionalManagers": 0,
  "Name": "sample string 1",
  "StoreNumber": "sample string 2",
  "PermissionRequirements": {
    "ApplicationID": "sample string 1"
  },
  "PasswordEncryptionEngine": 1
}

application/xml, text/xml

Sample:

<OperatorArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Active>Exclude</Active>
  <Gender>Male</Gender>
  <Name>sample string 1</Name>
  <PasswordEncryptionEngine>MD5</PasswordEncryptionEngine>
  <PermissionRequirements>
    <ApplicationID>sample string 1</ApplicationID>
  </PermissionRequirements>
  <RegionalManagers>Exclude</RegionalManagers>
  <StoreNumber>sample string 2</StoreNumber>
</OperatorArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsOperator

Name	Description	Type	Additional information
ID	The Eskimo ID of the Operator.	string	Required String length: inclusive between 0 and 12
Name	The operator's name	string	String length: inclusive between 0 and 20
Active	Their working status.	boolean	None.
RoamingOperator	Specifies if this person roams between sites (like any area manager for example)	boolean	None.
Administrator	Specifies if this person has administrative rights	boolean	None.
Gender	The operator's gender	EskimoClassLibraries.clsOperator+OperatorGenderEnum	None.
EncryptedPassword	The operator's password to log on to the EPOS software. Contact Eskimo EPOS for info on obtaining the decryption key.	string	None.
Permissions	A list of all things this operator is allowed to do. (Only populated if the PermissionRequirements field is passed in the request).	Collection of EskimoClassLibraries.clsOperatorPermission	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Active": true,
    "RoamingOperator": true,
    "Administrator": true,
    "Gender": 0,
    "EncryptedPassword": "sample string 6",
    "Permissions": [
      {
        "PermID": 1,
        "AdditionalResponseType": 1,
        "PermDescription": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "PermID": 1,
        "AdditionalResponseType": 1,
        "PermDescription": "sample string 2",
        "Value": "sample string 3"
      }
    ]
  },
  {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Active": true,
    "RoamingOperator": true,
    "Administrator": true,
    "Gender": 0,
    "EncryptedPassword": "sample string 6",
    "Permissions": [
      {
        "PermID": 1,
        "AdditionalResponseType": 1,
        "PermDescription": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "PermID": 1,
        "AdditionalResponseType": 1,
        "PermDescription": "sample string 2",
        "Value": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsOperator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsOperator>
    <Active>true</Active>
    <Administrator>true</Administrator>
    <EncryptedPassword>sample string 6</EncryptedPassword>
    <Gender>Male</Gender>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <Permissions>
      <clsOperatorPermission>
        <AdditionalResponseType>NoAdditional</AdditionalResponseType>
        <PermDescription>sample string 2</PermDescription>
        <PermID>1</PermID>
        <Value>sample string 3</Value>
      </clsOperatorPermission>
      <clsOperatorPermission>
        <AdditionalResponseType>NoAdditional</AdditionalResponseType>
        <PermDescription>sample string 2</PermDescription>
        <PermID>1</PermID>
        <Value>sample string 3</Value>
      </clsOperatorPermission>
    </Permissions>
    <RoamingOperator>true</RoamingOperator>
  </clsOperator>
  <clsOperator>
    <Active>true</Active>
    <Administrator>true</Administrator>
    <EncryptedPassword>sample string 6</EncryptedPassword>
    <Gender>Male</Gender>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <Permissions>
      <clsOperatorPermission>
        <AdditionalResponseType>NoAdditional</AdditionalResponseType>
        <PermDescription>sample string 2</PermDescription>
        <PermID>1</PermID>
        <Value>sample string 3</Value>
      </clsOperatorPermission>
      <clsOperatorPermission>
        <AdditionalResponseType>NoAdditional</AdditionalResponseType>
        <PermDescription>sample string 2</PermDescription>
        <PermID>1</PermID>
        <Value>sample string 3</Value>
      </clsOperatorPermission>
    </Permissions>
    <RoamingOperator>true</RoamingOperator>
  </clsOperator>
</ArrayOfclsOperator>