従業員定期区間情報の連携

OpenAPI説明

当該OpenAPIは従業員の定期区間情報を連携する際に利用します。

OpenAPI権限

当該OpenAPIはテナント権限が必要です。

リクエストURI

/api/openapi/users/contactRoutes

リクエスト形式

POST

リクエスト例

{
    "employeeId": "EMP-001",
    "employeeName": "従業員００１",
    "detailRoute": "大手町(東京都):東京メトロ東西線:Down:茅場町:東京メトロ日比谷線:Down:日比谷",
    "detailRouteNoDirection": "",
    "displayRoute": "大手町(東京都)--東京メトロ東西線--茅場町--東京メトロ日比谷線--日比谷",
    "oneMonthPrice": 6950,
    "threeMonthPrice": 19810,
    "sixMonthPrice": 37530,
    "status": "1001"
}

リクエスト項目

項目名	タイプ	必須	キー	規則	説明
employeeId	String	○	○	最大32文字	従業員番号
employeeName	String			最大100文字	従業員名前
detailRoute	String	△		最大999文字	定期経路文字列ステータス：1002の場合、当該の項目が利用しません
detailRouteNoDirection	String	△		最大999文字	定期経路文字列（方向なし）定期経路文字列が空白である場合、当該の項目が入力必須ですステータス：1002の場合、当該の項目が利用しません
displayRoute	String	△		最大999文字	定期区間表示名ステータス：1002の場合、当該の項目が利用しません
oneMonthPrice	Long			最大10文字	1ヶ月定期代
threeMonthPrice	Long			最大10文字	3ヶ月定期代
sixMonthPrice	Long			最大10文字	6ヶ月定期代
status	String	○			ステータス 1001：追加 1002：削除

OpenAPIリターン例

成功例

{
    "message": "success",
    "key": "xxx123456"
}

失敗例

{
    "message": "パラメータ:{0}は指定必須の項目です",
    "errorCode": "120003"
}

項目説明

項目名	タイプ	説明
message	String	エラーメッセージを返す
key	String	従業員番号
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
120003	パラメータ:{0}は指定必須の項目です
SPD.5394.0008	{0}は{1}文字以内で入力してください
SPD.5394.0006	定期経路文字列と定期経路文字列（方向なし）はいずれかを入力してください
SPD.5394.0009	{0}は正整数且つ9,999,999,999以上にすることはできません
SPD.5394.0010	ステータスが無効です
6047065	従業員番号は存在しませんまたは退職済の従業員です

← 従業員TMステータス更新従業員定期区間情報一括取得 →