Preferences: Save Filenaming Options

This endpoint allows you to save your options for filenaming. The possible combinations for the fields are listed below.

fn1
  1. Title
  2. Artist
  3. Mix
  4. Duration
  5. BPM
  6. End
  7. Genre
  8. Label
  9. Release
  10. Order
  11. Date Sent
  12. Impact Date
  13. Content Warning
  14. Format
fn1_mod
  1. -
  2. _
  3. ( )
  4. ( ) -
fn1_caps
  • 0 - Regular capitalization
  • 1 - ALL CAPS for this section
fn2
  1. Title
  2. Artist
  3. Mix
  4. Duration
  5. BPM
  6. End
  7. Genre
  8. Label
  9. Release
  10. Order
  11. Date Sent
  12. Impact Date
  13. Content Warning
  14. Format
fn2_mod
  1. -
  2. _
  3. ( )
  4. ( ) -
fn2_caps
  • 0 - Regular capitalization
  • 1 - ALL CAPS for this section
fn3
  1. Title
  2. Artist
  3. Mix
  4. Duration
  5. BPM
  6. End
  7. Genre
  8. Label
  9. Release
  10. Order
  11. Date Sent
  12. Impact Date
  13. Content Warning
  14. Format
fn3_mod
  1. -
  2. _
  3. ( )
  4. ( ) -
fn3_caps
  • 0 - Regular capitalization
  • 1 - ALL CAPS for this section
fn4
  1. Title
  2. Artist
  3. Mix
  4. Duration
  5. BPM
  6. End
  7. Genre
  8. Label
  9. Release
  10. Order
  11. Date Sent
  12. Impact Date
  13. Content Warning
  14. Format
fn4_mod
  1. -
  2. _
  3. ( )
  4. ( ) -
fn4_caps
  • 0 - Regular capitalization
  • 1 - ALL CAPS for this section
fn5
  1. Title
  2. Artist
  3. Mix
  4. Duration
  5. BPM
  6. End
  7. Genre
  8. Label
  9. Release
  10. Order
  11. Date Sent
  12. Impact Date
  13. Content Warning
  14. Format
fn5_mod
  1. ( )
fn5_caps
  • 0 - Regular capitalization
  • 1 - ALL CAPS for this section

Save Filenaming Options Specification

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

Save Filenaming Options Workflow

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

    Example JSON Output

    {
        "fn1_caps": 0,
        "fn1": 2,
        "fn1_mod": 1,
        "fn2_caps": 0,
        "fn2": 1,
        "fn2_mod": 0,
        "fn3_caps": 0,
        "fn3": 3,
        "fn3_mod": 3,
        "fn4_caps": 0,
        "fn4": 0,
        "fn4_mod": 0,
        "fn5_caps": 0,
        "fn5": 0,
        "fn5_mod": 0,
        "fn_all_caps": 0,
        "fn_mod_use_spaces": 1,
        "fn_no_spaces": 0
    }

Examples

  1. PHP (using cURL):

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

        $api_url = "https://api.promoonly.com/user/save/filenaming";
        $post_fields = "fn1_caps=0&fn1=2&fn1_mod=1";
        $post_fields .= "&fn2_caps=0&fn2=1&fn2_mod=0";
        $post_fields .= "&fn3_caps=0&fn3=3&fn3_mod=3";
        $post_fields .= "&fn4_caps=0&fn4=0&fn4_mod=0";
        $post_fields .= "&fn5_caps=0&fn5=0&fn5_mod=0";
        $post_fields .= "&fn_all_caps=0&fn_mod_use_spaces=1&fn_no_spaces=0";

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $api_url);
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $post_fields);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer ".base64_encode($userid.":".$token)));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

        $api_obj = json_decode($api_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);
    var post_data = {
            fn1_caps: 0,
            fn1: 2,
            fn1_mod: 1,
            fn2_caps: 0,
            fn2: 1,
            fn2_mod: 0,
            fn3_caps: 0,
            fn3: 3,
            fn3_mod: 3,
            fn4_caps: 0,
            fn4: 0,
            fn4_mod: 0,
            fn5_caps: 0,
            fn5: 0,
            fn5_mod: 0,
            fn_all_caps: 0,
            fn_mod_use_spaces: 1,
            fn_no_spaces: 0
        };

    $.ajax({
        type: "POST",
        url: "https://api.promoonly.com/user/save/filenaming",
        headers: { "Authorization": auth_str },
        data: post_data,
        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"
    post_data = {
            "fn1_caps": 0,
            "fn1": 2,
            "fn1_mod": 1,
            "fn2_caps": 0,
            "fn2": 1,
            "fn2_mod": 0,
            "fn3_caps": 0,
            "fn3": 3,
            "fn3_mod": 3,
            "fn4_caps": 0,
            "fn4": 0,
            "fn4_mod": 0,
            "fn5_caps": 0,
            "fn5": 0,
            "fn5_mod": 0,
            "fn_all_caps": 0,
            "fn_mod_use_spaces": 1,
            "fn_no_spaces": 0
        }

    b64_key = base64.b64encode("%s:%s" % (userid, token))
    headers = {"Authorization": "Bearer %s" % b64_key}
    api_url = "https://api.promoonly.com/user/save/filenaming"
    result_return = requests.post(api_url, headers=headers, data=post_data)

    print(result_return.text)