POST | /api/internal/document/stratusdrive/read |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FolderId | body | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AuthSessionKey | form | string | No | |
AdditionalInfo | form | List<ItemNameValue> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PropertyName | form | string | No | |
PropertyValue | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Document | form | DocumentStratusDrive | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UiErrorMessage | form | string | No | |
UiDevErrorMessage | form | string | No | |
ErrorOccured | form | bool | No | |
LogMessageType | form | ErrorMessageType | No | |
ResponseStatus | form | ResponseStatus | No | |
NumberOfRecordsEffected | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentType | form | string | No | |
Status | form | string | No | |
Issue | form | string | No | |
IssueDate | form | string | No | |
FileName | form | string | No | |
FileType | form | string | No | |
FileSize | form | string | No | |
FilePath | form | string | No | |
FolderProjectOrgId | form | int | No | |
StratusDriveId | form | string | No | |
StratusDriveParentId | form | string | No | |
DownloadUrl | form | string | No | |
ViewerUrl | form | string | No | |
FolderIcon | form | int | No | |
IsFolder | form | bool | No | |
Discipline | form | string | No | |
Notes | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | int | No | |
FolderId | form | int | No | |
FolderName | form | string | No | |
FolderDescription | form | string | No | |
FolderParentId | form | int | No | |
CreatedDate | form | DateTime | No | |
UpdatedDate | form | DateTime | No | |
CreatedBy | form | int | No | |
UpdatedBy | form | int | No | |
FolderType | form | int | No | |
FolderReferenceId | form | int | No | |
FolderProject | form | int | No | |
AccessByList | form | int | No | |
FolderSorting | form | int | No | |
EstimatedFileSize | form | long | 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/StratusDriveDocumentReadRequest HTTP/1.1
Host: api.sagecpc.com
Content-Type: application/json
Content-Length: length
{"folderId":0,"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"document":{"documentType":"String","status":"String","issue":"String","issueDate":"String","fileName":"String","fileType":"String","fileSize":"String","filePath":"String","folderProjectOrgId":0,"stratusDriveId":"String","stratusDriveParentId":"String","downloadUrl":"String","viewerUrl":"String","folderIcon":0,"isFolder":false,"discipline":"String","notes":"String","id":0,"folderId":0,"folderName":"String","folderDescription":"String","folderParentId":0,"createdDate":"\/Date(-62135596800000-0000)\/","updatedDate":"\/Date(-62135596800000-0000)\/","createdBy":0,"updatedBy":0,"folderType":0,"folderReferenceId":0,"folderProject":0,"accessByList":0,"folderSorting":0,"estimatedFileSize":0},"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}