StratusVue API Services Internal

<back to all web services

PunchListCreateRequest

Internal API: Create PunchList.

The following routes are available for this service:
POST/api/internal/punchlist/create
PunchListCreateRequest Parameters:
NameParameterData TypeRequiredDescription
PunchListbodyPunchListNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
PunchList Parameters:
NameParameterData TypeRequiredDescription
TempItemIdformstringNo
FolderIdformintNo
FolderParentIdformintNo
ProjectIdformintNo
SummaryformstringNo
DescriptionformstringNo
PunchListIdformintNo
PunchListNumberformstringNo
LocationSiteformstringNo
LocationBuildingformstringNo
LocationFloorformstringNo
LocationRoomformstringNo
DueDateformstringNo
Statusformint?No
StatusNameformstringNo
CompletedDateformstringNo
CostImpactformboolNo
CostformstringNo
OwnerStatusformint?No
OwnerStatusNameformstringNo
DocumentIdformint?No
DocumentNumberformstringNo
NotifyingPartyformstringNo
IssueDateformstringNo
SubcontractorListStatusformint?No
SubcontractorStatusNameformstringNo
ArchitectListStatusformint?No
ArchitectStatusNameformstringNo
CostEventIdformint?No
CostEventNumberformstringNo
CostEventAmountformstringNo
CostEventStatusformstringNo
ResponsiblePartyListformList<string>No
CCUserListformList<string>No
ReferenceformstringNo
DrawingformstringNo
DrawingDetailformstringNo
FolderBase Parameters:
NameParameterData TypeRequiredDescription
UserCanModifyformboolNo
UserCanDeleteformboolNo
PunchListCreateResponse Parameters:
NameParameterData TypeRequiredDescription
PunchListIdformintNo
SubmittalIdformintNo
FolderIdformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo

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/PunchListCreateRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
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},"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"punchListId":0,"submittalId":0,"folderId":0,"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}