Create Session (Legacy API)
The Legacy Create Session
API is an API that matches the implementation of the /CreateSession
endpoint of the previous Web Tier samples. This API is deprecated in PrizmDoc Application Services, and is available for backwards compatibility only. Please use the new ViewingSession API instead.
GET /CreateSession?document={document name}
Routes key: LegacyCreateSession
Creates a viewing session based on a specific document in storage.
GET http://localhost:3000/CreateSession?document=Sample.doc
To make the equivalent call using the new ViewingSession
API:
POST http://localhost:3000/ViewingSession
Content-Type: application/json
{
"source": {
"type": "document",
"fileName": "Sample.doc"
}
}
Successful Response:
200 OK
Content-Type: application/json
{ "viewingSessionId": "1234..." }
Errored Responses:
When the document does not exist:
404 Not Found
Content-Type: application/json
{ "errorCode": "DocumentNotFound" }
When an unknown error occurs while gathering data:
580 Server Error
Content-Type: application/json
{ "errorCode": "InternalError" }
GET /CreateSession?form={formDefinitionId}
Routes key: LegacyCreateSession
Creates a viewing session for the document referenced by a form definition.
GET http://localhost:3000/CreateSession?form=03f3e9c4a976419da576276acc427700
There is no equivalent to this call in the new ViewingSession
API. Instead, the user should refer to the templateDocumentId
field in the form definition JSON object, and use it as a document to create a viewing session.
Errored Responses:
When the form definition does not exist:
404 Not Found
Content-Type: application/json
{ "errorCode": "FormDefinitionNotFound" }
When the document referenced by the form definition does not exist:
404 Not Found
Content-Type: application/json
{ "errorCode": "DocumentNotFound" }
When an unknown error occurs while gathering data:
580 Server Error
Content-Type: application/json
{ "errorCode": "InternalError" }