Preferences: Get Format List

POOL content can also be filtered by release format. This endpoint can be used by multiple aspects of an application in order to pull all valid POOL release formats and their corresponding format id.

Get Format List Specification

Parameters: Header variables:
  1. userid: integer
  2. token: string
JSON list returned:

Get Format List Workflow

  1. URL: https://api.promoonly.com/user/formats
  2. Header: Authorization: Bearer Base64(userid:token)
  3. Method: GET
  4. Returned: JSON

    Example JSON Output

    [
        {
            "format": "All Promo Only Formats",
            "id": 0
        },
        {
            "format": "Alternative Video",
            "id": 68
        },
        {
            "format": "Chart Video HD Daily",
            "id": 71
        },
        {
            "format": "Club Video",
            "id": 5
        },
        {
            "format": "Country Video",
            "id": 4
        },
        {
            "format": "Dance Mix Video",
            "id": 3
        },
        {
            "format": "Express Video",
            "id": 14
        },
        {
            "format": "Hits HD",
            "id": 67
        },
        {
            "format": "Hot Video",
            "id": 1
        },
        {
            "format": "Latin Video",
            "id": 6
        },
        {
            "format": "Modern Rock Video",
            "id": 7
        },
        {
            "format": "Urban Video",
            "id": 8
        },
        {
            "format": "Alternative Club",
            "id": 23
        },
        {
            "format": "Caribbean Series",
            "id": 35
        },
        {
            "format": "Contemporary Christian",
            "id": 28
        },
        {
            "format": "Country Radio",
            "id": 17
        },
        {
            "format": "Dance Radio",
            "id": 38
        },
        {
            "format": "Express Audio DFF",
            "id": 63
        },
        {
            "format": "Express Audio - DJ Tools",
            "id": 93
        },
        {
            "format": "Mainstream Club",
            "id": 19
        },
        {
            "format": "Mainstream Radio",
            "id": 15
        },
        {
            "format": "Modern Rock Radio",
            "id": 18
        },
        {
            "format": "Pop Latin",
            "id": 27
        },
        {
            "format": "Regional Latin",
            "id": 26
        },
        {
            "format": "Rhythm Club",
            "id": 20
        },
        {
            "format": "Rhythm Radio",
            "id": 31
        },
        {
            "format": "Tropical Latin",
            "id": 25
        },
        {
            "format": "Underground Club",
            "id": 22
        },
        {
            "format": "Urban Club",
            "id": 24
        },
        {
            "format": "Urban Radio",
            "id": 16
        }
    ]

Examples

  1. PHP (using cURL):

    <?php
        $userid = 1;
        $token = "8b26e1e4f3f5e00a888807e605565c47";

        $formats_url = "https://api.promoonly.com/user/formats";

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $formats_url);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer ".base64_encode($userid.":".$token)));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        $formats_result = curl_exec($ch);
        curl_close($ch);

        $formats_obj = json_decode($formats_result);
    ?>
  2. Javascript (using jQuery):

    function b64EncodeUnicode(str)
    {
        return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g,
            function toSolidBytes(match, p1)
            {
                return String.fromCharCode('0x' + p1);
            }));
    }

    var userid = 1;
    var token = "8b26e1e4f3f5e00a888807e605565c47";
    var auth_str = "Bearer " + b64EncodeUnicode(userid + ":" + token);

    $.ajax({
        type: "GET",
        url: "https://api.promoonly.com/user/formats",
        headers: { "Authorization": auth_str },
        dataType: "json",
        success: function (data)
        {
            console.log(data);
        }
    });
  3. Python (using requests):

    #!/usr/bin/env python

    import requests
    import base64
    import urllib

    userid = 1
    token = "8b26e1e4f3f5e00a888807e605565c47"

    b64_key = base64.b64encode("%s:%s" % (userid, token))
    headers = {"Authorization": "Bearer %s" % b64_key}
    formats_url = "https://api.promoonly.com/user/formats"
    result_return = requests.get(formats_url, headers=headers)

    print(result_return.text)