従業員定期区間情報一括取得

OpenAPI説明

当該OpenAPIは、従業員の最終更新日の範囲を指定し、従業員の定期区間情報を一括取得します。

OpenAPI権限

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

リクエストURI

/api/openapi/users/contactRoutes

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/users/contactRoutes?startTime=2023-02-01 00:00:00&endTime=2023-02-22 00:00:00&page=1&size=20

リクエストパラメータ説明

パラメータ名	タイプ	必須	説明
startTime	String	○	検索スタート日時。フォーマット: yyyy-MM-dd HH:mm:ss
endTime	String	○	検索エンド日時。フォーマット: yyyy-MM-dd HH:mm:ss
page	int	○	ページ、第一ページ: page=1
size	int	○	ページごとの結果数。最大50

OpenAPIリターン例

{
    "total": 1,
    "current": 1,
    "pageSize": 10,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
         "employeeId": "EMP-001",
         "employeeName": "従業員００１",
         "detailRoute": "大手町(東京都):東京メトロ東西線:Down:茅場町:東京メトロ日比谷線:Down:日比谷",
         "detailRouteNoDirection": "",
         "displayRoute": "大手町(東京都)--東京メトロ東西線--茅場町--東京メトロ日比谷線--日比谷",
         "oneMonthPrice": 6950,
         "threeMonthPrice": 19810,
         "sixMonthPrice": 37530
        },
        {
         "employeeId": "EMP-002",
         "employeeName": "従業員００2",
         "detailRoute": "大手町(東京都):東京メトロ東西線:Down:茅場町:東京メトロ日比谷線:Down:日比谷",
         "detailRouteNoDirection": "",
         "displayRoute": "大手町(東京都)--東京メトロ東西線--茅場町--東京メトロ日比谷線--日比谷",
         "oneMonthPrice": 6950,
         "threeMonthPrice": 19810,
         "sixMonthPrice": 37530
        }
    ]
}

OpenAPIリターン項目

PageResposne

パラメータ名	タイプ	説明
total	int	検索結果の総件数
current	int	当ページ数
pageSize	int	ページごとの結果数
pages	int	検索結果総ページ数
hasPrevious	boolean	前のページがあるかどうか
hasNext	boolean	次のページがあるかどうか

contactRoute

項目名	タイプ	規則	説明
employeeId	String	最大32文字	従業員番号
employeeName	String	最大100文字	従業員名前
detailRoute	String	最大999文字	定期経路文字列
detailRouteNoDirection	String	最大999文字	定期経路文字列（方向なし）
displayRoute	String	最大999文字	定期区間表示名
oneMonthPrice	Long	最大10文字	1ヶ月定期代
threeMonthPrice	Long	最大10文字	3ヶ月定期代
sixMonthPrice	Long	最大10文字	6ヶ月定期代

失敗例

{
    "message": "テナントの権限がありません",
    "errorCode": "120001"
}

項目説明

項目名	タイプ	説明
message	String	メッセージを返す
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
120001	テナントの権限がありません
4003	時間のフォーマット:{0}。

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