StratusVue API Services Internal

DocumentReadRequest

Internal API: Read Document.

The following routes are available for this service:
POST	/api/internal/document/documentread

**DocumentReadRequest** Parameters:
Name	Parameter	Data Type	Required
FolderId	body	int	No
WantThumbnail	body	bool	No
ExcludeFileContent	body	bool	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSessionKey	form	string	No
AdditionalInfo	form	List<ItemNameValue>	No

**ItemNameValue** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyName	form	string	No
PropertyValue	form	string	No

**DocumentReadResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentRevisions	form	List<DocumentRevision>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
UiErrorMessage	form	string	No
UiDevErrorMessage	form	string	No
ErrorOccured	form	bool	No
LogMessageType	form	ErrorMessageType	No
ResponseStatus	form	ResponseStatus	No
NumberOfRecordsEffected	form	int	No

**DocumentRevision** Parameters:
Name	Parameter	Data Type	Required
FolderId	form	int	No
FolderParentID	form	int	No
DocumentName	form	string	No
HasSketches	form	bool	No
CreateDate	form	DateTime	No
RevisionNumber	form	string	No
Revision	form	string	No
Type	form	string	No
Status	form	string	No
Discipline	form	string	No
CSI	form	string	No
Issue	form	string	No
IssueDate	form	DateTime	No
IssueDateOn	form	DateTime	No
FileName	form	string	No
FilePath	form	string	No
DocIcon	form	string	No
LastRevision	form	string	No
ThumbnailContent	form	byte[]	No
FileContent	form	byte[]	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/DocumentReadRequest HTTP/1.1 
Host: api.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"folderId":0,"wantThumbnail":false,"excludeFileContent":false,"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"documentRevisions":[{"folderId":0,"folderParentID":0,"documentName":"String","hasSketches":false,"createDate":"\/Date(-62135596800000-0000)\/","revisionNumber":"String","revision":"String","type":"String","status":"String","discipline":"String","csi":"String","issue":"String","issueDate":"\/Date(-62135596800000-0000)\/","issueDateOn":"\/Date(-62135596800000-0000)\/","fileName":"String","filePath":"String","docIcon":"String","lastRevision":"String","thumbnailContent":"AA==","fileContent":"AA=="}],"uiErrorMessage":"String","uiDevErrorMessage":"String","errorOccured":false,"logMessageType":"DEBUG","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"numberOfRecordsEffected":0}