그룹 생성

싸인투게더의 고객 그룹을 등록합니다.

API 사용이 가능하더라도 기본적으로는 사용할 수 없으며, 싸인투게더 운영팀에 소통하신 후 권한을 부여 받으신 후에 사용 가능합니다.

그룹 생성

POST /rest/api/group

파라미터는 파라미터 셋을 배열로 받아 다중으로 요청이 가능합니다.

1개의 세트만 처리하고 싶은 경우 배열에 1개의 파라미터 셋만 세팅하여 전달해주면 됩니다.

Headers

Name	Type	Description
apiKey*	String	apiKey

Request Body

Name	Type	Description
adminUser*	Object	그룹 생성 시 최초 등록되는 그룹의 유저로 최고 관리자를 의미 예시) { "adminUserEmail":" [e-mail]", "adminUserName":"adminName", "loginId":"adminLoginId", "password":"adminPassword" }
groupName*	String	그룹 이름
groupPartName	String	그룹의 기본 부서 이름
userConsent*	Object	최고 관리자의 사용자 동의 여부 { "isteenager":"true", "serviceuse":"true", "privacycollection":"true", "marketinguse":"false" } marketinguse를 제외하면 모두 true로 전달해야 하며, margetinguse의 경우 true/false에 따라 광고성 메일을 받을것인지에 대해 선택된다.
phoneNumber	String	최고 관리자의 휴대전화 번호
linkedType	String	그룹에 대한 구분자 필요한 경우 싸인투게더와 해당값을 소통하여 결정.
level	Number	그룹의 레벨
parentGroupId	Number	상위 그룹 Id
flag*	String	동작에 대한 구분자 생성 시 "C"

Request Example

요청 예시

[
  {
    "adminUser": {
      "adminUserEmail":"[e-mail]",	// 최고관리자 email
      "adminUserName":"최관리",  		// 최고관리자 name
      "loginId":"your_admin_login_id",	        // 최고관리자 login id
      "password":"password12#$"			// 최고관리자 비밀번호
    },
    "groupName": "싸인그룹",			// 그룹 name
    "groupPartName": "",	                // 그룹 part name (선택)
    "userConsent": {                            // 사용자 동의 관련
      "isteenager": true,                       // 성인 여부
      "serviceuse": true,                       // 서비스 사용 동의 
      "privacycollection": true,                // 서비스 정책 동의
      "marketinguse": false,                    // 마케팅 사용 동의
    },
    "phoneNumber":"01000000000",        	// 최고관리자 폰번호 (선택)
    "level": 2					// 그룹레벨	(선택)
    "flag":"C",					// 생성 flag
  }
]

Response Example

200: OK 성공 또는 핸들링된 오류

Example

{
    "successCount": 1,
    "failCount": 0,
    "successList": [
        {
            "urlPath": "SGT_0000000001",
            "groupAdminId": 1,
            "modifyDate": "2024-09-01T09:00:00.000",
            "message": "",				// 결과 메시지
            "phoneNumber": "01000000000",
            "update": null,
            "parentGroupId": null,
            "level": 1,
            "used": true,
            "success": true,				// 성공 여부
            "groupId": 1,
            "groupName": "싸인투게더 고객그룹001"
        }
    ],
    "failList": []
}

400: Bad Request 핸들링하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/create-document"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}