GET /API/v1/Deals/GetListByDomesticNo
社内管理番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、社内管理番号(***domesticNo***)を指定して、取引を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 社内管理番号 社内管理番号(***domesticNo***)を指定します。
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
domesticNo | domesticNo |
String |
Required |
Body Parameters
None.
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
blNumber | B/L番号 |
String, Null |
None. |
bookingNo | ブッキング(船腹予約)番号 |
String, Null |
None. |
businessPattern | 業務パターン |
String |
Required |
businessPatternDetail |
Required |
||
createBusinessTypeId | 作成事業種別ID |
String |
Required |
createDatetime | 作成日時 |
String |
Required Format : date-time |
createEmployeeId | 作成利用者ID |
String |
Required |
createOrganizationId | 作成組織ID |
String |
Required |
dealName | 取引名 |
String, Null |
None. |
dealNo | 取引管理番号 |
String |
Required |
estimatedTimeOfArrivalPodEta | 荷揚港 入港予定日 |
String, Null |
Format : date |
estimatedTimeOfDeparturePolEtd | 積荷港 出港予定日 |
String, Null |
Format : date |
isCompleted | 取引完了フラグ |
Boolean |
Required |
organizations |
Collection of organizations |
Required |
|
parentDealNo | 親の取引管理番号 |
String, Null |
None. |
partitionNo | パーティション番号 |
Integer |
Required |
portOfDischarge | 荷揚港 名称 |
String, Null |
None. |
portOfLoading | 積荷港 名称 |
String, Null |
None. |
reports |
Collection of reports |
Required |
|
scacCode | 船社コード |
String, Null |
None. |
vesselName | 本船名 |
String, Null |
None. |
voyageNo | 航海番号 |
String, Null |
None. |