add-blip.md

description
This endpoint allows you to add a new custom blip to your community's live map!

Add Blip

{% hint style="warning" %} This API endpoint requires the pro version of Sonoran CAD or higher.
For more information, see our pricing page. {% endhint %}

{% swagger baseUrl="https://api.sonorancad.com" path="/emergency/add_blip" method="post" summary="Add Blip" %} {% swagger-description %} This endpoint allows you to add a custom blip to your live map. {% endswagger-description %}

{% swagger-parameter in="body" name="id" type="string" required="true" %} Your community's ID {% endswagger-parameter %}

{% swagger-parameter in="body" name="key" type="string" required="true" %} Your community's API Key {% endswagger-parameter %}

{% swagger-parameter in="body" name="type" type="string" required="true" %} ADD_BLIP {% endswagger-parameter %}

{% swagger-parameter in="body" name="data" type="array" required="true" %} Array of request objects {% endswagger-parameter %}

{% swagger-response status="200" description="A successful call will be met with the following response:" %}

// Blip object with ID set
[
    {
        "id": 1234,
        "coordinates": {
            "x": 0,
            "y": 0
        },
        "icon": "https://example.com/icon.png"
    }
]

{% endswagger-response %}

{% swagger-response status="400" description="The following 400 errors may be sent in response:" %}

INVALID REQUEST TYPE
INVALID COMMUNITY ID
API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY

{% endswagger-response %} {% endswagger %}

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "ADD_BLIP",
    "data": [
        {
            "serverId": 1, // Server ID
            "blip": {
                "id": -1, // New ID
                "subType": "Example", // Differentiate custom blips
                "coordinates": {
                    "x": 123,
                    "y": 456
                },
                "radius": 100, // Displays a circle radius
                "icon": "https://example.com/icon.png", // URL or Icon Name
                "color": "#df03fc", // Hex Color Code
                "tooltip": "Example added from the API!", // Blip Tooltip
                "data": [
                    {
                        "title": "Example 1",
                        "text": "123",
                    },
                    {
                        "title": "Example 2",
                        "text": "456",
                    }
                ]
            }
        },
    ]
}