편집이 완료되지 않은 문서입니다.

일반적인 응답

캠스콘 API의 모든 JSON response는 다음과 같은 구조를 가집니다.

{
    "meta": {
        "code": "{http response code}",
        "error_type": "OAuthException",
        "error_message": "..."
    },
    "data": {
        ...
    },
    "pagination": {
        "next_url": "...",
        "next_max_id": "###"
    }
}

모든 response object는 meta, data, pagination의 3개 property를 가지며, response의 성격에 따라 data와 pagination property는 null 값을 가질 수 있습니다.

위에 정의된 Standard Response Structure는 HTTP 상태 코드(Status Code)가 200 즉, API에서 정상적인 응답을 반환하는 경우에 사용되며, HTTP 상태 코드가 200이 아닌 경우에는 response body가 비어있거나 Standard Response Structure를 따르지 않는 내용으로 구성될 수 있습니다. 이 경우에는 HTTP 상태 코드를 기준으로 처리를 해야 합니다.

Response body가 Standard Response Structure를 따르는 경우

Response body가 Standard Response Structure를 따르지 않는 경우