POST | /api/internal/rfi/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 |
---|---|---|---|---|
rfi | form | RFI | No | |
referencedDocuments | form | List<FolderDocument> | 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 |
---|---|---|---|---|
TempItemId | form | string | No | |
FolderId | form | int | No | |
FolderParentId | form | int | No | |
FolderPath | form | string | No | |
RfiId | form | int | No | |
ProjectId | form | int | No | |
ToUserId | form | int? | No | |
ToName | form | string | No | |
FromUserId | form | int? | No | |
FromName | form | string | No | |
DateSubmitted | form | string | No | |
DateDue | form | string | No | |
StatusId | form | int? | No | |
StatusName | form | string | No | |
Subject | form | string | No | |
Question | form | string | No | |
Answer | form | string | No | |
AnswerHTML | form | string | No | |
RequestReasonId | form | int? | No | |
RequestReasonName | form | string | No | |
ActionRequestedId | form | int? | No | |
ActionRequestedName | form | string | No | |
CostImpactId | form | int | No | |
Reference | form | string | No | |
Drawing | form | string | No | |
DrawingDetail | form | string | No | |
SpecSection | form | string | No | |
CsiCode | form | string | No | |
Recomendation | form | string | No | |
Comments | form | string | No | |
OriginalRfiId | form | int? | No | |
OriginalToUserId | form | int? | No | |
OriginalToUserName | form | string | No | |
OriginalFromUserId | form | int? | No | |
OriginalFromUserName | form | string | No | |
OriginalQuestion | form | string | No | |
OriginalAnswer | form | string | No | |
ScheduleImpactId | form | int? | No | |
DateTransmitted | form | string | No | |
DateClosed | form | string | No | |
DateResponsed | form | string | No | |
ChangeOrderId | form | int? | No | |
EstCostImpact | form | string | No | |
EstScheduleAmount | form | string | No | |
RecipientsList | form | string | No | |
IsOriginalClosed | form | bool | No | |
SubRfiId | form | int? | No | |
SubRfiToUserId | form | int? | No | |
SubRfiToUserName | form | string | No | |
SubRfiFromUserId | form | int? | No | |
SubRfiFromUserName | form | string | No | |
SubRfiQuestion | form | string | No | |
SubRfiAnswer | form | string | No | |
IsSubRfiClosed | form | bool | No | |
OriginalRfiFolderId | form | int? | No | |
UpOriginalRfiFolderId | form | int? | No | |
ChangeOrderNumber | form | string | No | |
ChangeOrderAmount | form | string | No | |
ChangeOrderStatus | form | string | No | |
ToCompanyId | form | int? | No | |
DocumentFileId | form | int? | No | |
CCUserList | form | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserCanModify | form | bool | No | |
UserCanDelete | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FolderId | form | int | No | |
DocumentId | form | int | No | |
DocumentNumber | form | string | No | |
DocumentDiscipline | form | int | No | |
DocumentDisciplineName | form | string | No | |
DocumentCSI | form | string | No | |
DocumentType | form | int | No | |
DocumentTypeName | form | string | No | |
DocumentStatus | form | int | No | |
DocumentStatusName | form | string | No | |
DocumentIssue | form | string | No | |
DocumentIssueDate | form | DateTime | No | |
EstimatedFileSize | form | int | No | |
UploadedFileName | form | string | No | |
UploadedFileSize | form | int | No | |
AllFilesSize | form | int | No | |
DocumentUpdateDate | form | DateTime | 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/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","scheduleImpactId":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"],"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}