StratusVue API Services Internal

<back to all web services

RFICreateAttachmentRequest

Internal API: Create a new file attachment for a RFI.

The following routes are available for this service:
POST/api/internal/rfi/createattachment
RFICreateAttachmentRequest Parameters:
NameParameterData TypeRequiredDescription
RfiIdbodyintNo
AttachmentbodyFileNo
FileContentbodybyte[]No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
File Parameters:
NameParameterData TypeRequiredDescription
AttachmentFileIdformintNo
UploadedFileIdformintNo
UploadedFilePathformstringNo
UploadedFileNameformstringNo
UploadedFileTypeformstringNo
UploadedFileSizeformintNo
AttachmentFileDescriptionformstringNo
UploadedDateformDateTimeNo
UploadedByformstringNo
ModifiedDateformDateTimeNo
ModifiedByformstringNo
RFICreateAttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
FileIdformintNo
UploadedFileIdformintNo
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/RFICreateAttachmentRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"rfiId":0,"attachment":{"attachmentFileId":0,"uploadedFileId":0,"uploadedFilePath":"String","uploadedFileName":"String","uploadedFileType":"String","uploadedFileSize":0,"attachmentFileDescription":"String","uploadedDate":"\/Date(-62135596800000-0000)\/","uploadedBy":"String","modifiedDate":"\/Date(-62135596800000-0000)\/","modifiedBy":"String"},"fileContent":"AA==","authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"fileId":0,"uploadedFileId":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}