10.2.2 Create session using URI

POST http://{{rip_ip}}:5438/preflight/session

Creates a session by providing the document in its original form. It returns the session ID when successful.

Documents up to 256 MB can be sent completely in the body. For larger files use “Transfer-Encoding” : “chunked”.

Creates a session by providing the URI to the document. It returns the session ID when successful.

Request

JSON object containing the URI to the document:

  • URI (string) : file or http URI to the document
  • Password (string, optional) : password to use for the document

Response

Success
  • 200 OK : {"Message":"Session created", "Id":"c186c74d-8800-43fa-95a6-6228134ec5d8" }
Error
  • 400 Bad Request : {"Message":"'URI' required"}
  • 400 Bad Request : {"Message":"URI format not supported"}
  • 404 Not Found : {"Message":"Document not found"}
  • 404 Not Found : {"Message":"Could not connect to server"}
  • 415 Unsupported Media Type : {"Message":"This request is not properly formatted"}
  • 500 Internal Error : {"Message":"An error has occurred"}
  • 500 Internal Error : {"Message":"Transfer interrupted"}
  • 504 Gateway Timeout : {"Message":"Time-out while downloading"}

Request Body

{"URI"=>"https://www.someserver.com/store/MyDocument.pdf"}