| GET | /dashboard/info |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
# @ApiMember(DataType="double", Description="Latitude of the user making this request")
latitude: float = 0.0
"""
Latitude of the user making this request
"""
# @ApiMember(DataType="double", Description="Longitude of the user making this request")
longitude: float = 0.0
"""
Longitude of the user making this request
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MeetingData:
meeting_id: int = 0
start_time: Optional[str] = None
arrival_time: Optional[str] = None
left_time: Optional[str] = None
duration: Optional[str] = None
show_time_fields: bool = False
arrival_status: Optional[str] = None
email: Optional[str] = None
has_email: bool = False
contact_name: Optional[str] = None
latitude: float = 0.0
longitude: float = 0.0
location: Optional[str] = None
address: Optional[str] = None
subject: Optional[str] = None
description: Optional[str] = None
end_time: Optional[str] = None
company: Optional[str] = None
contact_number: Optional[str] = None
has_contact_number: bool = False
has_location: bool = False
set_by: Optional[str] = None
virtual_or_in_person: Optional[str] = None
class AttendanceEventType(IntEnum):
CLOCK_OUT = 0
CLOCK_IN = 1
START_LUNCH = 2
END_LUNCH = 3
START_BREAK = 4
END_BREAK = 5
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDashboardInfoResponse(ApiServiceResponse):
unread_notification_count: int = 0
next_meeting_date: Optional[str] = None
total_meetings_today: int = 0
outstanding_ratings_count: int = 0
users_average_rating: float = 0.0
has_shared_ratings: bool = False
is_sales_person: bool = False
users_rating_total_votes: int = 0
users_rating_position: int = 0
team_ids: Optional[List[int]] = None
next_meeting: Optional[MeetingData] = None
attendance_event_type: Optional[AttendanceEventType] = None
outstanding_debriefs_to_review_count: int = 0
outstanding_template_approvals_count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDashboardInfo(ApiServiceRequest):
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"unreadNotificationCount":0,"nextMeetingDate":"String","totalMeetingsToday":0,"outstandingRatingsCount":0,"usersAverageRating":0,"hasSharedRatings":false,"isSalesPerson":false,"usersRatingTotalVotes":0,"usersRatingPosition":0,"teamIds":[0],"nextMeeting":{"meetingId":0,"startTime":"String","arrivalTime":"String","leftTime":"String","duration":"String","showTimeFields":false,"arrivalStatus":"String","email":"String","hasEmail":true,"contactName":"String","latitude":0,"longitude":0,"location":"String","address":"String","subject":"String","description":"String","endTime":"String","company":"String","contactNumber":"String","hasContactNumber":true,"hasLocation":false,"setBy":"String","virtualOrInPerson":"String"},"attendanceEventType":0,"outstandingDebriefsToReviewCount":0,"outstandingTemplateApprovalsCount":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}