Cochrane+ App API

<back to all web services

DeleteThunderBoltActions

Requires Authentication
The following routes are available for this service:
DELETE/thunderbolt/delete
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 ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EnumOption:
    value: int = 0
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThunderBoltActionData:
    id: int = 0
    action_name: Optional[str] = None
    color: Optional[str] = None
    daily_action_count: int = 0
    show_number_input: bool = False
    show_email_input: bool = False
    show_platform_input: bool = False
    show_date_time_input: bool = False
    contact_interaction_platforms: Optional[List[EnumOption]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThunderBoltActionEventData:
    id: int = 0
    created_date: Optional[str] = None
    action_id: int = 0
    action_name: Optional[str] = None
    color: Optional[str] = None
    notes: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteThunderBoltActionsResponse(ApiServiceResponse):
    daily_actions_number: int = 0
    thunder_bolt_actions: Optional[List[ThunderBoltActionData]] = None
    thunder_bolt_action_events: Optional[List[ThunderBoltActionEventData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteThunderBoltActions(ApiServiceRequest):
    id: int = 0

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