Cochrane+ App API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UserLogin : ApiServiceRequest()
{
    var username:String? = null
    var password:String? = null
    var utcOffset:Int? = null
}

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 UserLoginResponse : ApiServiceResponse()
{
    var allowAttendanceOnLaptop:Boolean? = null
    var profileImageUrl:String? = null
    var friendlyName:String? = null
    var systemUserId:Int? = null
    var username:String? = null
    var permissions:SystemUserPermission? = null
    var settings:AppSettings? = null
    var startLatitude:Double? = null
    var startLongitude:Double? = null
    var hasStartLocation:Boolean? = null
    var endLatitude:Double? = null
    var endLongitude:Double? = null
    var hasEndLocation:Boolean? = null
    var isSalesPerson:Boolean? = null
    var feelingStatusMappings:ArrayList<String>? = null
    var hasAiPermissions:Boolean? = null
    var refreshToken:String? = null
    var isManagerOrPromotedTo:Boolean? = null
    var isTemplateApprover:Boolean? = null
    var outstandingApprovals:Int? = null
}

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

open class SystemUserPermission
{
    var meeting:Boolean? = null
    var journey:Boolean? = null
    var attendance:Boolean? = null
    var notificationCenter:Boolean? = null
    var internalRating:Boolean? = null
    var debrief:Boolean? = null
    var thunderBoltActions:Boolean? = null
    var onTheMove:Boolean? = null
}

open class AppSettings
{
    var allowAbstainRatings:Boolean? = null
    var showMoodIndicatorOnApp:Boolean? = null
    var takePhotoForAnalysis:Boolean? = null
}

Kotlin UserLogin 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.

POST /user/login HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"username":"String","password":"String","utcOffset":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"allowAttendanceOnLaptop":false,"profileImageUrl":"String","friendlyName":"String","systemUserId":0,"username":"String","permissions":{"meeting":false,"journey":false,"attendance":false,"notificationCenter":false,"internalRating":false,"debrief":false,"thunderBoltActions":false,"onTheMove":false},"settings":{"allowAbstainRatings":false,"showMoodIndicatorOnApp":false,"takePhotoForAnalysis":false},"startLatitude":0,"startLongitude":0,"hasStartLocation":false,"endLatitude":0,"endLongitude":0,"hasEndLocation":false,"isSalesPerson":false,"feelingStatusMappings":["String"],"hasAiPermissions":false,"refreshToken":"String","isManagerOrPromotedTo":false,"isTemplateApprover":false,"outstandingApprovals":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}