ヘルプで見つからない情報は、サポートにお問い合わせください。お問い合わせ

開発者向け機能:API機能:ユーザ操作:ユーザ取得(全て)

全ユーザレコードを取得するAPIの機能仕様です。
APIを使用してユーザのレコードを取得する事ができます。

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。

■URL
下記のURLを使用します。
https://ks01.shelterdb.net/api/users/get


■リクエスト
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX..."
}


■レスポンス(テナント管理者)
下記の形式のjsonデータが返却されます。
データのレイアウトはこちらを参照してください。 (パスワードは取得できません。)

{
    "StatusCode": 200,
    "Response": {
        "Offset": 0,
        "PageSize": 200,
        "TotalCount": 1,
        "Data": [
            {
                "TenantId": 12345,
                "UserId": 12345,
                "Ver": 1,
                "LoginId": "",
                "GlobalId": "",
                "Name": "",
                "UserCode": "",
                "LastName": "",
                "FirstName": "",
                "Birthday": "",
                "Gender": "",
                "Language": "ja",
                "TimeZone": "Tokyo Standard Time",
                "DeptCode": "",
                "DeptId": 0,
                "FirstAndLastNameOrder": 1,
                "Body": "",
                "LastLoginTime": "",
                "PasswordExpirationTime": "1899-12-30T00:00:00",
                "PasswordChangeTime": "",
                "NumberOfLogins": "",
                "NumberOfDenial": "",
                "TenantManager": ,
                "ServiceManager": ,
                "Disabled": false,
                "Lockout": false,
                "LockoutCounter": 0,
                "Developer": false,
                "UserSettings": "{\"DisableStartGuide\":true}",
                "LdapSearchRoot": "",
                "SynchronizedTime": "1899-12-30T00:00:00",
                "Comments": "[]",
                "Creator": 2,
                "Updator": 1,
                "CreatedTime": "",
                "UpdatedTime": "",
                "ApiVersion": 1.1,
                "ClassHash": {},
                "NumHash": {},
                "DateHash": {},
                "DescriptionHash": {},
                "CheckHash": {},
                "AttachmentsHash": {}
            }
        ]
    }
}

"UserSettings"内の\表記はバックスラッシュです。

■レスポンス(テナント管理者以外)
下記の形式のjsonデータが返却されます。
データのレイアウトはこちらを参照してください。 (パスワードは取得できません。)

{
    "StatusCode": 200,
    "Response": {
        "Offset": 0,
        "PageSize": 200,
        "TotalCount": 1,
        "Data": [
            {
                "TenantId": 12345,
                "UserId": 12345,
                "Ver": 1,
                "LoginId": "",
                "GlobalId": "",
                "Name": "",
                "UserCode": "",
                "LastName": "",
                "FirstName": "",
                "Birthday": "1899-12-30T00:00:00",
                "Gender": "",
                "Language": "ja",
                "TimeZone": "Tokyo Standard Time",
                "DeptCode": "",
                "DeptId": 0,
                "FirstAndLastNameOrder": 2,
                "Body": "",
                "ServiceManager": false,
                "Developer": false,
                "UserSettings": "{}",
                "LdapSearchRoot": "",
                "SynchronizedTime": "1899-12-30T00:00:00",
                "Comments": "[]",
                "Creator": 1,
                "Updator": 4,
                "CreatedTime": "",
                "UpdatedTime": "",
                "ApiVersion": 1.1,
                "ClassHash": {},
                "NumHash": {},
                "DateHash": {},
                "DescriptionHash": {},
                "CheckHash": {},
                "AttachmentsHash": {}
            }
        ]
    }
}

 

  • はじめてご利用になる方へ
Powered by Zendesk