Cochrane+ App API

<back to all web services

GetDashboardInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/info
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;
using BusinessLogic.Entities;

namespace BusinessLogic.Entities
{
    public enum AttendanceEventType
    {
        ClockOut = 0,
        ClockIn = 1,
        StartLunch = 2,
        EndLunch = 3,
        StartBreak = 4,
        EndBreak = 5,
    }

}

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class GetDashboardInfo
        : ApiServiceRequest
    {
    }

    public partial class GetDashboardInfoResponse
        : ApiServiceResponse
    {
        public GetDashboardInfoResponse()
        {
            TeamIds = new List<int>{};
        }

        public virtual int UnreadNotificationCount { get; set; }
        public virtual string NextMeetingDate { get; set; }
        public virtual int TotalMeetingsToday { get; set; }
        public virtual int OutstandingRatingsCount { get; set; }
        public virtual double UsersAverageRating { get; set; }
        public virtual bool HasSharedRatings { get; set; }
        public virtual bool IsSalesPerson { get; set; }
        public virtual int UsersRatingTotalVotes { get; set; }
        public virtual int UsersRatingPosition { get; set; }
        public virtual List<int> TeamIds { get; set; }
        public virtual MeetingData NextMeeting { get; set; }
        public virtual AttendanceEventType AttendanceEventType { get; set; }
        public virtual int OutstandingDebriefsToReviewCount { get; set; }
        public virtual int OutstandingTemplateApprovalsCount { get; set; }
    }

    public partial class MeetingData
    {
        public virtual int MeetingId { get; set; }
        public virtual string StartTime { get; set; }
        public virtual string ArrivalTime { get; set; }
        public virtual string LeftTime { get; set; }
        public virtual string Duration { get; set; }
        public virtual bool ShowTimeFields { get; set; }
        public virtual string ArrivalStatus { get; set; }
        public virtual string Email { get; set; }
        public virtual bool HasEmail { get; set; }
        public virtual string ContactName { get; set; }
        public virtual double Latitude { get; set; }
        public virtual double Longitude { get; set; }
        public virtual string Location { get; set; }
        public virtual string Address { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Description { get; set; }
        public virtual string EndTime { get; set; }
        public virtual string Company { get; set; }
        public virtual string ContactNumber { get; set; }
        public virtual bool HasContactNumber { get; set; }
        public virtual bool HasLocation { get; set; }
        public virtual string SetBy { get; set; }
        public virtual string VirtualOrInPerson { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

}

C# 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>