CATCH LOC Developers

[그룹관리] 단말 소속 그룹리스트 API

Description

위치오브젝트가 소속 된 그룹 리스트를 조회하는 API.

API

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

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

Method : GET

Protocol : JSON

Parameters

api : api_code
api_key : 고객사 파트너 키
timestamp : Unix timestamp
cert_key : 인증키
member_key : 단말 인증용 HASH KEY

Response

group_name : 그룹명
group_key : 그룹키
reg_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 =====

            - 성공 시            
            [
                {
                    "group_name":"***********",
                    "group_key":"***********",
                    "reg_date":1475815151
                },
                ......
            ]

            - 실패 시
            {
                "result":"FAIL",
                "message":"에러 사유"
            }


            ===== Request =====

            String member_key = "위치수집대상에 부여된 키";

            CatchLoc catchloc = new CatchLoc();

            catchloc.setApiKey("API키");
            catchloc.setServerKey("서버키");

            JSONObject result = catchloc.getGroupsWithObject(member_key);



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

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


            ===== Request =====

            import CatchLocSDKForAPI (공통)

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

            -MEMBER_KEY : 적용대상의 MEMBER_KEY

            CatchLocAPI.shared.getGroupsWithObject(memberKey: MEMBER_KEY)
            { result in
                
                let jsonData = result.response

                혹은

                let jsonString = result.description()
                
            }

            ===== Response =====

            {
                "response" : API Response Body
            }


            ===== Request =====

            $member_key = '위치수집대상에 부여된 키';

            $catchloc = new CatchLoc();

            $catchloc->setApiKey("API키");
            $catchloc->setServerKey("서버키")

            $result = $catchloc->getGroupsWithObject($member_key);


            ===== Response (JSON 형태의 문자열) =====

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


            ===== Request =====

            var callback = function(json)
            {
                api 응답값을 처리하는 콜백함수의 내용
                (예시 : 지도에 위치 출력 혹은 목록 출력)
            };

            var params =
            {
                member_key: '위치수집대상에 부여된 키',
            };

            CatchLoc.setApiKey("API키");
            CatchLoc.setServerKey("서버키");

            CatchLoc.getGroupsWithObject(params, callback);



            ===== Response (JSON, callback 함수의 매개변수 내용) =====

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