Cochrane+ App API

<back to all web services

SubmitThunderBoltAction

Requires Authentication
The following routes are available for this service:
POST/thunderbolt/submit
SubmitThunderBoltAction Parameters:
NameParameterData TypeRequiredDescription
ActionIdbodyintNo
PlatformbodyContactInteractionPlatformNo
NumberbodystringNo
EmailbodystringNo
NotesbodystringNo
DateTimebodyDateTimeNo
ContactIdbodyintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
ContactInteractionPlatform Enum:
NameValue
None0
Whatsapp1
Linkus2
Mobile3
Outlook4
LinkedIn5
Telegram6
Signal7
Sms8
SubmitThunderBoltActionResponse Parameters:
NameParameterData TypeRequiredDescription
ThunderboltActionEventIdformintNo
GetThunderBoltActionsResponse Parameters:
NameParameterData TypeRequiredDescription
DailyActionsNumberformintNo
SupportingDocumentProbabilityformintNo
ThunderBoltActionsformList<ThunderBoltActionData>No
ThunderBoltActionEventsformList<ThunderBoltActionEventData>No
ContactsformList<ContactData>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
ThunderBoltActionData Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ActionNameformstringNo
ColorformstringNo
DailyActionCountformintNo
ShowNumberInputformboolNo
ShowEmailInputformboolNo
ShowPlatformInputformboolNo
ShowDateTimeInputformboolNo
ContactInteractionPlatformsformList<EnumOption>No
EnumOption Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
LabelformstringNo
ThunderBoltActionEventData Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreatedDateformstringNo
ActionIdformintNo
ActionNameformstringNo
ColorformstringNo
NotesformstringNo
ContactData Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
ContactNameformstringNo
EmailformstringNo
PhoneNumberformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /thunderbolt/submit HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	actionId: 0,
	platform: 0,
	number: String,
	email: String,
	notes: String,
	dateTime: 0001-01-01,
	contactId: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	thunderboltActionEventId: 0,
	dailyActionsNumber: 0,
	supportingDocumentProbability: 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
		}
	],
	contacts: 
	[
		{
			
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}