| POST | /api/internal/punchlist/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 |
|---|---|---|---|---|
| PunchList | form | PunchList | No | |
| referencedDocuments | form | List<FolderDocument> | 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 | |
| ProjectId | form | int | No | |
| Summary | form | string | No | |
| Description | form | string | No | |
| PunchListId | form | int | No | |
| PunchListNumber | form | string | No | |
| LocationSite | form | string | No | |
| LocationBuilding | form | string | No | |
| LocationFloor | form | string | No | |
| LocationRoom | form | string | No | |
| DueDate | form | string | No | |
| Status | form | int? | No | |
| StatusName | form | string | No | |
| CompletedDate | form | string | No | |
| CostImpact | form | bool | No | |
| Cost | form | string | No | |
| OwnerStatus | form | int? | No | |
| OwnerStatusName | form | string | No | |
| DocumentId | form | int? | No | |
| DocumentNumber | form | string | No | |
| NotifyingParty | form | string | No | |
| IssueDate | form | string | No | |
| SubcontractorListStatus | form | int? | No | |
| SubcontractorStatusName | form | string | No | |
| ArchitectListStatus | form | int? | No | |
| ArchitectStatusName | form | string | No | |
| CostEventId | form | int? | No | |
| CostEventNumber | form | string | No | |
| CostEventAmount | form | string | No | |
| CostEventStatus | form | string | No | |
| ResponsiblePartyList | form | List<string> | No | |
| CCUserList | form | List<string> | No | |
| Reference | form | string | No | |
| Drawing | form | string | No | |
| DrawingDetail | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserCanModify | form | bool | No | |
| UserCanDelete | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
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/PunchListReadRequest 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
{"punchList":{"tempItemId":"String","folderId":0,"folderParentId":0,"projectId":0,"summary":"String","description":"String","punchListId":0,"punchListNumber":"String","locationSite":"String","locationBuilding":"String","locationFloor":"String","locationRoom":"String","dueDate":"String","status":0,"statusName":"String","completedDate":"String","costImpact":false,"cost":"String","ownerStatus":0,"ownerStatusName":"String","documentId":0,"documentNumber":"String","notifyingParty":"String","issueDate":"String","subcontractorListStatus":0,"subcontractorStatusName":"String","architectListStatus":0,"architectStatusName":"String","costEventId":0,"costEventNumber":"String","costEventAmount":"String","costEventStatus":"String","responsiblePartyList":["String"],"ccUserList":["String"],"reference":"String","drawing":"String","drawingDetail":"String","userCanModify":false,"userCanDelete":false},"referencedDocuments":[{"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)\/"}],"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}