Cochrane+ App API

<back to all web services

GetDashboardInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/info
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 MeetingData() = 
        member val MeetingId:Int32 = new Int32() with get,set
        member val StartTime:String = null with get,set
        member val ArrivalTime:String = null with get,set
        member val LeftTime:String = null with get,set
        member val Duration:String = null with get,set
        member val ShowTimeFields:Boolean = new Boolean() with get,set
        member val ArrivalStatus:String = null with get,set
        member val Email:String = null with get,set
        member val HasEmail:Boolean = new Boolean() with get,set
        member val ContactName:String = null with get,set
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set
        member val Location:String = null with get,set
        member val Address:String = null with get,set
        member val Subject:String = null with get,set
        member val Description:String = null with get,set
        member val EndTime:String = null with get,set
        member val Company:String = null with get,set
        member val ContactNumber:String = null with get,set
        member val HasContactNumber:Boolean = new Boolean() with get,set
        member val HasLocation:Boolean = new Boolean() with get,set
        member val SetBy:String = null with get,set
        member val VirtualOrInPerson:String = null with get,set

    type AttendanceEventType =
        | ClockOut = 0
        | ClockIn = 1
        | StartLunch = 2
        | EndLunch = 3
        | StartBreak = 4
        | EndBreak = 5

    [<AllowNullLiteral>]
    type GetDashboardInfoResponse() = 
        inherit ApiServiceResponse()
        member val UnreadNotificationCount:Int32 = new Int32() with get,set
        member val NextMeetingDate:String = null with get,set
        member val TotalMeetingsToday:Int32 = new Int32() with get,set
        member val OutstandingRatingsCount:Int32 = new Int32() with get,set
        member val UsersAverageRating:Double = new Double() with get,set
        member val HasSharedRatings:Boolean = new Boolean() with get,set
        member val IsSalesPerson:Boolean = new Boolean() with get,set
        member val UsersRatingTotalVotes:Int32 = new Int32() with get,set
        member val UsersRatingPosition:Int32 = new Int32() with get,set
        member val TeamIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val NextMeeting:MeetingData = null with get,set
        member val AttendanceEventType:AttendanceEventType = new AttendanceEventType() with get,set
        member val OutstandingDebriefsToReviewCount:Int32 = new Int32() with get,set
        member val OutstandingTemplateApprovalsCount: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 GetDashboardInfo() = 
        inherit ApiServiceRequest()

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

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: {}
}