Trendsic Platform Service

<back to all web services

ToolboxAckRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/safety/toolbox/{ToolboxTalkID}/ack
"use strict";
export class ToolboxRosterMember {
    /** @param {{ContactID?:number,ContactName?:string,HasAcked?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactID;
    /** @type {string} */
    ContactName;
    /** @type {boolean} */
    HasAcked;
}
export class ToolboxTalkToday {
    /** @param {{ToolboxTalkID?:number,Topic?:string,Presenter?:string,AckCount?:number,CrewTotal?:number,Roster?:ToolboxRosterMember[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ToolboxTalkID;
    /** @type {string} */
    Topic;
    /** @type {string} */
    Presenter;
    /** @type {number} */
    AckCount;
    /** @type {number} */
    CrewTotal;
    /** @type {ToolboxRosterMember[]} */
    Roster = [];
}
export class ToolboxTalkTodayResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Talk?:ToolboxTalkToday}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ToolboxTalkToday} */
    Talk;
}
export class ToolboxAckRequest {
    /** @param {{ToolboxTalkID?:number,ContactID?:number,CrewName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ToolboxTalkID;
    /** @type {?number} */
    ContactID;
    /** @type {string} */
    CrewName;
}

JavaScript ToolboxAckRequest 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/safety/toolbox/{ToolboxTalkID}/ack HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ToolboxAckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactID>0</ContactID>
  <CrewName>String</CrewName>
  <ToolboxTalkID>0</ToolboxTalkID>
</ToolboxAckRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ToolboxTalkTodayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Talk>
    <AckCount>0</AckCount>
    <CrewTotal>0</CrewTotal>
    <Presenter>String</Presenter>
    <Roster>
      <ToolboxRosterMember>
        <ContactID>0</ContactID>
        <ContactName>String</ContactName>
        <HasAcked>false</HasAcked>
      </ToolboxRosterMember>
    </Roster>
    <ToolboxTalkID>0</ToolboxTalkID>
    <Topic>String</Topic>
  </Talk>
</ToolboxTalkTodayResponse>