8 API Reference‎ > ‎Resources‎ > ‎

Checkin

NOTICE: This resource is not implemented yet.

Checkin represents the fact that a customer checks in at a redemption location of an advertiser. Checkins are used for checkin coupons only. The idea behind it is that a consumer gets the offer only after he checks in a specified number of times.

Common attributes:
  • offer_id string.
  • location Location.
  • registered_at time.
Distribution API specific attributes:
  • customer_id string.
  • account_id string.
  • checkins_remained integer.
Submission API specific attributes:

Data Examples

JSON

{
    "offer_id": "",
    "location": {Location},
    "registered_at": "",
    "customer_id": "",
    "account_id": "",
    "distributor": {Distributor}
}

XML

<checkin>
    <offer_id></offer_id>
    <location>Location</location>
    <registered_at></registered_at>
    <customer_id></customer_id>
    <account_id></account_id>
    <distributor>Distributor</distributor>
</checkin>

Actions

Register Checkin

POST /checkins

Request

{     "checkin": {
        "offer_id": "",
        "location": {
            "lat": "",
            "lng": ""
        },
        "registered_at": "",
        "customer_id": "",
        "account_id": ""
    } }

Response

HTTP/1.1 200 OK {     "status": "OK" }

XML

Request

<?xml version="1.0" encoding="UTF-8"?>
<checkin> 
    <offer_id></offer_id>
    <location>
        <lat></lat>
        <lng></lng>
    </location>
    <registered_at></registered_at>
    <customer_id></customer_id>
    <account_id></account_id>
</checkin>

Response

HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <response>     <status>OK</status> </response>


Comments