cyber-port sandbox WebAPI

Data Dictionary Home

Employees : /API/v2/Employees

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

利用者

Infomation
Category
Field
Governments
Data / Business logic
Paid / Free Free
Fees
Created by
Maintainer
Date created
Last updated
Update frequency
Necessity of contract Unnecessary
About contract
Version
Terms and Conditions

API List

APIDescription
DELETE /API/v2/Employees/Delete/{employeeId}

利用者を削除します。 利用者ID（***employeeId***）を指定して、会社に所属する利用者を削除します。 このメソッドは会社の管理者（***/API/v2/Companies/Administrators***）として登録された利用者が利用できます。
GET /API/v2/Employees/Get

利用者を取得します。 ログインしている利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。
GET /API/v2/Employees/GetAccessibleReports

利用者がアクセス可能な帳票を全て取得します。 ログインしている利用者がアクセス可能な帳票を全て取得します。 アクセス可能な帳票は、利用者が所属している組織に割り当てられた事業種別を条件に、(***/API/v2/Master/ReportTypes/Permissions****)で、アクセス権限がR権限以上のものを取得します。
GET /API/v2/Employees/GetCoworkers?employeeId=!{employeeId}&emailAddress=!{emailAddress}&isActive=!{isActive}

会社の利用者を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全ての利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。
POST /API/v2/Employees/Register

所属する会社に利用者を登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者（***/API/v2/Companies/Administrators***）として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。
POST /API/v2/Employees/RegisterList

所属する会社に利用者を一括で登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者（***/API/v2/Companies/Administrators***）として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。
PATCH /API/v2/Employees/SetActive/{employeeId}

利用者が有効であるか（isActive）を更新します。 利用者ID（***employeeId***）を指定して、利用者が有効であるか（***isActive***）を更新します。 isActiveをfalseにすると、その利用者は、 ・ログインできなくなります。 ・一部を除き、サイバーポートのAPIは呼び出せません。 このメソッドは会社の管理者（***/API/v2/Companies/Administrators***）として登録された利用者が利用できます。
PATCH /API/v2/Employees/SetDefaultOrganization/{employeeId}

利用者が所属する組織の中からデフォルトの組織を更新します。 利用者ID（***employeeId***）を指定して、会社に所属する利用者について、利用者が所属する組織の中からデフォルトの組織を更新します。 このメソッドは会社の管理者（***/API/v2/Companies/Administrators***）として登録された利用者が利用できます。
PATCH /API/v2/Employees/SetEmployeeName

利用者の名称を更新します。 ログインしている利用者の名称を更新します。
PATCH /API/v2/Employees/SetEmployeeName/{employeeId}

利用者の氏名を更新します。 利用者ID（***employeeId***）を指定して、利用者の氏名を更新します。 利用者に関する詳細については、[利用者について]()を参照ください。
PATCH /API/v2/Employees/SetLanguage

利用者が利用する言語を更新します。 ログインしている利用者が利用する言語を更新します。
PATCH /API/v2/Employees/SetMailType

利用者が通知で受け取るメール形式やメールアドレスを更新します。 ログインしているが通知で受け取るメール形式やメールアドレスを更新します。