StratusVue API Services Internal

SubmittalReadRequest

Internal API: Read submittal

The following routes are available for this service:
POST	/api/internal/submittal/read

**SubmittalReadRequest** Parameters:
Name	Parameter	Data Type	Required	Description
FolderId	body	int	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

**SubmittalReadResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Submittal	form	SubmittalPackage	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

**SubmittalPackage** Parameters:
Name	Parameter	Data Type	Required
FolderId	form	int	No
FolderParentId	form	int	No
SubmittalPackageId	form	int	No
Number	form	string	No
Description	form	string	No
Status	form	string	No
Reference	form	string	No
Revision	form	string	No
SubcontractorId	form	int	No
Subcontractor	form	string	No
SubmittingCompanyContactId	form	int	No
SubmittingCompanyContact	form	string	No
ReviewingCompanyContactId	form	int	No
ReviewingCompany	form	string	No
ReviewingCompanyContact	form	string	No
ProjectManagerId	form	int	No
ProjectManager	form	string	No
IsPending	form	bool	No
DueDateFromSub	form	string	No
SourceNumber	form	string	No
TargetNumber	form	string	No
OriginalFolderId	form	int	No
ForwardedFolderId	form	int	No
Notes	form	string	No
CountTotalItems	form	int	No
CountOpenItems	form	int	No
CountClosedItems	form	int	No
BallInCourtContact	form	string	No

**FolderBase** Parameters:
Name	Parameter	Data Type	Required	Description
UserCanModify	form	bool	No
UserCanDelete	form	bool	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/SubmittalReadRequest 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

{"submittal":{"folderId":0,"folderParentId":0,"submittalPackageId":0,"number":"String","description":"String","status":"String","reference":"String","revision":"String","subcontractorId":0,"subcontractor":"String","submittingCompanyContactId":0,"submittingCompanyContact":"String","reviewingCompanyContactId":0,"reviewingCompany":"String","reviewingCompanyContact":"String","projectManagerId":0,"projectManager":"String","isPending":false,"dueDateFromSub":"String","sourceNumber":"String","targetNumber":"String","originalFolderId":0,"forwardedFolderId":0,"notes":"String","countTotalItems":0,"countOpenItems":0,"countClosedItems":0,"ballInCourtContact":"String","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}