Cochrane+ App API

<back to all web services

GetDashboardInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/info
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetDashboardInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UnreadNotificationCountformintNo
NextMeetingDateformstringNo
TotalMeetingsTodayformintNo
OutstandingRatingsCountformintNo
UsersAverageRatingformdoubleNo
HasSharedRatingsformboolNo
IsSalesPersonformboolNo
UsersRatingTotalVotesformintNo
UsersRatingPositionformintNo
TeamIdsformList<int>No
NextMeetingformMeetingDataNo
AttendanceEventTypeformAttendanceEventTypeNo
OutstandingDebriefsToReviewCountformintNo
OutstandingTemplateApprovalsCountformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
MeetingData Parameters:
NameParameterData TypeRequiredDescription
MeetingIdformintNo
StartTimeformstringNo
ArrivalTimeformstringNo
LeftTimeformstringNo
DurationformstringNo
ShowTimeFieldsformboolNo
ArrivalStatusformstringNo
EmailformstringNo
HasEmailformboolNo
ContactNameformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
LocationformstringNo
AddressformstringNo
SubjectformstringNo
DescriptionformstringNo
EndTimeformstringNo
CompanyformstringNo
ContactNumberformstringNo
HasContactNumberformboolNo
HasLocationformboolNo
SetByformstringNo
VirtualOrInPersonformstringNo
AttendanceEventType Enum:
NameValue
ClockOut0
ClockIn1
StartLunch2
EndLunch3
StartBreak4
EndBreak5

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.

GET /dashboard/info HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	unreadNotificationCount: 0,
	nextMeetingDate: String,
	totalMeetingsToday: 0,
	outstandingRatingsCount: 0,
	usersAverageRating: 0,
	hasSharedRatings: False,
	isSalesPerson: False,
	usersRatingTotalVotes: 0,
	usersRatingPosition: 0,
	teamIds: 
	[
		0
	],
	nextMeeting: 
	{
		meetingId: 0,
		startTime: String,
		arrivalTime: String,
		leftTime: String,
		duration: String,
		showTimeFields: False,
		arrivalStatus: String,
		email: String,
		hasEmail: True,
		contactName: String,
		latitude: 0,
		longitude: 0,
		location: String,
		address: String,
		subject: String,
		description: String,
		endTime: String,
		company: String,
		contactNumber: String,
		hasContactNumber: True,
		hasLocation: False,
		setBy: String,
		virtualOrInPerson: String
	},
	attendanceEventType: 0,
	outstandingDebriefsToReviewCount: 0,
	outstandingTemplateApprovalsCount: 0,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}