従業員の検索

GET /v2/user

このインターフェースは従業員情報の検索に使用され、従業員ID、メールアドレス、電話番号、社員番号をパラメータとして使用した検索をサポートします。

リクエストパラメータ
属性名 タイプ 必須 説明
type 整数 はい パラメータタイプ
1-従業員ID、2-メールアドレス、3-電話番号、4-社員番号
value 文字列 はい パラメータ値
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v2/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&type=1&value=430' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示可否. true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数 従業員ID.
data.email 文字列 メールアドレス.
data.position オブジェクト ポジション.
data.position.id 整数 ポジションID.
data.realname 文字列 氏名.
data.mobile 文字列 電話番号.
data.agentType 整数 エージェントタイプ：1，通常エージェント；2，電話エージェント.
data.agentRole 文字列 エージェントロール：agent,通常； leader，リーダー.
data.status 整数 有効状態：1，有効；2，無効.
data.jobStatus 整数 在職状態：1，在職；0，退職.
data.roleList 配列 ロール.
data.roleList[].id 整数 ロールID.
data.authorizationSetList 配列 権限セット.
data.authorizationSetList[].id 整数 権限セットID.
data.userInfo オブジェクト 従業員拡張詳細情報.
data.userInfo.dataId 整数 dataID.
data.userInfo.objectId 整数 従業員拡張情報レコードID.
data.userInfo.userInfoName 文字列 データ表示名(主フィールド値の冗長).
data.userInfo.fieldDataList 配列 フィールド情報リスト.
data.userInfo.fieldDataList[].fieldApiName 文字列 フィールドAPI名.
data.userInfo.fieldDataList[].fieldTypeApiName 文字列 フィールドAPI名.
data.userInfo.fieldDataList[].fieldValue 文字列 フィールド値.
data.userInfo.fieldDataList[].foreignDataName 文字列 関連オブジェクトレコード名.
data.userInfo.fieldDataList[].userEmail 文字列 関連従業員メールアドレス.
data.userInfo.fieldDataList[].optionNameList 配列 オプション名リスト(選択タイプフィールド).
data.userInfo.fieldDataList[].tagValueList 配列 タグフィールド詳細情報(電話またはメールアドレス).
data.userInfo.fieldDataList[].tagValueList[].tagName 文字列 タグ名.
data.userInfo.fieldDataList[].tagValueList[].tagValue 文字列 タグ値.
data.userInfo.fieldDataList[].richText オブジェクト リッチテキストフィールド詳細情報(内容および添付ファイル).
data.userInfo.fieldDataList[].richText.content 文字列 リッチテキスト内容.
data.userInfo.fieldDataList[].richText.attachmentList 配列 添付ファイルリスト.
data.userInfo.fieldDataList[].richText.attachmentList[].name 文字列 元のファイル名.
data.userInfo.fieldDataList[].richText.attachmentList[].docAddress 文字列 外部リンク.
data.userInfo.fieldDataList[].richText.attachmentList[].size 整数 サイズ.
data.userInfo.fieldDataList[].ownerResult オブジェクト 所有者.
data.userInfo.fieldDataList[].ownerResult.ownerType 整数 所有者タイプ.
data.userInfo.fieldDataList[].ownerResult.ownerName 文字列 所有者名.
data.userInfo.fieldDataList[].signDto オブジェクト 署名情報.
data.userInfo.fieldDataList[].signDto.url 文字列 署名画像URL.
data.userInfo.fieldDataList[].signDto.time 文字列 署名日時.
##### レスポンス例 
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 941,
    "email" : "2@test.cn",
    "position" : {
      "id" : 2
    },
    "realname" : "テスト従業員2",
    "mobile" : "13300000002",
    "agentType": 1,
    "agentRole": "agent",
    "jobStatus": 1,
    "status": 1,
    "roleList" : [ {
      "id" : 3
    } ],
    "authorizationSetList" : [ ],
    "userInfo": {
            "dataId": 2,
            "objectId": 13,
            "userInfoName": "テスト",
            "fieldDataList": [
                {
                    "fieldApiName": "sysusername",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "テスト1"
                },
                {
                    "fieldApiName": "tudi",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "テスト2"
                },
                {
                    "fieldApiName": "wuqi",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "テスト3"
                },
                {
                    "fieldApiName": "lianxidianhua",
                    "fieldTypeApiName": "field_type_telephone",
                    "tagValueList": [
                        {
                            "tagName": "携帯電話",
                            "tagValue": "15840347826"
                        },
                        {
                            "tagName": "携帯電話",
                            "tagValue": "15844578040"
                        }
                    ]
                }
            ]
        }
  }
}

従業員情報の更新

PUT /v2/user

このインターフェースは従業員情報の変更に使用され、従業員ID、メールアドレス、携帯電話番号、社員番号をパラメータとして使用した変更をサポートします。

リクエストパラメータ
属性名 タイプ 必須 説明
type 整数 はい パラメータタイプ
1-従業員ID、2-メールアドレス、3-携帯電話番号、4-社員番号
value 文字列 はい パラメータ値
パラメータ タイプ 必須 説明
-- -- -- --
realname 文字列 はい 氏名.
mobile 文字列 いいえ 携帯電話番号, 正規表現 ^1[3-9]\d{9}$ の形式を満たす必要があります.
position オブジェクト はい 役職.
position.id 整数 はい 役職ID
status 整数 いいえ 有効状態: 1有効; 2無効; 3審査中.
jobStatus 整数 いいえ 在職状態: 1在職中; 0退職.
roleList 配列 はい ロール.
roleList[].id 整数 はい ロールID.
userInfo オブジェクト いいえ 従業員拡張情報
userInfo.id 整数 いいえ 拡張情報ID
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性. true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/user/944?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&type=1&value=430' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "realname" : "テスト従業員1",
  "mobile" : "13300000001",
  "position" : {
    "id" : 2
  },
  "status" : 1,
  "jobStatus" : 1,
  "roleList" : [ {
    "id" : 2
  } ],
  "userInfo":{
    "id" : 2
  }
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

従業員の削除

DELETE /v2/user

リクエストパラメータ
属性名 タイプ 必須 説明
type 整数 はい パラメータタイプ
1-従業員ID、2-メールアドレス、3-携帯電話番号、4-社員番号
value 文字列 はい パラメータ値
##### レスポンスデータ
属性名 型 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
data オブジェクト ビジネスオブジェクト.
data.successList 配列 削除成功した従業員の集合.
data.successTotal 整数型 削除成功数
data.failMap オブジェクト 削除失敗した従業員の集合.
data.failTotal 整数型 削除失敗数
data.total 整数型 削除成功数
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v2/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&type=1&value=430' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [1],
    "successTotal" : 1,
    "failMap" : {
        "2" : "従業員が存在しません",
        "3" : "従業員は削除できません"
    },
    "failTotal" : 2,
    "total" : 3
  }
}