LINE WORKS Developers

コミュニティ

LINE WORKSのテクニカルエキスパート及び開発者と
コードのサンプル、リソース、Tip等を共有し問題解決への相談が可能です。

??dev_메인_타이틀_모바일_ja_JP??

組織連携

(v2)HTTPステータスについて

画像

保田慧

2018.01.19既読 172

組織連動関連のAPIのドキュメントを見ると

処理後のHTTPステータスで、ある程度の処理結果が推測できるよう

設計されているように見受けられます。

 

すべての組織連動のAPIの確認をしたわけではありませんが

基本的に処理の成功は、200(OK)と201(Created)の2種類

処理失敗は、400(BadRequest), 403(Forbidden), 404(NotFound), 409(Conflict), 500(Internal Server Error)の5種類

と思っています。

 

201は、基本的に追加処理の成功時に返されるコードかと思われますが

役職修正、利用権限タイプ修正の結果が201だったり

組織追加の結果が200

など、統一されていないところがありました。

※その他のAPIも、ドキュメントに載っていないコードが返ってきているものがいくつかありました。

 

現在の仕様として、処理成功で返ってくるステータスは、200と201だけという認識で正しいでしょうか。

今後の仕様変更の可能性も見据えると、200番台と考えるべきでしょうか。

もし可能であれば、番号体系のルールをご教示下さい。

 

コメント2

  • 画像

    LINE WORKS 公式アカウント

    API ResponseのHTTPステータスコードについて、現在、指針の統一化を検討中です。
    現状成功のレスポンスで利用されるステータスコードは200と201のみですが、将来的に 204 No Content 等を
    採用する可能性もございますので、200番台は成功と見ていただけると幸いです。

    2018.01.19

    0
  • 回答ありがとうございます。

    指針の統一化を検討中とのことですが、統一化された場合
    ・現在のv2の仕様が変わる
    ・将来的にv3の仕様として対応される
    どちらになりそうでしょうか。

    また、v2で仕様変更があった場合、このレベルの仕様変更は
    コミュニティサイトの「お知らせ」で通知されるでしょうか。

    分かる範囲で回答いただければ幸いです

    2018.01.19

    0