StratusVue API Services Internal

DocumentCreateRequest

Internal API: Create Document.

The following routes are available for this service:
POST	/api/internal/document/documentcreate

**DocumentCreateRequest** Parameters:
Name	Parameter	Data Type	Required
ParentFolderId	body	int	No
DocumentDescription	body	string	No
DocumentNumber	body	string	No
DocumentDiscipline	body	int	No
DocumentCSI	body	string	No
DocumentType	body	int	No
DocumentStatus	body	int	No
DocumentIssue	body	string	No
DocumentIssueDate	body	string	No
FileName	body	string	No
FileType	body	string	No
FileSize	body	int	No
FileContent	body	byte[]	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSessionKey	form	string	No
AdditionalInfo	form	List<ItemNameValue>	No

**ItemNameValue** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyName	form	string	No
PropertyValue	form	string	No

**DocumentCreateResponse** Parameters:
Name	Parameter	Data Type	Required
NewId	form	int	No
NewFolderId	form	int	No
FilePath	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
UiErrorMessage	form	string	No
UiDevErrorMessage	form	string	No
ErrorOccured	form	bool	No
LogMessageType	form	ErrorMessageType	No
ResponseStatus	form	ResponseStatus	No
NumberOfRecordsEffected	form	int	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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/DocumentCreateRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"parentFolderId":0,"documentDescription":"String","documentNumber":"String","documentDiscipline":0,"documentCSI":"String","documentType":0,"documentStatus":0,"documentIssue":"String","documentIssueDate":"String","fileName":"String","fileType":"String","fileSize":0,"fileContent":"AA==","authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"newId":0,"newFolderId":0,"filePath":"String","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}