OPTIONS /alerts/

Get details about the data model of a push. You will also get the list of languages for the current product.


Endpoint:
/alerts/

HTTP method: OPTIONS

Format: JSON

Response

The body will be a JSON object detailing the Push object properties. It will also give you some details about the project like it's name and the list of languages.

Example

 {
    "name": "Push",
    "description": "",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
            "id": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "ID"
            },
            "message": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Message"
            },
            "extra_message": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Body"
            },
            "url": {
                "type": "string",
                "required": false,
                "read_only": false,
                "label": "Url"
            },
            "created_datetime": {
                "type": "datetime",
                "required": false,
                "read_only": true,
                "label": "Created datetime"
            },
            "scheduled_datetime": {
                "type": "datetime",
                "required": false,
                "read_only": false,
                "label": "Scheduled datetime"
            },
            "target_ids": {
                "type": "integer",
                "required": false,
                "read_only": false,
                "label": "Target ids"
            },
            "status_ios": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Status ios"
            },
            "status_android": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Status android"
            },
            "sent_ios": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Sent ios"
            },
            "sent_android": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Sent android"
            },
            "ios_gc_user_ids": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Ios gc user ids"
            },
            "android_gc_user_ids": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Android gc user ids"
            },
            "button_label": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Button label"
            }
        }
    },
    "project": {
        "languages": [
            "eng",
            "fre"
        ],
        "tag": "testfestival2016",
        "name": "Test festival 2016"
    }
}