Cochrane+ App API

<back to all web services

GetDashboardInfo

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base
Imports BusinessLogic.Entities

Namespace Global

    Namespace BusinessLogic.Entities

        Public Enum AttendanceEventType
            ClockOut = 0
            ClockIn = 1
            StartLunch = 2
            EndLunch = 3
            StartBreak = 4
            EndBreak = 5
        End Enum
    End Namespace

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class GetDashboardInfo
            Inherits ApiServiceRequest
        End Class

        Public Partial Class GetDashboardInfoResponse
            Inherits ApiServiceResponse
            Public Sub New()
                TeamIds = New List(Of Integer)
            End Sub

            Public Overridable Property UnreadNotificationCount As Integer
            Public Overridable Property NextMeetingDate As String
            Public Overridable Property TotalMeetingsToday As Integer
            Public Overridable Property OutstandingRatingsCount As Integer
            Public Overridable Property UsersAverageRating As Double
            Public Overridable Property HasSharedRatings As Boolean
            Public Overridable Property IsSalesPerson As Boolean
            Public Overridable Property UsersRatingTotalVotes As Integer
            Public Overridable Property UsersRatingPosition As Integer
            Public Overridable Property TeamIds As List(Of Integer)
            Public Overridable Property NextMeeting As MeetingData
            Public Overridable Property AttendanceEventType As AttendanceEventType
            Public Overridable Property OutstandingDebriefsToReviewCount As Integer
            Public Overridable Property OutstandingTemplateApprovalsCount As Integer
        End Class

        Public Partial Class MeetingData
            Public Overridable Property MeetingId As Integer
            Public Overridable Property StartTime As String
            Public Overridable Property ArrivalTime As String
            Public Overridable Property LeftTime As String
            Public Overridable Property Duration As String
            Public Overridable Property ShowTimeFields As Boolean
            Public Overridable Property ArrivalStatus As String
            Public Overridable Property Email As String
            Public Overridable Property HasEmail As Boolean
            Public Overridable Property ContactName As String
            Public Overridable Property Latitude As Double
            Public Overridable Property Longitude As Double
            Public Overridable Property Location As String
            Public Overridable Property Address As String
            Public Overridable Property Subject As String
            Public Overridable Property Description As String
            Public Overridable Property EndTime As String
            Public Overridable Property Company As String
            Public Overridable Property ContactNumber As String
            Public Overridable Property HasContactNumber As Boolean
            Public Overridable Property HasLocation As Boolean
            Public Overridable Property SetBy As String
            Public Overridable Property VirtualOrInPerson As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

VB.NET GetDashboardInfo DTOs

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>