版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

# API 接口文档                                                                                                                      

                                                                                                                                        

  ## 1. 根据货主ID获取设施列表                                                                                                          

  ### 基本信息

  | 项目 | 内容 |

  |------|------|

  | 接口名称 | 根据货主ID获取设施列表 |

...

接口名称

根据 PartyId 查询 Facility 列表

...

接口地址

/api/shipper/v1/facility/

...

getByPartyId

...

请求方式

...

  | 环境 | QA (tracking-qa.etowertech.com) |

  ### 请求头

  | 参数名 | 示例值 | 必填 | 说明 |

  |--------|--------|------|------|

  | Accept | application/json, text/plain, */* | 是 | 期望返回类型 |

  | Accept-Language | zh-CN,zh;q=0.9 | 否 | 语言偏好 |

  | language | zh_CN | 是 | 语言设置 |

  | sessionId | AEjG-pLwqLIfSBVHJVcwpg | 是 | 会话ID |

...

GET

...

请求头

参数类型必填说明
sessionIdString登录会话ID
languageString语言

语言取值:

说明
zh_CN中文
en_US英文

...

请求参数

...

请求示例

curl 'https://tracking-qa.etowertech.com

...

/

...

  ### 请求参数

  该接口通过 `sessionId` 获取当前货主信息,无需额外传递参数。

  ### 请求示例

  \```http

...

api/shipper/v1/facility/getByPartyId

...

  Host: tracking-qa.etowertech.com

  sessionId: AEjG-pLwqLIfSBVHJVcwpg

  language: zh_CN

  Accept: application/json, text/plain, */*

  \```

  ### 返回示例

  \```json

  {

    "success": true,

    "code": "0",

    "data": [

      "*", "111", "1111119", "12313213", "1234235", "15472", "34W7E",

...

' \
  -H 'sessionId: AEjG-pLwqLIfSBVHJVcwpg' \
  -H 'language: zh_CN'

...

返回示例

{
  "success": true,
  "code": "0",
  "data": ["ADL","AKL","ATL

...

",

...

"BNE

...

","CAN

...

",

...

"

...

HKG

...

","LAX",

...

"

...

MEL

...

      "MEL2", "MEL3", "MELWW", "NGB", "NNY", "OCSYD01", "OCSYD02",

...

",

...

"

...

SYD

...

      "test", "TEST0325", "TWN", "UK", "US", "US-CA-YB", "US-LA-01",

...

"

...

      "仓库代码", "我", "测试", "测试1"

    ],

...

],
  "errors": []

...


}

  \```

  ### 返回字段说明

  | 字段名 | 类型 | 说明 |

  |--------|------|------|

  | success | Boolean | 请求是否成功,`true` 表示成功 |

  | code | String | 响应状态码,`"0"` 表示成功 |

  | data | Array\<String\> | 设施代码列表,返回该货主关联的所有设施代码 |

...

返回字段说明

字段类型说明
successBoolean请求是否成功
codeString返回状态码
dataArrayFacility 代码列表
errorsArray错误信息

...

data 字段说明

data 返回的是 Facility Code 字符串数组

示例值说明
MELMelbourne 仓库
SYDSydney 仓库
LAXLos Angeles 仓库
HKGHong Kong 仓库

实际返回值取决于系统配置的 Facility 列表。