Cochrane+ App API

<back to all web services

DeleteThunderBoltActions

Requires Authentication
The following routes are available for this service:
DELETE/thunderbolt/delete
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
export class EnumOption {
    /** @param {{value?:number,label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    value;
    /** @type {string} */
    label;
}
export class ThunderBoltActionData {
    /** @param {{id?:number,actionName?:string,color?:string,dailyActionCount?:number,showNumberInput?:boolean,showEmailInput?:boolean,showPlatformInput?:boolean,showDateTimeInput?:boolean,contactInteractionPlatforms?:EnumOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    actionName;
    /** @type {string} */
    color;
    /** @type {number} */
    dailyActionCount;
    /** @type {boolean} */
    showNumberInput;
    /** @type {boolean} */
    showEmailInput;
    /** @type {boolean} */
    showPlatformInput;
    /** @type {boolean} */
    showDateTimeInput;
    /** @type {EnumOption[]} */
    contactInteractionPlatforms;
}
export class ThunderBoltActionEventData {
    /** @param {{id?:number,createdDate?:string,actionId?:number,actionName?:string,color?:string,notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    createdDate;
    /** @type {number} */
    actionId;
    /** @type {string} */
    actionName;
    /** @type {string} */
    color;
    /** @type {string} */
    notes;
}
export class DeleteThunderBoltActionsResponse extends ApiServiceResponse {
    /** @param {{dailyActionsNumber?:number,thunderBoltActions?:ThunderBoltActionData[],thunderBoltActionEvents?:ThunderBoltActionEventData[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    dailyActionsNumber;
    /** @type {ThunderBoltActionData[]} */
    thunderBoltActions;
    /** @type {ThunderBoltActionEventData[]} */
    thunderBoltActionEvents;
}
export class DeleteThunderBoltActions extends ApiServiceRequest {
    /** @param {{id?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    id;
}

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

DELETE /thunderbolt/delete HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DeleteThunderBoltActionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <DailyActionsNumber>0</DailyActionsNumber>
  <ThunderBoltActionEvents>
    <ThunderBoltActionEventData>
      <ActionId>0</ActionId>
      <ActionName>String</ActionName>
      <Color>String</Color>
      <CreatedDate>String</CreatedDate>
      <Id>0</Id>
      <Notes>String</Notes>
    </ThunderBoltActionEventData>
  </ThunderBoltActionEvents>
  <ThunderBoltActions>
    <ThunderBoltActionData>
      <ActionName>String</ActionName>
      <Color>String</Color>
      <ContactInteractionPlatforms xmlns:d4p1="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Shared">
        <d4p1:EnumOption>
          <d4p1:Label>String</d4p1:Label>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:EnumOption>
      </ContactInteractionPlatforms>
      <DailyActionCount>0</DailyActionCount>
      <Id>0</Id>
      <ShowDateTimeInput>false</ShowDateTimeInput>
      <ShowEmailInput>false</ShowEmailInput>
      <ShowNumberInput>false</ShowNumberInput>
      <ShowPlatformInput>false</ShowPlatformInput>
    </ThunderBoltActionData>
  </ThunderBoltActions>
</DeleteThunderBoltActionsResponse>