Cochrane+ App API

<back to all web services

GetTeamLocation

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

public class GetTeamLocation : ApiServiceRequest
{
    public var teamId:Int

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

    private enum CodingKeys : String, CodingKey {
        case teamId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        teamId = try container.decodeIfPresent(Int.self, forKey: .teamId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if teamId != nil { try container.encode(teamId, forKey: .teamId) }
    }
}

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 GetTeamLocationResponse : ApiServiceResponse
{
    public var teams:[TeamLocationData] = []

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

    private enum CodingKeys : String, CodingKey {
        case teams
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        teams = try container.decodeIfPresent([TeamLocationData].self, forKey: .teams) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if teams.count > 0 { try container.encode(teams, forKey: .teams) }
    }
}

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 TeamLocationData : Codable
{
    public var lastOnline:String
    public var longitude:Double
    public var latitude:Double
    public var profileImageUrl:String
    public var fullname:String
    public var username:String
    public var batteryLevel:Int
    public var isManager:Bool

    required public init(){}
}


Swift GetTeamLocation 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 /team/locations HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	teams: 
	[
		{
			
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}