2.3.1 JSON Format data

각 API의 Object는 비슷하지만 다른 Object Type을 가지고 있다

Null

단순 요청

"object":"null"

{}

Register

인증시 필요한 정보

"object":"register"

{
  "token":string,
  "timestamp":number,
}

Property name	Value	Description
token	string	인증을 받는 서버에서 확인하기 위한 토큰 값
timestamp	number	결과를 확인하기 위한 서버에서 보내는 시간 값

Servers

서버들의 정보가 있는 Array

"object":"servers"

[
    {
        "validation":boolean,
        "type":string,
        "id":string,
        "name":string,
        "url":string
    }
]

Property name	Value	Description
validation	boolean	서버의 유효성 true - 서버가 DB에 등록되어 있음 false - 서버가 DB에 등록되어 있지 않음
type	string	서버의 타입 정보
id	string	서버의 id
name	string	서버의 이름
url	string	서버의 URL

Users

유저들의 정보가 있는 Array

"object":"users"

[
    {
        "validation":boolean,
        "id":string,
        "name":string,
        "group":[
          string
        ]
    }
]

Property name	Value	Description
validation	boolean	유저의 유효성 true - User가 DB에 등록되어 있음 false - User가 DB에 등록되어 있지 않음
id	string	User의 id
name	string	User의 이름
group	string	User가 속한 그룹 부서, 직책, 권한 등이 포함 될 수 있다.

Calendar

Calendar의 Event 정보가 있는 Array

[
  {
    "calendar":string,
    "event":string,
    "content":{
      "title":string,
      "description":string,
      "start-date":string,
      "end-date":string,
      "allday":boolean
    }
  }
]

Property name	Value	Description
calendar	string	목표 갤린더의 id
event	string	현 이벤트의 id 이벤트가 아직 생성되지 았았으면 빈 문자열 값을 갖는다
content	string	이벤트 구성 정보
content.title	string	이벤트 타이틀
content.description	string	이벤트 상세한 내용
content.start-date	string	이벤트 시작 시간 표기 형식은 ISO 8601표준에 따른다
content.end-date	string	이벤트 끝 시간 표기 형식은 ISO 8601표준에 따른다
content.allday	boolean	종일 이벤트 여부 true - 해당 이벤트는 종일 이벤트이다 start-date, end-date의 날짜 값이 같으면 해당 날의 종일 이벤트가 되고, 다르면 시작 날짜부터 끝 날짜까지 내내 종일 이벤트가 된다. false - 해당 이벤트는 종일 이벤트가 아니다

Switch

on/off등 상태 변환 명령을 위한 객체

"object":"switch"

{
    "state":string
}

Property name	Value	Description
state	string	변경하길 원하는 상태 값은 목표로 하는 플랫폼을 참고한다

Approval

결재, 승인을 위한 객체

"object":"approval"

{
    "message":{
      "title":string,
      "description":string
    },
    "arbiter":[
      {
        "id":string,
        "state":string
      }
    ],
    "state":"요청 상태"
}

Property name	Value	Description
message	object	결재 요청, 결과, 사유 등에 대한 내용을 작성한다
message.title	string	제목
message.description	string	상세한 내용
arbiter	array	결재를 받아야하는 유저 list
arbiter.id	string	결재를 받아야하는 유저 id
arbiter.state	string	결재를 받아야하는 유저로 부터의 상태 상태 값
state	string	현재 결재 상황 상태 값

차후 Action 순서에 대한 결재를 만든 후 결재 승인되면 Action이 실행되게 하는 기능을 만들 계획