文档中心 > API类目 > iHome CBD API

alibaba.ihome.cbd.saas.order.files.get (订单文件获取)

大北窑项目,外部三方通过此接口获取订单中加签好的生产文件 OSS 链接,用于订单的拆审操作

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
data String 必须 {"subOrderId": "123"} 业务的关键参数,包装子订单ID

响应参数

名称 类型 示例值 描述
result Result 接口返回的包装类型
  • data
  • Data
  • 1234
  • 订单文件的包装类型
  • └ file_url
  • String
  • https://xxx/xx.json
  • 订单的下单文件 OSS URL
  • └ file_type
  • String
  • json
  • 订单的下单文件类型
  • └ three_view_pdf_url
  • String
  • https://xxx/xx.pdf
  • 【已废弃】当 fileType == json 时,对应三视图 PDF 文件的 OSS URL
  • └ floor_plan_url
  • String
  • https://xxx/xx.jpg
  • 【已废弃】当 fileType == json 时,对应平面图文件的 OSS URL
  • └ label_graph_urls
  • String []
  • ["https://xxx/xx.jpg"]
  • 当 fileType == json 时,对应下单标注图文件的 OSS URL 列表
  • └ attachment_file_urls
  • String []
  • ["https://xxx/xx.jpg"]
  • 子订单的下单附件文件 OSS URL 列表
  • └ contract_id
  • String
  • 123
  • 当 fileType == cad 时,对应文件方案的合同类型 ID
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ error_code
  • String
  • isv.invalid-parameter
  • 错误码
  • └ error_msg
  • String
  • 参数错误
  • 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIhomeCbdSaasOrderFilesGetRequest req = new AlibabaIhomeCbdSaasOrderFilesGetRequest();
req.setData("{\"subOrderId\": \"123\"}");
AlibabaIhomeCbdSaasOrderFilesGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ihome_cbd_saas_order_files_get_response>
    <result>
        <data>
            <file_url>https://xxx/xx.json</file_url>
            <file_type>json</file_type>
            <three_view_pdf_url>https://xxx/xx.pdf</three_view_pdf_url>
            <floor_plan_url>https://xxx/xx.jpg</floor_plan_url>
            <label_graph_urls>
                <string>[&quot;https://xxx/xx.jpg&quot;]</string>
            </label_graph_urls>
            <attachment_file_urls>
                <string>[&quot;https://xxx/xx.jpg&quot;]</string>
            </attachment_file_urls>
            <contract_id>123</contract_id>
        </data>
        <success>true</success>
        <error_code>isv.invalid-parameter</error_code>
        <error_msg>参数错误</error_msg>
    </result>
</alibaba_ihome_cbd_saas_order_files_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部