POST Message Action – Client examples

Message Action

/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation. All rights reserved.
 * Create Message Action client demonstrates adding a message action to an existing zone
 * using the 'request' node module.
 */
var request = require('request');
var actionData =
    {
        "security": {
            /* The apiKey is generated when you create an application. */
            "apiKey" : "dcbd2c48-577e-4187-959e-b8f9216e9875",
            /* This key is generated by Bluedot Point Access UI when your account is created. It is also available
             * on the PointAccess interface in the Edit Profile section. */
            "customerApiKey": "86577370-7b91-11e4-bcb7-a0481cdc3311"
        },
        "content": {
            "zone": {
                /* The zoneId is the id of the zone being updated. This can be fetched by calling GET Zones API */
                "zoneId": "1c48dc46-b516-4396-95ca-057e730c4bd7",
                "actions": {
                    "messageActions": [
                        {
                            "name" : "A Message Action",
                            "title" : "Welcome to Bluedot Innovation",
                            "message" : "Welcome to Bluedot Innovation Offices"
                        }
                    ]
                }
            }
        }
    };
  
var options = {
    uri: 'https://api.bluedotinnovation.com/1/actions',
    method: 'POST',
    json: actionData
};
request(options,
    function (error, response, body) {
        if (error) {
            console.log(error);
        }
        console.log(JSON.stringify(response.body));
    }
);

Message Action with conditions

/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation. All rights reserved.
 * Create Message Action with Conditions client demonstrates adding a message action with all conditions to an existing zone
 * using the 'request' node module.
 */
