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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PunchItem:
    punch_item_i_d: int = 0
    punch_item_u_i_d: Optional[str] = None
    project_i_d: int = 0
    punch_no: Optional[str] = None
    title: Optional[str] = None
    description: Optional[str] = None
    area: Optional[str] = None
    trade: Optional[str] = None
    status: Optional[str] = None
    priority: Optional[str] = None
    assigned_sub: Optional[str] = None
    assigned_to: Optional[str] = None
    assigned_sub_contact_i_d: Optional[int] = None
    photo_count: int = 0
    origin_type: Optional[str] = None
    origin_ref: Optional[str] = None
    opened_at: Optional[datetime.datetime] = None
    verified_at: Optional[datetime.datetime] = None
    closed_at: Optional[datetime.datetime] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PunchSummary:
    project_i_d: int = 0
    total_items: int = 0
    open_count: int = 0
    verify_count: int = 0
    closed_count: int = 0
    rejected_count: int = 0
    percent_complete: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PunchItemResponse:
    response_status: Optional[ResponseStatus] = None
    item: Optional[PunchItem] = None
    summary: Optional[PunchSummary] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PunchCreateRequest:
    project_i_d: int = 0
    punch_no: Optional[str] = None
    title: Optional[str] = None
    description: Optional[str] = None
    area: Optional[str] = None
    trade: Optional[str] = None
    priority: Optional[str] = None
    assigned_sub: Optional[str] = None
    assigned_to: Optional[str] = None
    assigned_sub_contact_i_d: Optional[int] = None
    origin_type: Optional[str] = None
    origin_ref: Optional[str] = None

Python PunchCreateRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PunchCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Area>String</Area>
  <AssignedSub>String</AssignedSub>
  <AssignedSubContactID>0</AssignedSubContactID>
  <AssignedTo>String</AssignedTo>
  <Description>String</Description>
  <OriginRef>String</OriginRef>
  <OriginType>String</OriginType>
  <Priority>String</Priority>
  <ProjectID>0</ProjectID>
  <PunchNo>String</PunchNo>
  <Title>String</Title>
  <Trade>String</Trade>
</PunchCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PunchItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Item>
    <Area>String</Area>
    <AssignedSub>String</AssignedSub>
    <AssignedSubContactID>0</AssignedSubContactID>
    <AssignedTo>String</AssignedTo>
    <ClosedAt>0001-01-01T00:00:00</ClosedAt>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <Description>String</Description>
    <OpenedAt>0001-01-01T00:00:00</OpenedAt>
    <OriginRef>String</OriginRef>
    <OriginType>String</OriginType>
    <PhotoCount>0</PhotoCount>
    <Priority>String</Priority>
    <ProjectID>0</ProjectID>
    <PunchItemID>0</PunchItemID>
    <PunchItemUID>00000000-0000-0000-0000-000000000000</PunchItemUID>
    <PunchNo>String</PunchNo>
    <Status>String</Status>
    <Title>String</Title>
    <Trade>String</Trade>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <VerifiedAt>0001-01-01T00:00:00</VerifiedAt>
  </Item>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Summary>
    <ClosedCount>0</ClosedCount>
    <OpenCount>0</OpenCount>
    <PercentComplete>0</PercentComplete>
    <ProjectID>0</ProjectID>
    <RejectedCount>0</RejectedCount>
    <TotalItems>0</TotalItems>
    <VerifyCount>0</VerifyCount>
  </Summary>
</PunchItemResponse>