StratusVue API Services Internal

<back to all web services

RFIReadInFolderRequest

Internal API: RFI Read In Folder.

The following routes are available for this service:
POST/api/internal/rfi/readinfolder
RFIReadInFolderRequest Parameters:
NameParameterData TypeRequiredDescription
ParentFolderIdbodyintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
RFIReadInFolderResponse Parameters:
NameParameterData TypeRequiredDescription
RfiReadInFolderListformList<RfiReadInFolder>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo
RfiReadInFolder Parameters:
NameParameterData TypeRequiredDescription
FolderIdformintNo
RfiIdformintNo
RfiAttachformboolNo
RfiNumberformstringNo
RfiSubjectformstringNo
RfiQuestionformstringNo
RfiSubmittedformstringNo
RfiSubmittedOnformstringNo
RfiDueDateformstringNo
RfiDueDateOnformstringNo
RfiTransmittedformstringNo
OriginalLinkformstringNo
OriginalLink1formstringNo
ForwardedLinkformstringNo
ForwardedLink1formstringNo
RfiStatusformstringNo
RfiStatusOldformstringNo
ToNameformstringNo
FromNameformstringNo
CsiCodeformstringNo
OriginalRfiFolderIDformintNo
ForwardedRfiFolderIDformintNo
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/RFIReadInFolderRequest HTTP/1.1 
Host: api.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

{"rfiReadInFolderList":[{"folderId":0,"rfiId":0,"rfiAttach":false,"rfiNumber":"String","rfiSubject":"String","rfiQuestion":"String","rfiSubmitted":"String","rfiSubmittedOn":"String","rfiDueDate":"String","rfiDueDateOn":"String","rfiTransmitted":"String","originalLink":"String","originalLink1":"String","forwardedLink":"String","forwardedLink1":"String","rfiStatus":"String","rfiStatusOld":"String","toName":"String","fromName":"String","csiCode":"String","originalRfiFolderID":0,"forwardedRfiFolderID":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}