Cochrane+ App API

<back to all web services

GetDashboardInfo

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class MeetingData
{
    public meetingId: number;
    public startTime: string;
    public arrivalTime: string;
    public leftTime: string;
    public duration: string;
    public showTimeFields: boolean;
    public arrivalStatus: string;
    public email: string;
    public hasEmail: boolean;
    public contactName: string;
    public latitude: number;
    public longitude: number;
    public location: string;
    public address: string;
    public subject: string;
    public description: string;
    public endTime: string;
    public company: string;
    public contactNumber: string;
    public hasContactNumber: boolean;
    public hasLocation: boolean;
    public setBy: string;
    public virtualOrInPerson: string;

    public constructor(init?: Partial<MeetingData>) { (Object as any).assign(this, init); }
}

export enum AttendanceEventType
{
    ClockOut = 0,
    ClockIn = 1,
    StartLunch = 2,
    EndLunch = 3,
    StartBreak = 4,
    EndBreak = 5,
}

export class GetDashboardInfoResponse extends ApiServiceResponse
{
    public unreadNotificationCount: number;
    public nextMeetingDate: string;
    public totalMeetingsToday: number;
    public outstandingRatingsCount: number;
    public usersAverageRating: number;
    public hasSharedRatings: boolean;
    public isSalesPerson: boolean;
    public usersRatingTotalVotes: number;
    public usersRatingPosition: number;
    public teamIds: number[];
    public nextMeeting: MeetingData;
    public attendanceEventType: AttendanceEventType;
    public outstandingDebriefsToReviewCount: number;
    public outstandingTemplateApprovalsCount: number;

    public constructor(init?: Partial<GetDashboardInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetDashboardInfo extends ApiServiceRequest
{

    public constructor(init?: Partial<GetDashboardInfo>) { super(init); (Object as any).assign(this, init); }
}

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