GET api/v2/Dashboards/GetMobileFarmDashboard?farmId={farmId}

Request Information

URI Parameters

Name	Description	Type	Additional information
farmId		integer	Required

Body Parameters

None.

Response Information

Resource Description

MobileFarmDashboardContract

Name	Type	Additional information
OrdersInProgressCount	integer	None.
OrdersWaitingForConfirmationCount	integer	None.
AnimalsCount	integer	None.
AnimalsCapacity	integer	None.
StoragePointsCapacity	decimal number	None.
StoragePointsVirtualStock	decimal number	None.
AlertStockBreak	integer	None.
AlertEndingGroup	integer	None.
HealthStatus	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrdersInProgressCount": 1,
  "OrdersWaitingForConfirmationCount": 2,
  "AnimalsCount": 3,
  "AnimalsCapacity": 4,
  "StoragePointsCapacity": 5.0,
  "StoragePointsVirtualStock": 6.0,
  "AlertStockBreak": 7,
  "AlertEndingGroup": 8,
  "HealthStatus": 9
}

application/xml, text/xml

Sample:

<MobileFarmDashboardContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FPService/v2/contracts/2017/01">
  <AlertEndingGroup>8</AlertEndingGroup>
  <AlertStockBreak>7</AlertStockBreak>
  <AnimalsCapacity>4</AnimalsCapacity>
  <AnimalsCount>3</AnimalsCount>
  <HealthStatus>9</HealthStatus>
  <OrdersInProgressCount>1</OrdersInProgressCount>
  <OrdersWaitingForConfirmationCount>2</OrdersWaitingForConfirmationCount>
  <StoragePointsCapacity>5</StoragePointsCapacity>
  <StoragePointsVirtualStock>6</StoragePointsVirtualStock>
</MobileFarmDashboardContract>