機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

電子メール・アドレスを持つユーザーの取得

get

/documents/api/1.2/users/search/items

サービスは、コールで指定された検索テキストとして電子メール・アドレスを使用して、特定のユーザーを照合します。 検索では、一致するユーザーがいる場合、そのユーザーが返されます。

リクエスト

サポートされるメディア・タイプ

• application/json
• application/xml

問合せパラメータ

• email: string

  (必須)一致する特定のユーザーを返すために使用する検索文字列として電子メール・アドレスを指定します。 ワイルドカード文字は使用できません。

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

一致するユーザーがいない場合、countとerrorCodeは0になり、アイテムは返されません。

本文 ()

ルート・スキーマ: UsersResponse

タイプ: object

フォルダのメタデータ情報。

ソースを表示

• count(optional): string
  見つかったユーザーの数。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• items(optional): array items
  アイテムの最少数: 0

{
    "description":"Folder metadata information.",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of users found."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            },
            "minItems":0
        }
    }
}

ネストされたスキーマ: items

タイプ: array

アイテムの最少数: 0

ソースを表示

• Array of: object User
  ユーザー情報

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    },
    "minItems":0
}

ネストされたスキーマ: User

タイプ: object

ユーザー情報

ソースを表示

• displayName(optional): string
  ユーザーの表示名
• id(optional): string
  ユーザーのグローバル一意識別子(GUID)。
• loginName(optional): string
  ユーザーのログイン名。
• type(optional): string
  アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

レスポンスの例(application/json)

{
    "count":"1",
    "errorCode":"0",
    "items":[
        {
            "id":"U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName":"User AA",
            "loginName":"userAALoginName",
            "type":"user"
        }
    ]
}

400レスポンス

必須フィールド"email"が指定されていません。

トップに戻る

例

次の例では、指定した電子メール・アドレスを持つユーザーが返されます。

GET .../users/search/items?email=[e-mail]

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "1",
    "errorCode": "0",
    "items": [
        {
            "type": "user",
            "id": "Tenant1.UserB",
            "displayName": "Tenant1 UserB",
            "loginName": "userBBLoginName"
        }
    ]
}

例2

次の例は、一致が検出されなかったemailによるユーザーの検索の結果を示しています。

GET .../users/search/items?email=[e-mail]

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "0",
    "errorCode": "0"
}

例3

次の例は、emailパラメータの受渡しがないユーザーの検索の結果を示しています。

GET .../users/search/items?emailtypo=[e-mail]

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "count": "0",
    "errorCode": "-97",
    "errorKey": "!csUnableToRetrieveUserList!csRequiredFieldMissing2,dEmail",
    "errorMessage": "Unable to retrieve user list. The required field 'dEmail' is missing.",
    "title": "Unable to retrieve user list. The required field 'dEmail' is missing.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る