Cochrane+ App API

<back to all web services

GetDashboardInfo

"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
export class MeetingData {
    /** @param {{meetingId?:number,startTime?:string,arrivalTime?:string,leftTime?:string,duration?:string,showTimeFields?:boolean,arrivalStatus?:string,email?:string,hasEmail?:boolean,contactName?:string,latitude?:number,longitude?:number,location?:string,address?:string,subject?:string,description?:string,endTime?:string,company?:string,contactNumber?:string,hasContactNumber?:boolean,hasLocation?:boolean,setBy?:string,virtualOrInPerson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    meetingId;
    /** @type {string} */
    startTime;
    /** @type {string} */
    arrivalTime;
    /** @type {string} */
    leftTime;
    /** @type {string} */
    duration;
    /** @type {boolean} */
    showTimeFields;
    /** @type {string} */
    arrivalStatus;
    /** @type {string} */
    email;
    /** @type {boolean} */
    hasEmail;
    /** @type {string} */
    contactName;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {string} */
    location;
    /** @type {string} */
    address;
    /** @type {string} */
    subject;
    /** @type {string} */
    description;
    /** @type {string} */
    endTime;
    /** @type {string} */
    company;
    /** @type {string} */
    contactNumber;
    /** @type {boolean} */
    hasContactNumber;
    /** @type {boolean} */
    hasLocation;
    /** @type {string} */
    setBy;
    /** @type {string} */
    virtualOrInPerson;
}
/** @typedef {number} */
export var AttendanceEventType;
(function (AttendanceEventType) {
    AttendanceEventType[AttendanceEventType["ClockOut"] = 0] = "ClockOut"
    AttendanceEventType[AttendanceEventType["ClockIn"] = 1] = "ClockIn"
    AttendanceEventType[AttendanceEventType["StartLunch"] = 2] = "StartLunch"
    AttendanceEventType[AttendanceEventType["EndLunch"] = 3] = "EndLunch"
    AttendanceEventType[AttendanceEventType["StartBreak"] = 4] = "StartBreak"
    AttendanceEventType[AttendanceEventType["EndBreak"] = 5] = "EndBreak"
})(AttendanceEventType || (AttendanceEventType = {}));
export class GetDashboardInfoResponse extends ApiServiceResponse {
    /** @param {{unreadNotificationCount?:number,nextMeetingDate?:string,totalMeetingsToday?:number,outstandingRatingsCount?:number,usersAverageRating?:number,hasSharedRatings?:boolean,isSalesPerson?:boolean,usersRatingTotalVotes?:number,usersRatingPosition?:number,teamIds?:number[],nextMeeting?:MeetingData,attendanceEventType?:AttendanceEventType,outstandingDebriefsToReviewCount?:number,outstandingTemplateApprovalsCount?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    unreadNotificationCount;
    /** @type {string} */
    nextMeetingDate;
    /** @type {number} */
    totalMeetingsToday;
    /** @type {number} */
    outstandingRatingsCount;
    /** @type {number} */
    usersAverageRating;
    /** @type {boolean} */
    hasSharedRatings;
    /** @type {boolean} */
    isSalesPerson;
    /** @type {number} */
    usersRatingTotalVotes;
    /** @type {number} */
    usersRatingPosition;
    /** @type {number[]} */
    teamIds;
    /** @type {MeetingData} */
    nextMeeting;
    /** @type {AttendanceEventType} */
    attendanceEventType;
    /** @type {number} */
    outstandingDebriefsToReviewCount;
    /** @type {number} */
    outstandingTemplateApprovalsCount;
}
export class GetDashboardInfo extends ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

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