Cochrane+ App API

<back to all web services

GetThunderBoltActions

Requires Authentication
The following routes are available for this service:
GET/thunderbolt/actions
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;
using CommonService.Api.Models.Shared;

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace CommonService.Api.Models.Shared
{
    public partial class EnumOption
    {
        public virtual int Value { get; set; }
        public virtual string Label { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class ContactData
    {
        public virtual int ContactId { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string Email { get; set; }
        public virtual string PhoneNumber { get; set; }
    }

    public partial class GetThunderBoltActions
        : ApiServiceRequest
    {
    }

    public partial class GetThunderBoltActionsResponse
        : ApiServiceResponse
    {
        public GetThunderBoltActionsResponse()
        {
            ThunderBoltActions = new List<ThunderBoltActionData>{};
            ThunderBoltActionEvents = new List<ThunderBoltActionEventData>{};
            Contacts = new List<ContactData>{};
        }

        public virtual int DailyActionsNumber { get; set; }
        public virtual int SupportingDocumentProbability { get; set; }
        public virtual List<ThunderBoltActionData> ThunderBoltActions { get; set; }
        public virtual List<ThunderBoltActionEventData> ThunderBoltActionEvents { get; set; }
        public virtual List<ContactData> Contacts { get; set; }
    }

    public partial class ThunderBoltActionData
    {
        public ThunderBoltActionData()
        {
            ContactInteractionPlatforms = new List<EnumOption>{};
        }

        public virtual int Id { get; set; }
        public virtual string ActionName { get; set; }
        public virtual string Color { get; set; }
        public virtual int DailyActionCount { get; set; }
        public virtual bool ShowNumberInput { get; set; }
        public virtual bool ShowEmailInput { get; set; }
        public virtual bool ShowPlatformInput { get; set; }
        public virtual bool ShowDateTimeInput { get; set; }
        public virtual List<EnumOption> ContactInteractionPlatforms { get; set; }
    }

    public partial class ThunderBoltActionEventData
    {
        public virtual int Id { get; set; }
        public virtual string CreatedDate { get; set; }
        public virtual int ActionId { get; set; }
        public virtual string ActionName { get; set; }
        public virtual string Color { get; set; }
        public virtual string Notes { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

}

C# GetThunderBoltActions DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":{}}