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 .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>