Cochrane+ App API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
UserLogin Parameters:
NameParameterData TypeRequiredDescription
UsernamebodystringNo
PasswordbodystringNo
UtcOffsetbodyintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
UserLoginResponse Parameters:
NameParameterData TypeRequiredDescription
AllowAttendanceOnLaptopformboolNo
ProfileImageUrlformstringNo
FriendlyNameformstringNo
SystemUserIdformintNo
UsernameformstringNo
PermissionsformSystemUserPermissionNo
SettingsformAppSettingsNo
StartLatitudeformdoubleNo
StartLongitudeformdoubleNo
HasStartLocationformboolNo
EndLatitudeformdoubleNo
EndLongitudeformdoubleNo
HasEndLocationformboolNo
IsSalesPersonformboolNo
FeelingStatusMappingsformstring[]No
HasAiPermissionsformboolNo
RefreshTokenformstringNo
IsManagerOrPromotedToformboolNo
IsTemplateApproverformboolNo
OutstandingApprovalsformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
SystemUserPermission Parameters:
NameParameterData TypeRequiredDescription
MeetingformboolNo
JourneyformboolNo
AttendanceformboolNo
NotificationCenterformboolNo
InternalRatingformboolNo
DebriefformboolNo
ThunderBoltActionsformboolNo
OnTheMoveformboolNo
AppSettings Parameters:
NameParameterData TypeRequiredDescription
AllowAbstainRatingsformboolNo
ShowMoodIndicatorOnAppformboolNo
TakePhotoForAnalysisformboolNo

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

{
	username: String,
	password: String,
	utcOffset: 0,
	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: {}
}