{"id":11970,"date":"2019-10-22T15:58:05","date_gmt":"2019-10-22T06:58:05","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11970"},"modified":"2019-11-27T10:44:35","modified_gmt":"2019-11-27T01:44:35","slug":"download-document","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/download-document\/","title":{"rendered":"2.3.6 OPA_006 Download document(Document PDF, audit trail PDF)"},"content":{"rendered":"\n

API which downloads the document<\/p>\n\n\n\n

Rest API<\/h2>\n\n\n\n
domain\/v1.0\/api\/documents\/{DOCUMENT_ID}\/download_files<\/td><\/tr><\/tbody><\/table>\n\n\n\n
  • Must use Access Token issued company.api_url for its domain<\/em><\/li><\/ul>\n\n\n\n

    Example<\/p>\n\n\n\n
    https:\/\/sg-api.eformsign.com\/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b\/download_files<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Method<\/h2>\n\n\n\n

    – GET<\/p>\n\n\n\n

    Request Header<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td>Required<\/strong><\/td><\/tr>
    access_token<\/td>String<\/td>Access token<\/td> <\/td>O<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    QueryString<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td> Miscellaneous <\/strong><\/td>Required<\/strong><\/td><\/tr>
    file_type<\/td>String<\/td>Type of the file which to download<\/td>document, audit_trail (Can use both by using , separator)<\/td>O<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Request Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Response Header<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr>
    Content-disposition<\/td>String<\/td>Content-disposition<\/td>\uc608\uc2dc attachment; filename=\uc724\uc2b9\ud658 \ud734\uac00 \uc2e0\uccad\uc11c.pdf;<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Response Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Fail Response Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    error<\/td>Object<\/td>Error details<\/td>Only appears when there is an error. Error object (includes code, message)<\/td><\/tr>
    error.code<\/td>String<\/td>Error code<\/td> <\/td><\/tr>
    error.message<\/td>String<\/td>Error message<\/td> <\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Example<\/h4>\n\n\n\n

    Request<\/strong><\/p>\n\n\n\n

    GET \/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b\/status HTTP\/1.1\n\nContent-Type : application\/json\n\naccess_token : eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJ....\n\nHOST : https:\/\/sg-api.eformsign.com<\/code><\/pre>\n\n\n\n
    Response<\/strong><\/p>\n\n\n\n
    – When succeeded<\/p>\n\n\n\n
    HTTPS\/1.1 200 OK\nContent-Type: application\/pdf\nContent-disposition : attachment; filename=John Doe approval.pdf;<\/code><\/pre>\n\n\n\n
    – When failed (error)<\/p>\n\n\n\n
    HTTPS \/ 1.1 403 forbidden\nContent-Type: application\/json\n{\n\"error\": {\n\"code\": \"4030001\",\n\"message\": \"invalid api key\"\n}\n}<\/code><\/pre>\n","protected":false},"author":1,"featured_media":0,"parent":11930,"menu_order":0,"template":"","manualdocumentationcategory":[44],"_links":{"self":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11970"}],"collection":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":1,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11970\/revisions"}],"predecessor-version":[{"id":12734,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11970\/revisions\/12734"}],"up":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11930"}],"wp:attachment":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/media?parent=11970"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11970"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}