Trendsic Platform Service

<back to all web services

PunchCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/punch
PunchCreateRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PunchNobodystringNo
TitlebodystringNo
DescriptionbodystringNo
AreabodystringNo
TradebodystringNo
PrioritybodystringNo
AssignedSubbodystringNo
AssignedTobodystringNo
AssignedSubContactIDbodyint?No
OriginTypebodystringNo
OriginRefbodystringNo
PunchItemResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ItemformPunchItemNo
SummaryformPunchSummaryNo
PunchItem Parameters:
NameParameterData TypeRequiredDescription
PunchItemIDformintNo
PunchItemUIDformGuidNo
ProjectIDformintNo
PunchNoformstringNo
TitleformstringNo
DescriptionformstringNo
AreaformstringNo
TradeformstringNo
StatusformstringNo
PriorityformstringNo
AssignedSubformstringNo
AssignedToformstringNo
AssignedSubContactIDformint?No
PhotoCountformintNo
OriginTypeformstringNo
OriginRefformstringNo
OpenedAtformDateTime?No
VerifiedAtformDateTime?No
ClosedAtformDateTime?No
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
PunchSummary Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
TotalItemsformintNo
OpenCountformintNo
VerifyCountformintNo
ClosedCountformintNo
RejectedCountformintNo
PercentCompleteformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/projects/{ProjectID}/punch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	PunchNo: String,
	Title: String,
	Description: String,
	Area: String,
	Trade: String,
	Priority: String,
	AssignedSub: String,
	AssignedTo: String,
	AssignedSubContactID: 0,
	OriginType: String,
	OriginRef: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Item: 
	{
		PunchItemID: 0,
		PunchItemUID: 00000000000000000000000000000000,
		ProjectID: 0,
		PunchNo: String,
		Title: String,
		Description: String,
		Area: String,
		Trade: String,
		Status: String,
		Priority: String,
		AssignedSub: String,
		AssignedTo: String,
		AssignedSubContactID: 0,
		PhotoCount: 0,
		OriginType: String,
		OriginRef: String,
		OpenedAt: 0001-01-01,
		VerifiedAt: 0001-01-01,
		ClosedAt: 0001-01-01,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	Summary: 
	{
		ProjectID: 0,
		TotalItems: 0,
		OpenCount: 0,
		VerifyCount: 0,
		ClosedCount: 0,
		RejectedCount: 0,
		PercentComplete: 0
	}
}