POST | /api/internal/transmittal/readinfolder |
---|
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 |
---|---|---|---|---|
TransmittalList | form | List<Transmittal> | 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 | |
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 |
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/TransmittalReadInFolderRequest 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 {"transmittalList":[{"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"]}],"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}