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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDashboardInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <AttendanceEventType>ClockOut</AttendanceEventType>
  <HasSharedRatings>false</HasSharedRatings>
  <IsSalesPerson>false</IsSalesPerson>
  <NextMeeting>
    <Address>String</Address>
    <ArrivalStatus>String</ArrivalStatus>
    <ArrivalTime>String</ArrivalTime>
    <Company>String</Company>
    <ContactName>String</ContactName>
    <ContactNumber>String</ContactNumber>
    <Description>String</Description>
    <Duration>String</Duration>
    <Email>String</Email>
    <EndTime>String</EndTime>
    <Latitude>0</Latitude>
    <LeftTime>String</LeftTime>
    <Location>String</Location>
    <Longitude>0</Longitude>
    <MeetingId>0</MeetingId>
    <SetBy>String</SetBy>
    <ShowTimeFields>false</ShowTimeFields>
    <StartTime>String</StartTime>
    <Subject>String</Subject>
    <VirtualOrInPerson>String</VirtualOrInPerson>
  </NextMeeting>
  <NextMeetingDate>String</NextMeetingDate>
  <OutstandingDebriefsToReviewCount>0</OutstandingDebriefsToReviewCount>
  <OutstandingRatingsCount>0</OutstandingRatingsCount>
  <OutstandingTemplateApprovalsCount>0</OutstandingTemplateApprovalsCount>
  <TeamIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TeamIds>
  <TotalMeetingsToday>0</TotalMeetingsToday>
  <UnreadNotificationCount>0</UnreadNotificationCount>
  <UsersAverageRating>0</UsersAverageRating>
  <UsersRatingPosition>0</UsersRatingPosition>
  <UsersRatingTotalVotes>0</UsersRatingTotalVotes>
</GetDashboardInfoResponse>