新增管理员API

注册新管理员，使用POST发起请求，请求地址为/api/v1/administrators

  1. POST /api/v1/administrators HTTP/1.1

请求 URI

参数名 位置 类型 必填 说明
apiKey query 字符串 否 API 密钥，请参考身份认证

请求 Body

参数名 类型 必填 说明
userName 字符串 是 管理员账号
password 字符串 是 管理员密码
passwordFormat 字符串 否 密码加密格式，有Clear及Encrypt两种，分别代表不加密以及可逆加密。
CreationDate 日期 否 创建日期
LastActivityDate 日期 否 最后活动时间
CountOfLogin 数字 否 登录次数
CreatorUserName 字符串 否 创建者
isLockedOut 字符串 否 是否被锁定
departmentId 数字 否 管理员所属部门Id
areaId 数字 否 管理员所属区域Id
displayName 字符串 否 管理员姓名
email 字符串 否 邮箱
mobile 字符串 否 手机号

返回

名称 类型 说明
200 OK Administrator 管理员
401 Unauthorized Error 认证错误
400 BadRequest Error 参数错误

示例

请求示例

  1. POST /api/v1/administrators HTTP/1.1
  2. Content-Type: application/json
  3. X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
  5. {
  6.   "userName": "test",
  7.   "password": "test888",
  8.   "displayName": "演示",
  9.   "email": "test@sample.com",
  10.   "mobile": "13888888888"
  11. }

返回示例

  1. {
  2.   "value": {
  3.     "id": 2,
  4.     "userName": "test",
  5.     "password": "eZ4LFYjgfHw=",
  6.     "passwordFormat": "Encrypted",
  7.     "passwordSalt": "OrUDGQFTyboATfzWYocNOw==",
  8.     "creationDate": "2018-06-29 16:48:35",
  9.     "lastActivityDate": "2018-06-29 16:48:35",
  10.     "countOfLogin": 0,
  11.     "countOfFailedLogin": 0,
  12.     "creatorUserName": "",
  13.     "isLockedOut": false,
  14.     "siteIdCollection": "",
  15.     "siteId": 0,
  16.     "departmentId": 0,
  17.     "areaId": 0,
  18.     "displayName": "演示",
  19.     "email": "test@sample.com",
  20.     "mobile": "13888888888"
  21.   }
  22. }