var request = require('request');
var actionData =
    {
        "security": {
            /* The apiKey is generated when you create an application. */
            "apiKey" : "c2c8211f-796f-4eda-b6ce-05467b5263a9",
            /* This key is generated by Bluedot Point Access UI when your account is created. It is also available
             * on the PointAccess interface in the Edit Profile section. */       
            "customerApiKey": "86577370-7b91-11e4-bcb7-a0481cdc3311"
        },
        "content": {
            "zone": {
                /* The zoneId is the id of the zone being updated. This can be fetched by calling GET Zones API */
                "zoneId": "722c991a-3ebb-4143-b441-5b0c0cf680a0",
                "actions": {
                    "messageActions": [
                        {
                            "name" : "A Message Action",
                            "title" : "Welcome to Bluedot Innovation",
                            "message" : "Welcome to Bluedot Innovation Offices",
                            "conditions": {
                                "percentageCrossed": [
                                    {
                                        "percentage": 45,
                                        /* Time in Hour:Minute format.*/
                                        "timeoutPeriod": "00:01",
                                        /*When sequential is set false, the action will be triggered based on the
                                         * percenatge crossed condition.*/
                                        "sequential": false
                                    }
                                ],
                                "dateRange": [
                                    {
                                        "start": "12/12/2014",
                                        "end": "14/12/2014"
                                    }
                                ],
                                "timeActive": [
                                    {
                                        "from": {
                                            /* Time in Hour:Minute format.*/
                                            "time": "10:00",
                                            "period": "am"
                                        },
                                        "to": {
                                            /* Time in Hour:Minute format.*/
                                            "time": "2:00",
                                            "period": "pm"
                                        }
                                    }
                                ],
                                "bearing": [
                                    {
                                        "fromAngle": 80,
                                        "toAngle": 200
                                    }
                                ],
                                "speed": [
                                    {
                                        "minimumSpeed": 10,
                                        "maximumSpeed": 30
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    };
 
var options = {
    uri: 'https://api.bluedotinnovation.com/1/actions',
    method: 'POST',
    json: actionData
};
request(options,
    function (error, response, body) {
        if (error) {
            console.log(error);
        }
        console.log(JSON.stringify(response.body));
    }
);

Message Action

package com.bluedotinnovation.action;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import com.bluedotinnovation.common.BDCommon;
/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation Pty Ltd. All rights reserved.
 * Add Message Action client demonstrates adding a message action to an existing zone using JSON simple and Apache HTTP client libraries.
 */
public class AddMessageAction extends BDCommon {
    private static String bdCustomerApiKey    = "ca4c8d11-6942-11e4-ba4b-a0481cdc3311"; //This key is generated by Bluedot Point Access UI when your account is created
    private static String bdApplicationApiKey = "f5223f4c-a0f3-47be-ba59-080b6290a9d4"; //This apiKey is generated when you create an application
    private static String bdZoneId            = "dfafb7fd-d2f7-42ec-afd5-d5c7851c0396"; //This is the id of the zone being updated. This can be fetched by calling GET Zones API
    private static String bdRestUrl           = "https://api.bluedotinnovation.com/1/actions";
     
    /**
     * @param args
     * @throws IOException
     * @throws ParseException
     * @throws NoSuchAlgorithmException
     * @throws KeyManagementException
     */
    public static void main(String[] args) throws IOException, ParseException, KeyManagementException, NoSuchAlgorithmException {
         
        CloseableHttpClient httpRestClient = HttpClients.custom().setSSLSocketFactory(getSSLContextFactory()).build();
         
        JSONParser parser    = new JSONParser();
        JSONObject bdMessageActionJSONObject = (JSONObject) parser.parse(getJsonMessageAction()); //message action json
         
        HttpPost postRequest = new HttpPost(bdRestUrl);
        postRequest.addHeader("content-type", "application/json");
        postRequest.setEntity(new StringEntity(bdMessageActionJSONObject.toJSONString(), Charset.defaultCharset()));
      
        HttpResponse response = httpRestClient.execute(postRequest);
                         
        if (response.getStatusLine().getStatusCode() == 200) {
            System.out.println("Message action was added to your zone successfully");
            InputStream inputStream = response.getEntity().getContent();
            byte[] bytes            = readStream(inputStream);
            String resultString     = new String(bytes); //json result
            JSONObject jsonResult   = (JSONObject)  parser.parse(resultString);
            System.out.println(jsonResult);
        } else {
            InputStream inputStream = response.getEntity().getContent();
            byte[] bytes            = readStream(inputStream);
            String resultString     = new String(bytes); //json error result
            System.out.println(resultString);
        }          
    }
     
     
    private static String getJsonMessageAction() {
         
        String messageActionJson =
             "{" +
                "\"security\": {" +
                    "\"apiKey\":" + "\"" + bdApplicationApiKey +"\"," +
                    "\"customerApiKey\":" +"\"" + bdCustomerApiKey + "\""+
                "}," +
                "\"content\": {" +
                    "\"zone\": {" +
                        "\"zoneId\":"+ "\"" + bdZoneId +"\"," +
                        "\"actions\": {" +
                            "\"messageActions\": [" +
                                "{" +
                                    "\"name\": \"Welcome to MCG\"," +
                                    "\"title\": \"MCG Welcome Message\"," +
                                    "\"message\": \"Welcome to MCG\"" +
                                "}" +
                            "]" +
                        "}" +
                    "}" +
                "}" +
            "}";     
        return messageActionJson;
    }
}

Message Action with Conditions

package com.bluedotinnovation.action;
 
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
 
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
 
import com.bluedotinnovation.common.BDCommon;
 
/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation Pty Ltd. All rights reserved.
 * Add Message Action with Conditions client demonstrates adding a message action with all conditions to an existing zone
 * using JSON simple and Apache HTTP client libraries.
 */
 
public class AddMessageActionWithConditions extends BDCommon {
 
    private static String bdCustomerApiKey    = "a6598740-75f5-11e4-86ca-a0481cdc3311"; //This key is generated by Bluedot Point Access UI when your account is created.
    private static String bdApplicationApiKey = "5a9b1b78-3dd7-4f4d-8608-82408f3baf4c"; //This apiKey is generated when you create an application
    private static String bdZoneId            = "b80e50eb-b9f9-4ed5-966e-4b2e39cc0549"; //This is the id of the zone being updated. This can be fetched by calling GET Zones API
    private static String bdRestUrl           = "https://api.bluedotinnovation.com/1/actions";
 
    public static void main(String[] args) throws IOException, ParseException, KeyManagementException, NoSuchAlgorithmException {
 
        CloseableHttpClient httpRestClient = HttpClients.custom().setSSLSocketFactory(getSSLContextFactory()).build();
         
        JSONParser parser    = new JSONParser();
        JSONObject bdMessageActionJSONObject = (JSONObject) parser.parse(getJsonMessageActionWithConditions()); //Message action with conditions json
         
        HttpPost postRequest = new HttpPost(bdRestUrl);
        postRequest.addHeader("content-type", "application/json");
        postRequest.setEntity(new StringEntity(bdMessageActionJSONObject.toJSONString(), Charset.defaultCharset()));
 
        HttpResponse response = httpRestClient.execute(postRequest);
 
        if (response.getStatusLine().getStatusCode() == 200) {
            System.out.println("Message Action with conditions was added successfully");
            InputStream inputStream = response.getEntity().getContent();
            byte[] bytes            = readStream(inputStream);
            String resultString     = new String(bytes); //json result
            JSONObject jsonResult   = (JSONObject)  parser.parse(resultString);
            System.out.println(jsonResult);
        } else {
            InputStream inputStream = response.getEntity().getContent();
            byte[] bytes            = readStream(inputStream);
            String resultString     = new String(bytes); //json error result
            System.out.println(resultString);
        }          
    }
 
    private static String getJsonMessageActionWithConditions() {
        String action =
               "{" +
               "\"security\": {" +
                    "\"apiKey\":" + "\"" + bdApplicationApiKey + "\"," +
                     "\"customerApiKey\":" + "\"" + bdCustomerApiKey + "\"" +
               "}," +
               "\"content\": {" +
                   "\"zone\": {" +
                       "\"zoneId\":" + "\"" + bdZoneId + "\"," +
                       "\"actions\": {" +
                           "\"messageActions\": [" +
                               "{" +
                                   "\"name\" : \"Date Range My message actions1\"," +
                                   "\"title\" : \"This is the title of my message.1\"," +
                                   "\"message\" : \"Have a nice day.1\"," +
                                   "\"conditions\": {" +
                                       "\"dateRange\": [" +
                                           "{" +
                                               "\"start\": \"10/11/2016\"," +
                                               "\"end\": \"26/12/2017\"" +
                                           "}" +
                                       "]," +
                                       "\"percentageCrossed\": [" +
                                          "{" +
                                              "\"percentage\": 90," +
                                              "\"timeoutPeriod\": \"00:15\"," +
                                              "\"sequential\": true" +
                                           "}" +
                                      "]," +
                                      "\"timeActive\": [{" +
                                        "\"from\": {" +
                                            "\"time\": \"06:01\"," +
                                            "\"period\": \"am\" " +
                                        "}," +
                                        "\"to\": {" +
                                            "\"time\": \"11:00\"," +
                                            "\"period\": \"pm\" " +
                                        "}" +
                                    "}]," +
                                    "\"bearing\": [" +
                                        "{" +
                                            "\"fromAngle\": 0," +
                                            "\"toAngle\": 90" +
                                        "}" +
                                    "]," +
                                    "\"speed\": [" +
                                        "{" +
                                            "\"minmumSpeed\": 10," +
                                            "\"maximumSpeed\": 20" +
                                        "}" +
                                    "]" +
                                   "}" +
                               "}" +
                           "]" +
                       "}" +
                   "}" +
               "}" +
           "}";
        return action;
    }
}

Message Action

using System;
using System.Linq;
using System.Text;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using System.Net;
using System.IO;
using System.Security.Cryptography.X509Certificates;
/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation. All rights reserved.
 * Create Message Action client demonstrates adding an action to an existing the customer's zone using .net http web api library
 */
namespace BluedotPublicApiClient.actionclient
{
    public class CreateMessageAction
    {
        private static String bdCustomerApiKey    = "a6598740-75f5-11e4-86ca-a0481cdc3311"; //This key is generated by Bluedot Point Access UI when your account is created
        private static String bdApplicationApiKey = "e9224a1b-7f10-4033-82f7-c4d1dfc91825"; //This apiKey is generated when you create an application
        private static String bdZoneId            = "71e66fca-aadc-48b2-bbd6-2bdc46572079"; //This is the id of the zone being updated. This can be fetched by calling GET Zones API
        private static String bdRestUrl           = "https://api.bluedotinnovation.com/1/actions";
        public void create()
        {
            postToService(getJsonMessageAction());
        }
        private void postToService(String json)
        {
            WebRequestHandler handler = new WebRequestHandler();
            X509Certificate2 certificate = new X509Certificate2();
            handler.ClientCertificates.Add(certificate);
            HttpClient httpRestClient = new HttpClient(handler);
            //specify to use TLS 1.2 as default connection
            System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
            httpRestClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
            HttpContent jsonContent = new StringContent(json);
            jsonContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
            HttpResponseMessage serverResponse = httpRestClient.PostAsync(new Uri(bdRestUrl), jsonContent).Result;
            if (serverResponse.IsSuccessStatusCode)
            {
                var result = serverResponse.Content.ReadAsStringAsync().Result;
                Console.WriteLine("{0}", result);
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)serverResponse.StatusCode, serverResponse.Content.ReadAsStringAsync().Result);
            }
        }
        /*JSON Format for a Message action*/
        private static String getJsonMessageAction()
        {
            String messageActionJson =
                 "{" +
                    "\"security\": {" +
                        "\"apiKey\":" + "\"" + bdApplicationApiKey + "\"," +
                        "\"customerApiKey\":" + "\"" + bdCustomerApiKey + "\"" +
                    "}," +
                    "\"content\": {" +
                        "\"zone\": {" +
                            "\"zoneId\":" + "\"" + bdZoneId + "\"," +
                            "\"actions\": {" +
                                "\"messageActions\": [" +
                                    "{" +
                                        "\"name\": \"Congestion Charge\"," +
                                        "\"title\": \"Congestion Charge\"," +
                                        "\"message\": \"To protect the environment and reduce congestion, you have been charged $5. Thank you!\"" +
                                    "}" +
                                "]" +
                            "}" +
                        "}" +
                    "}" +
                "}";
            return messageActionJson;
        }
    }
}

Message Action with Conditions

using System;
using System.Linq;
using System.Text;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using System.Net;
using System.IO;
using System.Security.Cryptography.X509Certificates;
/**
 * @author Bluedot Innovation
 * Copyright (c) 2016 Bluedot Innovation. All rights reserved.
 * Create Message Action client demonstrates adding an action with conditions to an existing the customer's zone using .net http web api library
 */
namespace BluedotPublicApiClient.actionclient
{
    public class CreateMessageActionWithConditions
    {
        private static String bdCustomerApiKey    = "a6598740-75f5-11e4-86ca-a0481cdc3311"; //This key is generated by Bluedot Access UI when you register
        private static String bdApplicationApiKey = "db15b9b5-f2cf-405d-920d-0a65ea227c0c"; //This apiKey is generated when you create an application
        private static String bdZoneId            = "aaeb1e68-72c2-4151-a461-da626baac0e7"; //This is the id of the zone being updated. This can be fetched by calling GET Zones API
        private static String bdRestUrl           = "https://api.bluedotinnovation.com/1/actions";
        public void createActionWithConditions()
        {
            postToService(getJsonMessageActionWithConditions());
        }
        private void postToService(String json)
        {
            WebRequestHandler handler = new WebRequestHandler();
            X509Certificate2 certificate = new X509Certificate2();
            handler.ClientCertificates.Add(certificate);
            HttpClient httpRestClient = new HttpClient(handler);
            //specify to use TLS 1.2 as default connection
            System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
            httpRestClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
            HttpContent jsonContent = new StringContent(json);
            jsonContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
            HttpResponseMessage serverResponse = httpRestClient.PostAsync(new Uri(bdRestUrl), jsonContent).Result;
            if (serverResponse.IsSuccessStatusCode)
            {
                var result = serverResponse.Content.ReadAsStringAsync().Result;
                Console.WriteLine("{0}", result);
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)serverResponse.StatusCode, serverResponse.Content.ReadAsStringAsync().Result);
            }
        }
        private static String getJsonMessageActionWithConditions()
        {
            String action =
                "{" +
                "\"security\": {" +
                     "\"apiKey\":" + "\"" + bdApplicationApiKey + "\"," +
                      "\"customerApiKey\":" + "\"" + bdCustomerApiKey + "\"" +
                "}," +
                "\"content\": {" +
                    "\"zone\": {" +
                        "\"zoneId\":" + "\"" + bdZoneId + "\"," +
                        "\"actions\": {" +
                            "\"messageActions\": [" +
                                "{" +
                                    "\"name\" : \"You are walking\"," +
                                    "\"title\" : \"You are walking\"," +
                                    "\"message\" : \"You are walking\"," +
                                    "\"conditions\": {" +
                                        "\"percentageCrossed\":" +
                                        "[" +
                                           "{" +
                                               "\"percentage\": 100," +
                                               "\"timeoutPeriod\": \"00:05\"" +
                                            "}" +
                                       "]" +
                                    "}" +
                                "}" +
                            "]" +
                        "}" +
                    "}" +
                "}" +
            "}";
            return action;
        }
    }
}
Created by Bluedot DevOps on January 31, 2018

Start the discussion