Cochrane+ App API

<back to all web services

GetTeams

Requires Authentication
The following routes are available for this service:
GET/teams
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetTeams : ApiServiceRequest()
{
}

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

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

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

open class GetTeamsResponse : ApiServiceResponse()
{
    var teams:ArrayList<TeamData> = ArrayList<TeamData>()
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class TeamData
{
    var teamId:Int? = null
    var name:String? = null
    var userIsManager:Boolean? = null
}

Kotlin GetTeams DTOs

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 /teams HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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