Cochrane+ App API

<back to all web services

AutoLogin

The following routes are available for this service:
POST/user/autologin
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 AutoLogin() = 
        inherit ApiServiceRequest()
        member val UtcOffset:Int32 = new Int32() with get,set
        member val SystemUserId:Int32 = new Int32() with get,set
        member val RefreshToken:String = null with get,set

F# AutoLogin 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.

POST /user/autologin HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	utcOffset: 0,
	systemUserId: 0,
	refreshToken: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}