POST api/store/{id}/machine/ping

Keeps track of store lanes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Store identifier

integer

Required

Body Parameters

store lane details

MachinePing
NameDescriptionTypeAdditional information
SoftwareName

Name of software initiating the ping, eg "ezi-POS"

string

None.

SoftwareVersion

Version of the software initiating the ping, eg "1.25.5.5"

string

None.

LaneGUID

Lane's GUID, if known (eg "ce244a37-adc0-11ee-a16c-06a9ba720012")

string

None.

ScaleID

ScaleID of POS/Scale (eg "1b5c3107085f9cdaa2b4dfa8f13de0b3")

string

None.

Description

lane description (eg "LANE 23")

string

None.

ZoneID

Zone ID for POS/Scale

integer

None.

StoreID

integer

None.

StoreScaleID

ID of the Store POS/Scale

integer

None.

SentLocal

local time ping was sent (eg "2023-12-13 11:05:23")

date

None.

LastSaleLocal

local time of last sale for the day if any (eg "2023-12-13 11:05:23")

date

None.

Sales

collection of sales totals

Collection of PingSale

None.

Request Formats

application/json, text/json

Sample:
{
  "softwareName": "sample string 1",
  "softwareVersion": "sample string 2",
  "laneGUID": "sample string 3",
  "scaleID": "sample string 4",
  "description": "sample string 5",
  "zoneID": 1,
  "storeID": 6,
  "storeScaleID": 7,
  "sentLocal": "2025-06-14T06:22:19.3763189",
  "lastSaleLocal": "2025-06-14T06:22:19.3763189",
  "sales": [
    {
      "$id": "2",
      "date": "2025-06-14T06:22:19.3763189",
      "totalSales": 2
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:
<MachinePing xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Pos.Devices">
  <Description>sample string 5</Description>
  <LaneGUID>sample string 3</LaneGUID>
  <LastSaleLocal>2025-06-14T06:22:19.3763189+00:00</LastSaleLocal>
  <Sales>
    <PingSale>
      <Date>2025-06-14T06:22:19.3763189+00:00</Date>
      <TotalSales>2</TotalSales>
    </PingSale>
    <PingSale>
      <Date>2025-06-14T06:22:19.3763189+00:00</Date>
      <TotalSales>2</TotalSales>
    </PingSale>
  </Sales>
  <ScaleID>sample string 4</ScaleID>
  <SentLocal>2025-06-14T06:22:19.3763189+00:00</SentLocal>
  <SoftwareName>sample string 1</SoftwareName>
  <SoftwareVersion>sample string 2</SoftwareVersion>
  <StoreID>6</StoreID>
  <StoreScaleID>7</StoreScaleID>
  <ZoneID>1</ZoneID>
</MachinePing>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.