CATCH LOC Developers

[Group Management] API access for registered group list

Description

API access for group information.

API

API CODE : api.common.group.get.list

HOST : http://cms.catchloc.com/api.partner.common.php

Method : GET

Protocol : JSON

Parameters

api : api_code
api_key : Client's partner key
timestamp : Unix timestamp
cert_key : Certification key

Response

protocol : JSON Array
group_name : Group Name
group_key : Group Key
reg_date : Registered Date

Example


            ===== Request =====

            http://cms.catchloc.com/api.partner.common.php?
            api=api.common.group.get.list&
            api_key=xxxxx&
            timestamp=1513319595&
            cert_key=xxxxxx



            ===== Response =====

            - Success
            [
                {
                    "group_name":"***********", // Group Name
                    "group_key":"***********", // Group Key
                    "reg_date":1475815151 // Registered Date
                },
                ......
            ]

            - Fail
            {
                "result":"FAIL",
                "message":"Error Reason"
            }


            ===== Request =====

            CatchLoc catchloc = new CatchLoc();

            catchloc.setApiKey("API KEY");
            catchloc.setServerKey("SERVER KEY");

            JSONObject result = catchloc.getGroups();



            ===== Response (JSONObject) =====

            {
                "result"  : "ok",
                "type"    : "jsonarray"
                "message" : API Response Body
            }


            ===== Request =====

            import CatchLocSDKForAPI (common)

            CatchLocAPI.shared.setApiKey(API_KEY)
            CatchLocAPI.shared.setserverKey(SERVER_KEY)

            CatchLocAPI.shared.getGroups()
            { result in
                
                let jsonData = result.response

                or

                let jsonString = result.description()
                
            }

            ===== Response =====

            {
                "response" : API Response Body
            }


            ===== Request =====

            $catchloc = new CatchLoc();

            $catchloc->setApiKey("API KEY");
            $catchloc->setServerKey("SERVER KEY")

            $result = $catchloc->getGroups();


            ===== Response (JSON String) =====

            "{
                "result"  : "ok",
                "type"    : "array"
                "message" : API Response Body
            }"


            ===== Request =====

            var callback = function(json)
            {
                code... (handle for api response)
                (e.g. : create marker on map or print list)
            };

            var params = {};

            CatchLoc.setApiKey("API KEY");
            CatchLoc.setServerKey("SERVER KEY");

            CatchLoc.getGroups(params, callback);



            ===== Response (JSON, using parameter in callback function) =====

            {
                "result"  : "ok",
                "type"    : "array"
                "message" : API Response Body
            }