요청 및 응답 메시지 형식

요청 및 응답 메시지 형식

요청

    <?xml version='1.0' encoding='UTF-8'?>
    <call method="exportData" callerName="a string that identifies your client application">
       <credentials login="sample@company.com" password="my_pwd"/>              
       method specific data goes here
    </call>

이 라인은 후속 데이터가 UTF-8로 인코딩된 XML임을 나타냅니다.
<call> 태그는 해당 메서드 특성을 사용하여 호출되는 API 메서드를 나타냅니다. 이 예에서 API 메서드는 exportData입니다. 또한, 호출자명은 <call> 태그의 필수 특성입니다. 시스템에서 클라이언트 어플리케이션을 식별하며, 문제 해결 및 기록 시 식별 목적으로 사용됩니다.
모든 API 메서드는 호출하는 사용자를 인증해야 합니다. 일반적으로 로그인명과 비밀번호를 입력하면 됩니다. 다른 특성은 여기에서 지정할 수 있습니다. 자격증명에 대한 자세한 내용은 각 API 함수의 설명서를 참조하십시오.
일부 API 메서드는 요청에 추가 데이터가 필요합니다. 예를 들어, exportData 메서드에는 데이터를 검색할 때 사용해야 하는 기간, 계정, 레벨 등을 설명하는 몇 가지 조건이 필요합니다. 요청의 이 부분은 방법에 따라 다릅니다.
라인 2에 있는 호출 태그의 종료 태그입니다.

응답

     <?xml version='1.0' encoding='UTF-8'?>
     <response success="true">
       <messages>
          <message key="modeled-import-success">Personnel import successful. Rows imported: 100</message>
       </messages>
       <output>
         ... method output ...
       </output>
     </response>

요청과 유사하게 이 라인은 후속 데이터가 XML로 형식이 지정되고 UTF-8로 인코딩됨을 나타냅니다.
각 응답은 <response> 태그로 묶입니다. 요청이 성공한 경우 응답 태그의 성공 속성이 true로 설정됩니다. 요청이 실패한 경우 성공 속성이 false로 설정됩니다.
대부분의 API 호출은 서버에서 생성된 메시지 목록을 포함하는 이 옵션 <messages> 블록을 반환합니다. 서버에 호출에 대한 응답으로 반환할 메시지가 없는 경우 이 블록이 표시되지 않을 수 있습니다. 오류 메시지는 항상 messages 블록 내에 표시됩니다.
messages 블록 내의 각 메시지에는 전송되는 메시지 유형을 식별하는 키 특성이 있습니다. 또한 message 태그에는 요청의 성공 또는 실패에 대한 반환 값, 상태 값 또는 기타 독립형 메타데이터를 포함하여 서버에서 보내는 메시지의 텍스트가 포함됩니다. 응답에는 메시지 태그가 무제한으로 포함될 수 있습니다.
종료 메시지 태그
API 메서드 호출의 실제 출력이 반환되는 경우, 이 출력은 <Output> 태그로 묶입니다.
API 메서드 호출의 실제 출력이 여기에 표시됩니다. 이 출력은 호출된 메서드에 따라 달라집니다.
닫는 출력 태그입니다.
종료 응답 태그