CATCH LOC Developers

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

Description

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

API

API CODE : api.common.group.get.group.object.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 : 인증키
group_key : GROUP 인증용 HASH KEY

Response

member_pin : 단말 핀 번호, 지퍼번호
member_key : MEMBER HASH KEY
member_name : 단말이름
member_status : 단말상태(C: 정상, X: 해지)
battery : 단말 배터리 레벨(%)
last_location_date : 최종 위치 일시(UNIX timestamp)
last_latitude : 최종위치 위도
last_longitude : 최종위치 경도
last_check_date : 최종 패킷 일시 (UNIX timestamp)
valid_date : 단말사용기한 (UNIX timestamp)
dept : 차량운행기록부 - 소속부서
manager : 차량운행기록부 - 사용자
obejct_use : 차량운행기록부 - 사용용도(001:업무용, 002:개인용, 003:기타)
object_type : 차량운행기록부 - 차종
object_no : 차량운행기록부 - 차량번호
reg_date : 등록일

Example


            ===== Request =====

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



            ===== Response =====

            - 성공 시            
            [
                {
                    "member_pin" : "00000",
                    "member_key" : "******************",
                    "member_name" : "******************",
                    "member_status" : "C",
                    "battery" : "50",
                    "last_location_date" : 0,
                    "last_latitude" : 0,
                    "last_longitude" : 0,
                    "last_check_date" : 1504147576,
                    "valid_date" : 1506178799,
                    "dept" : "******************",
                    "manager" : "******************",
                    "obejct_use" : "0003",
                    "object_type" : "***************",
                    "object_no" : "**************",
                    "reg_date":1475815151
                },
                ......
            ]

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


            ===== Request =====

            String group_key = "그룹 생성 시 발급된 그룹 인증 HASH KEY";

            CatchLoc catchloc = new CatchLoc();

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

            JSONObject result = catchloc.getGroupMembers(group_key);



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

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


            ===== Request =====

            import CatchLocSDKForAPI (공통)

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

            -GROUP_KEY : GROUP 인증용 HASH KEY

            CatchLocAPI.shared.getGroupMembers(groupKey: GROUP_KEY)
            { result in
                
                let jsonData = result.response

                혹은

                let jsonString = result.description()
                
            }

            ===== Response =====

            {
                "response" : API Response Body
            }


            ===== Request =====

            $group_key = '그룹 생성 시 발급된 그룹 인증 HASH KEY';

            $catchloc = new CatchLoc();

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

            $result = $catchloc->getGroupMembers($group_key);


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

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


            ===== Request =====

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

            var params =
            {
                group_key: '그룹 생성 시 발급된 그룹 인증 HASH KEY',
            };

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

            CatchLoc.getGroupsMembers(params, callback);



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

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