2600 API Get

Introduction

The purpose of this service is to return a document prepared in an earlier service call, for example a POD is requested, the document is produced and the caller is provided the Document GUID.  This Document GUID can be passed to this service to retrieve it.  Documents are cleared on a regular basis so the caller should not rely on them being available forever.  The intention is that when a Document GUID is provided through a call to another service, the caller downloads it immediately to not have to retrieve it again.

Parameters

Parameter

Details

Required

Parameter

Details

Required

GUID

The Document GUID

Mandatory

Example

http://<pathtoapi>/service/Document/GUID/bf5ca7de-d647-4a80-bd40-1b3ae077d66f

Response

If the call is successful, the document is returned along with it's associated MIME type.  Otherwise an XML response will be provided:

Response Codes

Common response codes

Code

Message

Code

Message

204

The GUID is either incorrect or the document is no longer available.



Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.