StratusVue API Services Internal

<back to all web services

FoldersStratusDriveGetByParentFolderRequest

Internal API: Get StratusDrive folders by parent folder

The following routes are available for this service:
POST/api/internal/folder/stratusdrive/getbyparentfolder
FoldersStratusDriveGetByParentFolderRequest Parameters:
NameParameterData TypeRequiredDescription
ParentFolderIdbodyintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
FoldersStratusDriveGetByParentFolderResponse Parameters:
NameParameterData TypeRequiredDescription
FolderListformList<FolderStratusDrive>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo
FolderStratusDrive Parameters:
NameParameterData TypeRequiredDescription
FolderProjectOrgIdformintNo
StratusDriveIdformstringNo
StratusDriveParentIdformstringNo
FileSizeformintNo
FolderIconformintNo
IsFolderformboolNo
Folder Parameters:
NameParameterData TypeRequiredDescription
FolderIdformintNo
FolderNameformstringNo
FolderDescriptionformstringNo
FolderParentIdformint?No
FolderTypeformintNo
FolderTypeNameformstringNo
FolderReferenceIdformintNo
FolderProjectIdformintNo
FolderSortingformintNo
AccessByListformintNo
CreatedByFullNameformstringNo
CreatedByformintNo
CreatedDateformDateTimeNo
UpdatedByFullNameformstringNo
UpdatedByformintNo
UpdatedDateformDateTimeNo
UpdatorformintNo
FolderBase Parameters:
NameParameterData TypeRequiredDescription
UserCanModifyformboolNo
UserCanDeleteformboolNo

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/FoldersStratusDriveGetByParentFolderRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"parentFolderId":0,"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"folderList":[{"folderProjectOrgId":0,"stratusDriveId":"String","stratusDriveParentId":"String","fileSize":0,"folderIcon":0,"isFolder":false,"folderId":0,"folderName":"String","folderDescription":"String","folderParentId":0,"folderType":0,"folderTypeName":"String","folderReferenceId":0,"folderProjectId":0,"folderSorting":0,"accessByList":0,"createdByFullName":"String","createdBy":0,"createdDate":"\/Date(-62135596800000-0000)\/","updatedByFullName":"String","updatedBy":0,"updatedDate":"\/Date(-62135596800000-0000)\/","updator":0,"userCanModify":false,"userCanDelete":false}],"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}