Cochrane+ App API

<back to all web services

GetThunderBoltActions

Requires Authentication
The following routes are available for this service:
GET/thunderbolt/actions
import Foundation
import ServiceStack

public class GetThunderBoltActions : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class GetThunderBoltActionsResponse : ApiServiceResponse
{
    public var dailyActionsNumber:Int
    public var supportingDocumentProbability:Int
    public var thunderBoltActions:[ThunderBoltActionData] = []
    public var thunderBoltActionEvents:[ThunderBoltActionEventData] = []
    public var contacts:[ContactData] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case dailyActionsNumber
        case supportingDocumentProbability
        case thunderBoltActions
        case thunderBoltActionEvents
        case contacts
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dailyActionsNumber = try container.decodeIfPresent(Int.self, forKey: .dailyActionsNumber)
        supportingDocumentProbability = try container.decodeIfPresent(Int.self, forKey: .supportingDocumentProbability)
        thunderBoltActions = try container.decodeIfPresent([ThunderBoltActionData].self, forKey: .thunderBoltActions) ?? []
        thunderBoltActionEvents = try container.decodeIfPresent([ThunderBoltActionEventData].self, forKey: .thunderBoltActionEvents) ?? []
        contacts = try container.decodeIfPresent([ContactData].self, forKey: .contacts) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dailyActionsNumber != nil { try container.encode(dailyActionsNumber, forKey: .dailyActionsNumber) }
        if supportingDocumentProbability != nil { try container.encode(supportingDocumentProbability, forKey: .supportingDocumentProbability) }
        if thunderBoltActions.count > 0 { try container.encode(thunderBoltActions, forKey: .thunderBoltActions) }
        if thunderBoltActionEvents.count > 0 { try container.encode(thunderBoltActionEvents, forKey: .thunderBoltActionEvents) }
        if contacts.count > 0 { try container.encode(contacts, forKey: .contacts) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class ThunderBoltActionData : Codable
{
    public var id:Int
    public var actionName:String
    public var color:String
    public var dailyActionCount:Int
    public var showNumberInput:Bool
    public var showEmailInput:Bool
    public var showPlatformInput:Bool
    public var showDateTimeInput:Bool
    public var contactInteractionPlatforms:[EnumOption] = []

    required public init(){}
}

public class EnumOption : Codable
{
    public var value:Int
    public var label:String

    required public init(){}
}

public class ThunderBoltActionEventData : Codable
{
    public var id:Int
    public var createdDate:String
    public var actionId:Int
    public var actionName:String
    public var color:String
    public var notes:String

    required public init(){}
}

public class ContactData : Codable
{
    public var contactId:Int
    public var contactName:String
    public var email:String
    public var phoneNumber:String

    required public init(){}
}


Swift GetThunderBoltActions DTOs

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.

GET /thunderbolt/actions 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,
	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: {}
}