CATCH LOC Developers

[그룹관리] 그룹 멤버 추가 API

Description

위치오브젝트 그룹의 멤버를 추가하는 API.

API

api_code : api.common.group.set.object.add

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

Method : GET

Protocol : JSON

Parameters

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

Response

result: RESULT
message:result code

Example


            ===== Request =====

            http://cms.catchloc.com/api.partner.common.php?
            api=api.common.group.set.object.add&
            api_key=xxxxx&
            timestamp=1513319595&
            cert_key=xxxxx&
            group_key=xxxxxx&
            member_key=xxxxxx



            ===== Response =====

            - 성공 시            
            {
              "result":"OK",
              "message":"GROUP_MEMBER_ADD"
            }

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

                에러사유:
                - DUPLICATED_GROUP_MEMBER : 이미 해당 그룹에 등록된 단말
                - NO_MEMBER_INFO : member_key 에 할당된 단말 정보 없음
                - NO_GROUP_INFO : group_key 에 할당된 그룹정보 없음
            }


            ===== Request =====

            String group_key = "그룹 인증 HASH KEY";
            String member_key = "단말 인증 HASH KEY";

            CatchLoc catchloc = new CatchLoc();

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

            JSONObject result = catchloc.addGroupMember(group_key, member_key);



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

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


            ===== Request =====

            import CatchLocSDKForAPI (공통)

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

            -GROUP_KEY : GROUP 인증용 HASH KEY
            -MEMBER_KEY : 단말 인증용 HASH KEY

            CatchLocAPI.shared.addGroupMember(groupKey: GROUP_KEY, memberKey: MEMBER_KEY)
            { result in
                
                let jsonData = result.response

                혹은

                let jsonString = result.description()
                
            }

            ===== Response =====

            {
                "response" : API Response Body
            }


            ===== Request =====

            $group_key = '그룹 인증 HASH KEY';
            $member_key = '단말 인증 HASH KEY';

            $catchloc = new CatchLoc();

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

            $result = $catchloc->addGroupMember($group_key, $member_key);


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

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


            ===== Request =====

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

            var params =
            {
                group_key: '그룹 인증 HASH KEY',
                member_key: '단말 인증 HASH KEY',
            };

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

            CatchLoc.addGroupMember(params, callback);



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

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