Cochrane+ App API

<back to all web services

GetThunderBoltActions

Requires Authentication
The following routes are available for this service:
GET/thunderbolt/actions
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
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 .csv suffix or ?format=csv

HTTP + CSV

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

GET /thunderbolt/actions HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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":{}}