StratusVue API Services Internal

<back to all web services

RFIReadRequest

Internal API: Read RFI.

The following routes are available for this service:
POST/api/internal/rfi/read
RFIReadRequest Parameters:
NameParameterData TypeRequiredDescription
FolderIdbodyintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
RFIReadResponse Parameters:
NameParameterData TypeRequiredDescription
rfiformRFINo
referencedDocumentsformList<FolderDocument>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo
RFI Parameters:
NameParameterData TypeRequiredDescription
TempItemIdformstringNo
FolderIdformintNo
FolderParentIdformintNo
FolderPathformstringNo
RfiIdformintNo
ProjectIdformintNo
ToUserIdformint?No
ToNameformstringNo
FromUserIdformint?No
FromNameformstringNo
DateSubmittedformstringNo
DateDueformstringNo
StatusIdformint?No
StatusNameformstringNo
SubjectformstringNo
QuestionformstringNo
AnswerformstringNo
AnswerHTMLformstringNo
RequestReasonIdformint?No
RequestReasonNameformstringNo
ActionRequestedIdformint?No
ActionRequestedNameformstringNo
CostImpactIdformintNo
ReferenceformstringNo
DrawingformstringNo
DrawingDetailformstringNo
SpecSectionformstringNo
CsiCodeformstringNo
RecomendationformstringNo
CommentsformstringNo
OriginalRfiIdformint?No
OriginalToUserIdformint?No
OriginalToUserNameformstringNo
OriginalFromUserIdformint?No
OriginalFromUserNameformstringNo
OriginalQuestionformstringNo
OriginalAnswerformstringNo
ScheduleImpactformint?No
DateTransmittedformstringNo
DateClosedformstringNo
DateResponsedformstringNo
ChangeOrderIdformint?No
EstCostImpactformstringNo
EstScheduleAmountformstringNo
RecipientsListformstringNo
IsOriginalClosedformboolNo
SubRfiIdformint?No
SubRfiToUserIdformint?No
SubRfiToUserNameformstringNo
SubRfiFromUserIdformint?No
SubRfiFromUserNameformstringNo
SubRfiQuestionformstringNo
SubRfiAnswerformstringNo
IsSubRfiClosedformboolNo
OriginalRfiFolderIdformint?No
UpOriginalRfiFolderIdformint?No
ChangeOrderNumberformstringNo
ChangeOrderAmountformstringNo
ChangeOrderStatusformstringNo
ToCompanyIdformint?No
DocumentFileIdformint?No
CCUserListformList<string>No
sCCUserListformstringNo
CollaborationIDformintNo
FolderBase Parameters:
NameParameterData TypeRequiredDescription
UserCanModifyformboolNo
UserCanDeleteformboolNo
FolderDocument Parameters:
NameParameterData TypeRequiredDescription
FolderIdformintNo
DocumentIdformintNo
DocumentNumberformstringNo
DocumentDisciplineformintNo
DocumentDisciplineNameformstringNo
DocumentCSIformstringNo
DocumentTypeformintNo
DocumentTypeNameformstringNo
DocumentStatusformintNo
DocumentStatusNameformstringNo
DocumentIssueformstringNo
DocumentIssueDateformDateTimeNo
EstimatedFileSizeformintNo
UploadedFileNameformstringNo
UploadedFileSizeformintNo
AllFilesSizeformintNo
DocumentUpdateDateformDateTimeNo

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/RFIReadRequest 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

{"rfi":{"tempItemId":"String","folderId":0,"folderParentId":0,"folderPath":"String","rfiId":0,"projectId":0,"toUserId":0,"toName":"String","fromUserId":0,"fromName":"String","dateSubmitted":"String","dateDue":"String","statusId":0,"statusName":"String","subject":"String","question":"String","answer":"String","answerHTML":"String","requestReasonId":0,"requestReasonName":"String","actionRequestedId":0,"actionRequestedName":"String","costImpactId":0,"reference":"String","drawing":"String","drawingDetail":"String","specSection":"String","csiCode":"String","recomendation":"String","comments":"String","originalRfiId":0,"originalToUserId":0,"originalToUserName":"String","originalFromUserId":0,"originalFromUserName":"String","originalQuestion":"String","originalAnswer":"String","scheduleImpact":0,"dateTransmitted":"String","dateClosed":"String","dateResponsed":"String","changeOrderId":0,"estCostImpact":"String","estScheduleAmount":"String","recipientsList":"String","isOriginalClosed":false,"subRfiId":0,"subRfiToUserId":0,"subRfiToUserName":"String","subRfiFromUserId":0,"subRfiFromUserName":"String","subRfiQuestion":"String","subRfiAnswer":"String","isSubRfiClosed":false,"originalRfiFolderId":0,"upOriginalRfiFolderId":0,"changeOrderNumber":"String","changeOrderAmount":"String","changeOrderStatus":"String","toCompanyId":0,"documentFileId":0,"ccUserList":["String"],"sCCUserList":"String","collaborationID":0,"userCanModify":false,"userCanDelete":false},"referencedDocuments":[{"folderId":0,"documentId":0,"documentNumber":"String","documentDiscipline":0,"documentDisciplineName":"String","documentCSI":"String","documentType":0,"documentTypeName":"String","documentStatus":0,"documentStatusName":"String","documentIssue":"String","documentIssueDate":"\/Date(-62135596800000-0000)\/","estimatedFileSize":0,"uploadedFileName":"String","uploadedFileSize":0,"allFilesSize":0,"documentUpdateDate":"\/Date(-62135596800000-0000)\/"}],"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}