ポジション作成

POST /v1/positions

リクエストパラメータ
パラメータ タイプ 必須 説明
parent オブジェクト はい 親ポジション.
parent.id 整数型 はい 親ポジションID.
name 文字列 はい 名称.
remark 文字列 いいえ 備考.
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
data オブジェクト 業務オブジェクト.
data.id 整数型 ポジションID.
data.parent オブジェクト 親ポジション.
data.parent.id 整数型 親ポジションID.
data.name 文字列 名称.
data.remark 文字列 備考.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/positions?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "parent" : {
    "id" : 2
  },
  "name" : "テストポジション1",
  "remark" : "テスト用"
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 2,
    "parent" : {
      "id" : 2
    },
    "name" : "テストポジション1",
    "remark" : "テスト用"
  }
}

ポジション更新

PUT /v1/positions/{id:^[1-9]\d*$}

パスパラメータ
パラメータ タイプ 必須 説明 制限
id 整数型 はい ポジションID 1より大きい必要があります, ^[1-9]\d*$
リクエストパラメータ
パラメータ タイプ 必須 説明
parent オブジェクト いいえ 親ポジション.
parent.id 整数型 いいえ 親ポジションID.
name 文字列 いいえ 名称.
remark 文字列 いいえ 備考.
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/positions/2?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "parent" : {
    "id" : 2
  },
  "name" : "テストポジション2",
  "remark" : "テスト2"
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

ポジションの検索

GET /v1/positions/{id:^[1-9]\d*$}

リクエストパラメータ
パラメータ タイプ 必須 説明 制約
id 整数型 はい ポジションID 1より大きい必要があります, ^[1-9]\d*$
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示. true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数型 ポジションID.
data.parent オブジェクト 親ポジション.
data.parent.id 整数型 親ポジションID.
data.name 文字列 名称.
data.remark 文字列 備考.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/positions/2?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 2,
    "parent" : {
      "id" : 2
    },
    "name" : "テストポジション2",
    "remark" : "テスト2"
  }
}

ポジションの削除

DELETE /v1/positions/{id:^[1-9]\d*$}

リクエストパラメータ
パラメータ タイプ 必須 説明 制約
id 整数型 はい ポジションID 1より大きい必要があります, ^[1-9]\d*$
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示. true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/positions/3?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

役職リストを取得

GET /v1/positions

レスポンスデータ
属性名 型 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示, true / false .
data 配列 業務オブジェクト.
data[].id 整数型 役職ID.
data[].parent オブジェクト 親役職.
data[].parent.id 整数型 親役職ID.
data[].name 文字列 名称.
data[].remark 文字列 備考.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/positions?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 2,
    "parent" : {
      "id" : 2
    },
    "name" : "テスト役職2",
    "remark" : "テスト2"
  }]
}