POST | /api/internal/submittalitem/read |
---|
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 |
---|---|---|---|---|
SubmittalItem | form | SubmittalItem | 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 |
---|---|---|---|---|
FolderId | form | int | No | |
FolderParentId | form | int | No | |
SubmittalItemId | form | int | No | |
SubmittalItemNumber | form | string | No | |
Description | form | string | No | |
Stage | form | string | No | |
Revision | form | string | No | |
CSI | form | string | No | |
RequiredReviewDays | form | string | No | |
Status | form | string | No | |
CopiesSubmitted | form | string | No | |
SubmittedDueDate | form | string | No | |
DateSubmitted | form | string | No | |
Type | form | string | No | |
ReturnedStatus | form | string | No | |
ReturnedCopies | form | string | No | |
ReturnedDueDate | form | string | No | |
DateReceived | form | string | No | |
DateReturned | form | string | No | |
ExplClosed | form | string | No | |
ReturnedNote | form | string | No | |
DateReturnedToSub | form | string | No | |
DateReceivedFromSub | form | string | No | |
ResponsibleContractor | form | string | No | |
Notes | form | string | No | |
StatusId | form | string | No | |
TypeId | form | int | No | |
ResponsibleContractorId | form | int | No | |
ReturnedStatusId | form | string | No | |
StageName | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SubmittalItemReadRequest 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 {"submittalItem":{"folderId":0,"folderParentId":0,"submittalItemId":0,"submittalItemNumber":"String","description":"String","stage":"String","revision":"String","csi":"String","requiredReviewDays":"String","status":"String","copiesSubmitted":"String","submittedDueDate":"String","dateSubmitted":"String","type":"String","returnedStatus":"String","returnedCopies":"String","returnedDueDate":"String","dateReceived":"String","dateReturned":"String","explClosed":"String","returnedNote":"String","dateReturnedToSub":"String","dateReceivedFromSub":"String","responsibleContractor":"String","notes":"String","statusId":"String","typeId":0,"responsibleContractorId":0,"returnedStatusId":"String","stageName":"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}