Cochrane+ App API

<back to all web services

DeleteThunderBoltActions

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

DELETE /thunderbolt/delete HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	dailyActionsNumber: 0,
	thunderBoltActions: 
	[
		{
			id: 0,
			actionName: String,
			color: String,
			dailyActionCount: 0,
			showNumberInput: False,
			showEmailInput: False,
			showPlatformInput: False,
			showDateTimeInput: False,
			contactInteractionPlatforms: 
			[
				{
					value: 0,
					label: String
				}
			]
		}
	],
	thunderBoltActionEvents: 
	[
		{
			id: 0,
			createdDate: String,
			actionId: 0,
			actionName: String,
			color: String,
			notes: String
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}