切断ウェブメソッドの使用
4 min
ユーザーをテナントから切断し、セッションを削除します。
リクエスト構文
FRSHEATIntegrationConnectionResponse 切断(文字列セッションキー、文字列テナントID)パラメータ
- sessionKey: Connect Web メソッドから取得されたセッション キー文字列。
- tenantId: セッションが作成されるテナント。
戻り値
FRSHEATIntegrationConnectionResponse クラスは次のように定義されます。
パブリッククラス FRSHEATIntegrationConnectionResponse
{
パブリック文字列 connectionStatus;
パブリック文字列セッションキー;
パブリック文字列 exceptionReason;
}FRSHEATIntegrationConnectionResponse クラスには次のフィールドがあります。
- connectionStatus: 接続の状態に関するステータスを提供します。 Disconnect Web メソッドが正常に完了すると、 connectionStatus 値は null になります。
- sessionKey: 以降のすべての Web サービス操作で使用するセッション キー。 Disconnect Web メソッドが正常に完了すると、フィールド値は null になります。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
Disconnect Web メソッドが正常に完了すると、アプリケーションはセッション キーを削除します。
例外
Disconnect Web メソッド操作中 (認証フェーズまたは承認フェーズ中) にエラーが発生した場合、サーバーは SOAP 例外をスローし、Web サービス クライアントは例外を処理する必要があります。
次の表は、 Disconnect Web メソッドの実行時に発生する可能性のある例外の一覧です。
SOAP例外 | 説明 | アクション |
|---|---|---|
セッションが見つかりません | 渡されたセッション キーが存在しないか無効である場合。 | セッションキーが有効であり、サーバーに存在することを確認する |
