StratusVue API Services Internal

TransmittalReadRequest

Internal API: Read Transmittal.

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

**TransmittalReadRequest** 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

**TransmittalReadResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Transmittal	form	Transmittal	No
referencedDocuments	form	DocumentReference	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

**Transmittal** Parameters:
Name	Parameter	Data Type	Required
TempItemID	form	string	No
FolderId	form	int	No
FolderParentId	form	int	No
FolderName	form	string	No
FolderDescription	form	string	No
DateCreated	form	string	No
SubmittalId	form	int	No
TransmittalId	form	int	No
TransmittalNumber	form	string	No
TransmittalTo	form	int	No
Company	form	string	No
ToName	form	string	No
TransmittalFrom	form	int	No
FromName	form	string	No
TransmittalRef	form	string	No
PackageTransmittal	form	int	No
ProductData	form	bool	No
Samples	form	bool	No
ShopDrawings	form	bool	No
O_MManuals	form	bool	No
Plans	form	bool	No
ArchitecturalDrawings	form	bool	No
Letters	form	bool	No
Specifications	form	bool	No
Prints	form	bool	No
Addenda	form	bool	No
EngineeringDrawings	form	bool	No
ChangeOrders	form	bool	No
Submittal	form	bool	No
Other	form	bool	No
OtherText	form	string	No
Enclosed	form	bool	No
PackageTransmittalStage	form	int	No
SendOtherText	form	string	No
IsOnlyfaxable	form	bool	No
Itemsqty	form	int	No
Itemssubject	form	string	No
Itemsdescription	form	string	No
Itemsdate	form	string	No
TrackingNumber	form	string	No
Invoice	form	bool	No
SourceFrom	form	int	No
SourceTo	form	int	No
TargetFrom	form	int	No
TargetTo	form	int	No
SourceNumber	form	string	No
TargetNumber	form	string	No
OriginalFolderID	form	int	No
ForwardedFolderID	form	int	No
Subcontract	form	bool	No
PurchaseOrder	form	bool	No
RfiFolderID	form	int	No
SentVia	form	string	No
ItemTypes	form	string	No
CCUserList	form	List<string>	No

**DocumentReference** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentList	form	List<FolderDocument>	No
FolderList	form	List<Folder>	No

**FolderDocument** Parameters:
Name	Parameter	Data Type	Required
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

**Folder** Parameters:
Name	Parameter	Data Type	Required
FolderId	form	int	No
FolderName	form	string	No
FolderDescription	form	string	No
FolderParentId	form	int?	No
FolderType	form	int	No
FolderTypeName	form	string	No
FolderReferenceId	form	int	No
FolderProjectId	form	int	No
FolderSorting	form	int	No
AccessByList	form	int	No
CreatedByFullName	form	string	No
CreatedBy	form	int	No
CreatedDate	form	DateTime	No
UpdatedByFullName	form	string	No
UpdatedBy	form	int	No
UpdatedDate	form	DateTime	No
Updator	form	int	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/TransmittalReadRequest HTTP/1.1 
Host: api.sampson.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

{"transmittal":{"tempItemID":"String","folderId":0,"folderParentId":0,"folderName":"String","folderDescription":"String","dateCreated":"String","submittalId":0,"transmittalId":0,"transmittalNumber":"String","transmittalTo":0,"company":"String","toName":"String","transmittalFrom":0,"fromName":"String","transmittalRef":"String","packageTransmittal":0,"productData":false,"samples":false,"shopDrawings":false,"o_MManuals":false,"plans":false,"architecturalDrawings":false,"letters":false,"specifications":false,"prints":false,"addenda":false,"engineeringDrawings":false,"changeOrders":false,"submittal":false,"other":false,"otherText":"String","enclosed":false,"packageTransmittalStage":0,"sendOtherText":"String","isOnlyfaxable":false,"itemsqty":0,"itemssubject":"String","itemsdescription":"String","itemsdate":"String","trackingNumber":"String","invoice":false,"sourceFrom":0,"sourceTo":0,"targetFrom":0,"targetTo":0,"sourceNumber":"String","targetNumber":"String","originalFolderID":0,"forwardedFolderID":0,"subcontract":false,"purchaseOrder":false,"rfiFolderID":0,"sentVia":"String","itemTypes":"String","ccUserList":["String"]},"referencedDocuments":{"documentList":[{"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)\/"}],"folderList":[{"folderId":0,"folderName":"String","folderDescription":"String","folderParentId":0,"folderType":0,"folderTypeName":"String","folderReferenceId":0,"folderProjectId":0,"folderSorting":0,"accessByList":0,"createdByFullName":"String","createdBy":0,"createdDate":"\/Date(-62135596800000-0000)\/","updatedByFullName":"String","updatedBy":0,"updatedDate":"\/Date(-62135596800000-0000)\/","updator":0,"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}