//[[restapi:start|RESTful API]]//

====== PUSH Types ======

The [[:campaign_manager|Campaign Manager]] will send to your app a variety of PUSH's types, in some cases to raise a visible/audible notification, but in other cases it will be silent, this is the mechanism how the app and the [[:campaign_manager|Campaign Manager]] will keep in touch about what is happening between them and the phone's surroundings.

Our [[sdk:overview|SDK]] will handle all this messages for you.

==== Type: GEO_LOC ====

  As String: <MESSAGE_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|MESSAGE_ID
|style="width: 80%; background-color: white;"|Message's ID to query & deliver
|-
|style="width: 30%; background-color: white;"|LATITUDE
|style="width: 80%; background-color: white;"|The point latitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|LONGITUDE
|style="width: 80%; background-color: white;"|The point longitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|RADIO
|style="width: 80%; background-color: white;"|The circle radius. <wrap info>Use **meters** for this value</wrap>
|}

==== Type: GET_LOC ====

  As String: <LOCATION_REQUEST_ID>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|LOCATION_REQUEST_ID
|style="width: 80%; background-color: white;"|The request's ID you need to update with your current location
|}

==== Type: CRT_REGION ====

  As String: <REGION_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>:<EVENT_TYPE>:<REGION_NAME>


{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|New Region's ID 
|-
|style="width: 30%; background-color: white;"|LATITUDE
|style="width: 80%; background-color: white;"|The point latitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|LONGITUDE
|style="width: 80%; background-color: white;"|The point longitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|RADIO
|style="width: 80%; background-color: white;"|The circle radius. <wrap info>Use **meters** for this value</wrap>
|-
|style="width: 30%; background-color: white;"|EVENT_TYPE
|style="width: 80%; background-color: white;"|Which event must be notified **ENTER, EXIT or ENTER-EXIT**
|-
|style="width: 30%; background-color: white;"|REGION_NAME
|style="width: 80%; background-color: white;"|Region's name to display
|}

==== Type: UPDT_REGION ====

  As String: <REGION_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>:<EVENT_TYPE>:<REGION_NAME>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|Region's ID to update
|-
|style="width: 30%; background-color: white;"|LATITUDE
|style="width: 80%; background-color: white;"|The point latitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|LONGITUDE
|style="width: 80%; background-color: white;"|The point longitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap>
|-
|style="width: 30%; background-color: white;"|RADIO
|style="width: 80%; background-color: white;"|The circle radius. <wrap info>Use **meters** for this value</wrap>
|-
|style="width: 30%; background-color: white;"|EVENT_TYPE
|style="width: 80%; background-color: white;"|Which event must be notified **ENTER, EXIT or ENTER-EXIT**
|-
|style="width: 30%; background-color: white;"|REGION_NAME
|style="width: 80%; background-color: white;"|Region's name to update
|}

==== Type: DLT_REGION ====

  As String: <REGION_ID>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|Region's ID to delete
|}

==== Type: BEACON ====

  As String: <REGION_MESSAGE_CONTENT>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_MESSAGE_CONTENT
|style="width: 80%; background-color: white;"|Message's content
|}
==== Type: GEOFENCE ====

  As String: <REGION_MESSAGE_CONTENT>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_MESSAGE_CONTENT
|style="width: 80%; background-color: white;"|Message's content

|}

==== Type: CRT_BEACON ====

  As String: <REGION_ID>:<UUID>:<MAJOR>:<MINOR>:<MANUFACTURER>:<DISTANCE>:<EVENT_TYPE>:<REGION_NAME>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|New Region's ID
|-
|style="width: 30%; background-color: white;"|UUID
|style="width: 80%; background-color: white;"|Beacon's UUID 
|-
|style="width: 30%; background-color: white;"|MAJOR
|style="width: 80%; background-color: white;"|Beacon's MAJOR value
|-
|style="width: 30%; background-color: white;"|MINOR
|style="width: 80%; background-color: white;"|Beacon's MINOR value
|-
|style="width: 30%; background-color: white;"|MANUFACTURER
|style="width: 80%; background-color: white;"|Beacon's manufacturer
|-
|style="width: 30%; background-color: white;"|DISTANCE
|style="width: 80%; background-color: white;"|Beacon's distance to trigger the event
|-
|style="width: 30%; background-color: white;"|EVENT_TYPE
|style="width: 80%; background-color: white;"|Event type to fire the event. **ENTER, EXIT or ENTER-EXIT**
|-
|style="width: 30%; background-color: white;"|REGION_NAME
|style="width: 80%; background-color: white;"|Region's name
|}

==== Type: DLT_BEACON ====

  As String: <REGION_ID>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|Region's ID to delete
|}

==== Type: UPDT_BEACON ====

  As String: <REGION_ID>:<UUID>:<MAJOR>:<MINOR>:<MANUFACTURER>:<DISTANCE>:<EVENT_TYPE>:<REGION_NAME>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|REGION_ID
|style="width: 80%; background-color: white;"|Region's ID to update
|-
|style="width: 30%; background-color: white;"|UUID
|style="width: 80%; background-color: white;"|New beacon's UUID 
|-
|style="width: 30%; background-color: white;"|MAJOR
|style="width: 80%; background-color: white;"|New beacon's MAJOR value
|-
|style="width: 30%; background-color: white;"|MINOR
|style="width: 80%; background-color: white;"|New beacon's MINOR value
|-
|style="width: 30%; background-color: white;"|MANUFACTURER
|style="width: 80%; background-color: white;"|New beacon's manufacturer
|-
|style="width: 30%; background-color: white;"|DISTANCE
|style="width: 80%; background-color: white;"|New beacon's distance to trigger the event
|-
|style="width: 30%; background-color: white;"|EVENT_TYPE
|style="width: 80%; background-color: white;"|New event type to fire the event. **ENTER, EXIT or ENTER-EXIT**
|-
|style="width: 30%; background-color: white;"|REGION_NAME
|style="width: 80%; background-color: white;"|New region's name
|}

==== Type: GEO_PUSH ====

  As String: <MESSAGE_CONTENT>

{|class="table table-striped table-condensed table-bordered"
!style="background-color: lightgrey;"|Parameter
!style="background-color: lightgrey;"|Description
|-
|style="width: 30%; background-color: white;"|MESSAGE_CONTENT
|style="width: 80%; background-color: white;"|Message's content
|}