| GET | /dashboard/info |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GetDashboardInfo extends ApiServiceRequest
{
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String apiKey = null;
/**
* Latitude of the user making this request
*/
@ApiMember(DataType="double", Description="Latitude of the user making this request")
public Double latitude = null;
/**
* Longitude of the user making this request
*/
@ApiMember(DataType="double", Description="Longitude of the user making this request")
public Double longitude = null;
public String getApiKey() { return apiKey; }
public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
public Double getLatitude() { return latitude; }
public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
public Double getLongitude() { return longitude; }
public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
}
public static class GetDashboardInfoResponse extends ApiServiceResponse
{
public Integer unreadNotificationCount = null;
public String nextMeetingDate = null;
public Integer totalMeetingsToday = null;
public Integer outstandingRatingsCount = null;
public Double usersAverageRating = null;
public Boolean hasSharedRatings = null;
public Boolean isSalesPerson = null;
public Integer usersRatingTotalVotes = null;
public Integer usersRatingPosition = null;
public ArrayList<Integer> teamIds = null;
public MeetingData nextMeeting = null;
public AttendanceEventType attendanceEventType = null;
public Integer outstandingDebriefsToReviewCount = null;
public Integer outstandingTemplateApprovalsCount = null;
public Integer getUnreadNotificationCount() { return unreadNotificationCount; }
public GetDashboardInfoResponse setUnreadNotificationCount(Integer value) { this.unreadNotificationCount = value; return this; }
public String getNextMeetingDate() { return nextMeetingDate; }
public GetDashboardInfoResponse setNextMeetingDate(String value) { this.nextMeetingDate = value; return this; }
public Integer getTotalMeetingsToday() { return totalMeetingsToday; }
public GetDashboardInfoResponse setTotalMeetingsToday(Integer value) { this.totalMeetingsToday = value; return this; }
public Integer getOutstandingRatingsCount() { return outstandingRatingsCount; }
public GetDashboardInfoResponse setOutstandingRatingsCount(Integer value) { this.outstandingRatingsCount = value; return this; }
public Double getUsersAverageRating() { return usersAverageRating; }
public GetDashboardInfoResponse setUsersAverageRating(Double value) { this.usersAverageRating = value; return this; }
public Boolean isHasSharedRatings() { return hasSharedRatings; }
public GetDashboardInfoResponse setHasSharedRatings(Boolean value) { this.hasSharedRatings = value; return this; }
public Boolean getIsSalesPerson() { return isSalesPerson; }
public GetDashboardInfoResponse setIsSalesPerson(Boolean value) { this.isSalesPerson = value; return this; }
public Integer getUsersRatingTotalVotes() { return usersRatingTotalVotes; }
public GetDashboardInfoResponse setUsersRatingTotalVotes(Integer value) { this.usersRatingTotalVotes = value; return this; }
public Integer getUsersRatingPosition() { return usersRatingPosition; }
public GetDashboardInfoResponse setUsersRatingPosition(Integer value) { this.usersRatingPosition = value; return this; }
public ArrayList<Integer> getTeamIds() { return teamIds; }
public GetDashboardInfoResponse setTeamIds(ArrayList<Integer> value) { this.teamIds = value; return this; }
public MeetingData getNextMeeting() { return nextMeeting; }
public GetDashboardInfoResponse setNextMeeting(MeetingData value) { this.nextMeeting = value; return this; }
public AttendanceEventType getAttendanceEventType() { return attendanceEventType; }
public GetDashboardInfoResponse setAttendanceEventType(AttendanceEventType value) { this.attendanceEventType = value; return this; }
public Integer getOutstandingDebriefsToReviewCount() { return outstandingDebriefsToReviewCount; }
public GetDashboardInfoResponse setOutstandingDebriefsToReviewCount(Integer value) { this.outstandingDebriefsToReviewCount = value; return this; }
public Integer getOutstandingTemplateApprovalsCount() { return outstandingTemplateApprovalsCount; }
public GetDashboardInfoResponse setOutstandingTemplateApprovalsCount(Integer value) { this.outstandingTemplateApprovalsCount = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String description = null;
public String heading = null;
public Boolean wasSuccessful = null;
public Object modelState = null;
public String getDescription() { return description; }
public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
public String getHeading() { return heading; }
public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
public Boolean isWasSuccessful() { return wasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
public Object getModelState() { return modelState; }
public ApiServiceResponse setModelState(Object value) { this.modelState = value; return this; }
}
public static class MeetingData
{
public Integer meetingId = null;
public String startTime = null;
public String arrivalTime = null;
public String leftTime = null;
public String duration = null;
public Boolean showTimeFields = null;
public String arrivalStatus = null;
public String email = null;
public Boolean hasEmail = null;
public String contactName = null;
public Double latitude = null;
public Double longitude = null;
public String location = null;
public String address = null;
public String subject = null;
public String description = null;
public String endTime = null;
public String company = null;
public String contactNumber = null;
public Boolean hasContactNumber = null;
public Boolean hasLocation = null;
public String setBy = null;
public String virtualOrInPerson = null;
public Integer getMeetingId() { return meetingId; }
public MeetingData setMeetingId(Integer value) { this.meetingId = value; return this; }
public String getStartTime() { return startTime; }
public MeetingData setStartTime(String value) { this.startTime = value; return this; }
public String getArrivalTime() { return arrivalTime; }
public MeetingData setArrivalTime(String value) { this.arrivalTime = value; return this; }
public String getLeftTime() { return leftTime; }
public MeetingData setLeftTime(String value) { this.leftTime = value; return this; }
public String getDuration() { return duration; }
public MeetingData setDuration(String value) { this.duration = value; return this; }
public Boolean isShowTimeFields() { return showTimeFields; }
public MeetingData setShowTimeFields(Boolean value) { this.showTimeFields = value; return this; }
public String getArrivalStatus() { return arrivalStatus; }
public MeetingData setArrivalStatus(String value) { this.arrivalStatus = value; return this; }
public String getEmail() { return email; }
public MeetingData setEmail(String value) { this.email = value; return this; }
public Boolean isHasEmail() { return hasEmail; }
public MeetingData setHasEmail(Boolean value) { this.hasEmail = value; return this; }
public String getContactName() { return contactName; }
public MeetingData setContactName(String value) { this.contactName = value; return this; }
public Double getLatitude() { return latitude; }
public MeetingData setLatitude(Double value) { this.latitude = value; return this; }
public Double getLongitude() { return longitude; }
public MeetingData setLongitude(Double value) { this.longitude = value; return this; }
public String getLocation() { return location; }
public MeetingData setLocation(String value) { this.location = value; return this; }
public String getAddress() { return address; }
public MeetingData setAddress(String value) { this.address = value; return this; }
public String getSubject() { return subject; }
public MeetingData setSubject(String value) { this.subject = value; return this; }
public String getDescription() { return description; }
public MeetingData setDescription(String value) { this.description = value; return this; }
public String getEndTime() { return endTime; }
public MeetingData setEndTime(String value) { this.endTime = value; return this; }
public String getCompany() { return company; }
public MeetingData setCompany(String value) { this.company = value; return this; }
public String getContactNumber() { return contactNumber; }
public MeetingData setContactNumber(String value) { this.contactNumber = value; return this; }
public Boolean isHasContactNumber() { return hasContactNumber; }
public MeetingData setHasContactNumber(Boolean value) { this.hasContactNumber = value; return this; }
public Boolean isHasLocation() { return hasLocation; }
public MeetingData setHasLocation(Boolean value) { this.hasLocation = value; return this; }
public String getSetBy() { return setBy; }
public MeetingData setSetBy(String value) { this.setBy = value; return this; }
public String getVirtualOrInPerson() { return virtualOrInPerson; }
public MeetingData setVirtualOrInPerson(String value) { this.virtualOrInPerson = value; return this; }
}
public static enum AttendanceEventType
{
@SerializedName("0") ClockOut(0),
@SerializedName("1") ClockIn(1),
@SerializedName("2") StartLunch(2),
@SerializedName("3") EndLunch(3),
@SerializedName("4") StartBreak(4),
@SerializedName("5") EndBreak(5);
private final int value;
AttendanceEventType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>