StratusVue API Services Internal

<back to all web services

StratusLinkApproveRequest

Internal API: StratusLinkApproveRequest

The following routes are available for this service:
POST/api/internal/document/stratuslink/approve
StratusLinkApproveRequest Parameters:
NameParameterData TypeRequiredDescription
ClientJsonbodyStratusLinkClientJsonYes
StateCodebodystringYes
FileContentbodystringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
StratusLinkClientJson Parameters:
NameParameterData TypeRequiredDescription
ParentFolderIdformintNo
UserEmailformstringNo
UrlformstringNo
ReturnUrlformstringNo
FileListformList<StratusLinkFile>No
StratusLinkFile Parameters:
NameParameterData TypeRequiredDescription
FolderIDformintNo
FileNameformstringNo
FileSizeformintNo
FileTypeformstringNo
FilePathformstringNo
VirtualFilePathformstringNo
StratusLinkApproveResponse Parameters:
NameParameterData TypeRequiredDescription
FolderIDformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo

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

{"clientJson":{"parentFolderId":0,"userEmail":"String","url":"String","returnUrl":"String","fileList":[{"folderID":0,"fileName":"String","fileSize":0,"fileType":"String","filePath":"String","virtualFilePath":"String"}]},"stateCode":"String","fileContent":"String","authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"folderID":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}