Cochrane+ App API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type SystemUserPermission() = 
        member val Meeting:Boolean = new Boolean() with get,set
        member val Journey:Boolean = new Boolean() with get,set
        member val Attendance:Boolean = new Boolean() with get,set
        member val NotificationCenter:Boolean = new Boolean() with get,set
        member val InternalRating:Boolean = new Boolean() with get,set
        member val Debrief:Boolean = new Boolean() with get,set
        member val ThunderBoltActions:Boolean = new Boolean() with get,set
        member val OnTheMove:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type AppSettings() = 
        member val AllowAbstainRatings:Boolean = new Boolean() with get,set
        member val ShowMoodIndicatorOnApp:Boolean = new Boolean() with get,set
        member val TakePhotoForAnalysis:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UserLoginResponse() = 
        inherit ApiServiceResponse()
        member val AllowAttendanceOnLaptop:Boolean = new Boolean() with get,set
        member val ProfileImageUrl:String = null with get,set
        member val FriendlyName:String = null with get,set
        member val SystemUserId:Int32 = new Int32() with get,set
        member val Username:String = null with get,set
        member val Permissions:SystemUserPermission = null with get,set
        member val Settings:AppSettings = null with get,set
        member val StartLatitude:Double = new Double() with get,set
        member val StartLongitude:Double = new Double() with get,set
        member val HasStartLocation:Boolean = new Boolean() with get,set
        member val EndLatitude:Double = new Double() with get,set
        member val EndLongitude:Double = new Double() with get,set
        member val HasEndLocation:Boolean = new Boolean() with get,set
        member val IsSalesPerson:Boolean = new Boolean() with get,set
        member val FeelingStatusMappings:String[] = [||] with get,set
        member val HasAiPermissions:Boolean = new Boolean() with get,set
        member val RefreshToken:String = null with get,set
        member val IsManagerOrPromotedTo:Boolean = new Boolean() with get,set
        member val IsTemplateApprover:Boolean = new Boolean() with get,set
        member val OutstandingApprovals:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type UserLogin() = 
        inherit ApiServiceRequest()
        member val Username:String = null with get,set
        member val Password:String = null with get,set
        member val UtcOffset:Int32 = new Int32() with get,set

F# 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":{}}