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
"use strict";
export class PunchItem {
    /** @param {{PunchItemID?:number,PunchItemUID?:string,ProjectID?:number,PunchNo?:string,Title?:string,Description?:string,Area?:string,Trade?:string,Status?:string,Priority?:string,AssignedSub?:string,AssignedTo?:string,AssignedSubContactID?:number,PhotoCount?:number,OriginType?:string,OriginRef?:string,OpenedAt?:string,VerifiedAt?:string,ClosedAt?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PunchItemID;
    /** @type {string} */
    PunchItemUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    PunchNo;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    Area;
    /** @type {string} */
    Trade;
    /** @type {string} */
    Status;
    /** @type {string} */
    Priority;
    /** @type {string} */
    AssignedSub;
    /** @type {string} */
    AssignedTo;
    /** @type {?number} */
    AssignedSubContactID;
    /** @type {number} */
    PhotoCount;
    /** @type {string} */
    OriginType;
    /** @type {string} */
    OriginRef;
    /** @type {?string} */
    OpenedAt;
    /** @type {?string} */
    VerifiedAt;
    /** @type {?string} */
    ClosedAt;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class PunchSummary {
    /** @param {{ProjectID?:number,TotalItems?:number,OpenCount?:number,VerifyCount?:number,ClosedCount?:number,RejectedCount?:number,PercentComplete?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    TotalItems;
    /** @type {number} */
    OpenCount;
    /** @type {number} */
    VerifyCount;
    /** @type {number} */
    ClosedCount;
    /** @type {number} */
    RejectedCount;
    /** @type {number} */
    PercentComplete;
}
export class PunchItemResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Item?:PunchItem,Summary?:PunchSummary}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PunchItem} */
    Item;
    /** @type {PunchSummary} */
    Summary;
}
export class PunchCreateRequest {
    /** @param {{ProjectID?:number,PunchNo?:string,Title?:string,Description?:string,Area?:string,Trade?:string,Priority?:string,AssignedSub?:string,AssignedTo?:string,AssignedSubContactID?:number,OriginType?:string,OriginRef?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    PunchNo;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    Area;
    /** @type {string} */
    Trade;
    /** @type {string} */
    Priority;
    /** @type {string} */
    AssignedSub;
    /** @type {string} */
    AssignedTo;
    /** @type {?number} */
    AssignedSubContactID;
    /** @type {string} */
    OriginType;
    /** @type {string} */
    OriginRef;
}

JavaScript 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>