REST Get
https://api.placesign.com/v1/Place/{placeToken}/Status.{dotType}/{APIKey}
Full documentation here
REST Post
https://api.placesign.com/v1/Thing/{IotKeyToken}/Signal.{dotType}/{PostType}/{APIKey}
Post Types
- Ping - Re-verification signal only, no data sent
- Full - Full content replacement signal
- Incremental - Partial content signal of changes since previous Full or Incremental signal
- Differential - Partial content signal of changes since previous Full signal
Full documentation here
Existence
The most ubiquous signal type, availble with every IoT device and impactful with all Internet partners.
Existence verification occurs explicitly with a simple Ping signal or implicitly with all the following more complex signals.
Existence can be verified with a simple Ping post type.
No Signal data is required for an Existence post.
Operational Status
Open or Closed status of a place.
"Signal":
{
"SignalType": 1, /* OpStatus - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 1, /* OpStatusValue - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 1005, /* OpStatus - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "1"
}
],
"Groups": []
}
Activity
How busy is a place.
Activity Metadata (Input)
"Signal":
{
"SignalType": 9, /* Activity - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values": [],
"Groups":
[
{
"SignalGroupType": 3, /* ActivtyGlimpse - http://placesign.com/Developers/Reference/Type/SignalGroupType/ */
"SignalValues":
[
{
"SignalValueType": 25, /* ActivityType - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 3, /* Enum - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* Null - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "1"
},
{
"SignalValueType": 26, /* ActivityLevel - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 2, /* Double - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* (Optional) - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "37"
},
{
"SignalValueType": 27, /* ActivityCapacity - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 2, /* Double - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* (Optional) - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "100"
},
{
"SignalValueType": 35, /* PublishType - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": null, /* (Optional) - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* (Optional) - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "ActivityRate"
}
],
"SignalCells": []
}
]
}
Activity Rate Display (Output)
"Signal":
{
"SignalType": 9, /* Activity - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 28, /* ActivityRate - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 2, /* Double - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 8, /* Percentage - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "0.37"
}
],
"Groups": []
}
Offer
Real-time deals.
"Signal":
{
"SignalType": 2, /* Offer - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 2, /* Name - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Blue Plate Special"
},
{
"SignalValueType": 4, /* Descript - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Roasted turkey, cranberry sauce, sausages, carrots and French Fries"
},
{
"SignalValueType": 3, /* Price - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 2, /* Double - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 2, /* USD - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "7.99"
}
],
"Groups": []
}
Annoucement
Real-time Notification.
"Signal":
{
"SignalType": 3, /* Announcement - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 4, /* Descript - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Krispy Kreme Hot Light"
}
],
"Groups": [],
}
FuelPrices
Current fuel prices with related attributes
"Signal":
{
"SignalType": 4, /* FuelPrices - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values": [],
"Groups":
[
{
"SignalGroupType": 1, /* FuelPrices - http://placesign.com/Developers/Reference/Type/SignalGroupType/ */
"SignalValues":
[
{
"SignalValueType": 7, /* FuelPrice - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [ 1 ], /* Key - http://placesign.com/Developers/Reference/Type/SignalOptionID/ */
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Unleaded"
}
],
"SignalCells":
[
{
"Type": 1,
"Values":
[
{
"SignalValueType": 7, /* FuelPrice - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 2, /* Double - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 2, /* USD - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "2.87900"
},
{
"SignalValueType": 8, /* MethodOfPayment - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [ 1 ], /* Key - http://placesign.com/Developers/Reference/Type/SignalOptionID/ */
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Cash"
},
{
"SignalValueType": 9, /* ServiceMode - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [ 1 ], /* Key - http://placesign.com/Developers/Reference/Type/SignalOptionID/ */
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Self"
}
],
}
]
}
]
}
OnPremise
Current resource availabilty. Primary use case is broadcasting staff on-site.
"Signal":
{
"SignalType": 5, /* OnPremise - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 5, /* Resource - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 1003, /* PersonID - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "1001"
},
{
"SignalValueType": 18, /* OnPremiseStatus - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 1006, /* OnPremiseStatus - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "1" /* On - http://placesign.com/Developers/Reference/Type/OnPremiseStatus/ */
}
],
"Groups": []
}
Beverage
Draft breverage currently tapped with related attributes.
"Signal":
{
"SignalType": 6, /* Beverage - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values": [],
"Groups":
[
{
"SignalGroupType": 2, /* Tap - http://placesign.com/Developers/Reference/Type/SignalGroupType/ */
"SignalValues":
[
{
"SignalValueType": 16, /* GroupName - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [ 1 ], /* Key - http://placesign.com/Developers/Reference/Type/SignalOptionID/ */
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Tap0"
},
{
"SignalValueType": 2, /* Name - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Goose Island IPA"
}
],
"SignalCells": []
}
]
}
Wait
Current wait time with related attributes.
"Signal":
{
"SignalType": 7, /* Wait - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 12, /* GroupsWaiting - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 4, /* People - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "2"
},
{
"SignalValueType": 13, /* WaitTime - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 3, /* Minutes - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "0"
},
{
"SignalValueType": 14, /* WaitStatus - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Available"
}
],
"Groups": []
}
Event
IoT Event
"Signal":
{
"SignalType": 8, /* Event - http://placesign.com/Developers/Reference/Type/SignalType/ */
"Values":
[
{
"SignalValueType": 19, /* IoTEventType - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 7, /* Integer - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 1007, /* IoTEventType - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "1"
},
{
"SignalValueType": 20, /* StartTime - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 7, /* ISO 8601 - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "2016-08-16T16:30:49Z"
},
{
"SignalValueType": 21, /* EndTime - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": 7, /* ISO 8601 - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "2016-08-16T16:42:34Z"
},
{
"SignalValueType": 2, /* Name (Optional) - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Emissions Test"
},
{
"SignalValueType": 22, /* VehicleModel (Optional) - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "Ford"
},
{
"SignalValueType": 23, /* VehicleMake (Optional) - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "F-150"
},
{
"SignalValueType": 24, /* VehicleYear (Optional) - http://placesign.com/Developers/Reference/Type/SignalValueType/ */
"OptionIDs": [],
"DataType": 1, /* String - http://placesign.com/Developers/Reference/Type/DataType/ */
"UnitType": null, /* NA - http://placesign.com/Developers/Reference/Type/UnitType/ */
"Value": "2015"
}
],
"Groups": []
}