Cochrane+ App API

<back to all web services

DeleteThunderBoltActions

Requires Authentication
The following routes are available for this service:
DELETE/thunderbolt/delete

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class EnumOption
{
    public value: number;
    public label: string;

    public constructor(init?: Partial<EnumOption>) { (Object as any).assign(this, init); }
}

export class ThunderBoltActionData
{
    public id: number;
    public actionName: string;
    public color: string;
    public dailyActionCount: number;
    public showNumberInput: boolean;
    public showEmailInput: boolean;
    public showPlatformInput: boolean;
    public showDateTimeInput: boolean;
    public contactInteractionPlatforms: EnumOption[];

    public constructor(init?: Partial<ThunderBoltActionData>) { (Object as any).assign(this, init); }
}

export class ThunderBoltActionEventData
{
    public id: number;
    public createdDate: string;
    public actionId: number;
    public actionName: string;
    public color: string;
    public notes: string;

    public constructor(init?: Partial<ThunderBoltActionEventData>) { (Object as any).assign(this, init); }
}

export class DeleteThunderBoltActionsResponse extends ApiServiceResponse
{
    public dailyActionsNumber: number;
    public thunderBoltActions: ThunderBoltActionData[];
    public thunderBoltActionEvents: ThunderBoltActionEventData[];

    public constructor(init?: Partial<DeleteThunderBoltActionsResponse>) { super(init); (Object as any).assign(this, init); }
}

export class DeleteThunderBoltActions extends ApiServiceRequest
{
    public id: number;

    public constructor(init?: Partial<DeleteThunderBoltActions>) { super(init); (Object as any).assign(this, init); }
}

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