GET api/StockTaking/GetProductData

Retrieves a list of products and operators that can be used for stock taking.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

EskimoClassLibraries.clsStockTakingProductInfo

Name	Description	Type	Additional information
Location1Name	The name of the location 1. i.e. Shop Floor	string	None.
Location2Name	The name of the location 2. i.e. Second Floor	string	None.
Location3Name	The name of the location 3. i.e. Garage Lock-up	string	None.
InStockTakeMode	The Eskimo must be put into Stock Take mode before stock can be counted in the stock take. This property states whether this has been performed in the back office software or not.	boolean	None.
StockTakeCommenced	If the system has been put into Stock Take mode, this property states the date when this happened. This can also act as a safety net, to make sure it has not been left in Stock Take mode since a previous stock take.	date	None.
Operators	A collection of operators that work at this showroom.	Collection of EskimoClassLibraries.clsOperator	None.

Response Formats

application/json, text/json

Sample:

{
  "Location1Name": "sample string 1",
  "Location2Name": "sample string 2",
  "Location3Name": "sample string 3",
  "InStockTakeMode": true,
  "StockTakeCommenced": "2024-05-03T11:36:41.2396904+01:00",
  "Operators": [
    {
      "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:

<clsStockTakingProductInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <InStockTakeMode>true</InStockTakeMode>
  <Location1Name>sample string 1</Location1Name>
  <Location2Name>sample string 2</Location2Name>
  <Location3Name>sample string 3</Location3Name>
  <Operators>
    <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>
  </Operators>
  <StockTakeCommenced>2024-05-03T11:36:41.2396904+01:00</StockTakeCommenced>
</clsStockTakingProductInfo>