| All Verbs | /BookingEventsSummary |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@DataContract(Namespace="schemas.agentivity.com/types")
public static class BookingEventsSummaryRequest extends CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
@DataMember
public String EventDateStart = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String EventDateEnd = null;
/**
* Comma Delimited List of PCCs
*/
@DataMember
public ArrayList<String> OwningAgencyLocationID = null;
public String getEventDateStart() { return EventDateStart; }
public BookingEventsSummaryRequest setEventDateStart(String value) { this.EventDateStart = value; return this; }
public String getEventDateEnd() { return EventDateEnd; }
public BookingEventsSummaryRequest setEventDateEnd(String value) { this.EventDateEnd = value; return this; }
public ArrayList<String> getOwningAgencyLocationID() { return OwningAgencyLocationID; }
public BookingEventsSummaryRequest setOwningAgencyLocationID(ArrayList<String> value) { this.OwningAgencyLocationID = value; return this; }
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
public ArrayList<String> OwningCompanyCode = null;
/**
* UserName in form of an email address
*/
@DataMember
public String UserName = null;
public ArrayList<String> getOwningCompanyCode() { return OwningCompanyCode; }
public CompanyLevelRequestBase setOwningCompanyCode(ArrayList<String> value) { this.OwningCompanyCode = value; return this; }
public String getUserName() { return UserName; }
public CompanyLevelRequestBase setUserName(String value) { this.UserName = value; return this; }
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public static class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
public String Offset = null;
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
public String Limit = null;
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
public Integer TotalRecords = null;
/**
* Total Number of Records in this Reponse (on this page)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
public Integer ResponseRecords = null;
public String getOffset() { return Offset; }
public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
public String getLimit() { return Limit; }
public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
public Integer getTotalRecords() { return TotalRecords; }
public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
public Integer getResponseRecords() { return ResponseRecords; }
public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class BookingEventsSummaryRequestItemResponse extends ItemResponse<BookingEventsSummary, BookingEventsSummaryRequestResponseReport>
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class ItemResponse<TItem, TReport>
{
@DataMember(Order=1)
public ResponseMetadata ResponseMetadata = null;
@DataMember(Order=2, EmitDefaultValue=false)
public TReport ResponseReport = null;
@DataMember(Order=3, EmitDefaultValue=false)
public AgentivityError ResponseError = null;
public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
public TReport getResponseReport() { return ResponseReport; }
public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
public AgentivityError getResponseError() { return ResponseError; }
public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class ResponseMetadata
{
@DataMember(Order=0)
public Boolean Success = null;
@DataMember(Order=1)
public Boolean HasCache = null;
@DataMember(Order=2)
public Boolean HasPaging = null;
@DataMember(Order=3, EmitDefaultValue=false)
public CacheMetadata CacheMetadata = null;
@DataMember(Order=4, EmitDefaultValue=false)
public PagingMetadata PagingMetadata = null;
public Boolean isSuccess() { return Success; }
public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
public Boolean isHasCache() { return HasCache; }
public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
public Boolean isHasPaging() { return HasPaging; }
public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
public CacheMetadata getCacheMetadata() { return CacheMetadata; }
public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
public PagingMetadata getPagingMetadata() { return PagingMetadata; }
public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public static class CacheMetadata
{
@DataMember(Order=1)
public Date CachedAt = null;
@DataMember(Order=2)
public Date CacheExpiresAt = null;
@DataMember(Order=0)
public Boolean IsFromCache = null;
public Date getCachedAt() { return CachedAt; }
public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
public Date getCacheExpiresAt() { return CacheExpiresAt; }
public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
public Boolean getIsFromCache() { return IsFromCache; }
public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class AgentivityError
{
@DataMember
public String ErrorCode = null;
@DataMember
public String Message = null;
@DataMember
public String StatusCode = null;
@DataMember
public String VerboseMessage = null;
public String getErrorCode() { return ErrorCode; }
public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public AgentivityError setMessage(String value) { this.Message = value; return this; }
public String getStatusCode() { return StatusCode; }
public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
public String getVerboseMessage() { return VerboseMessage; }
public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
}
@DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")
public static class BookingEventsSummary
{
@DataMember(Order=10)
public Date DateStart = null;
@DataMember(Order=20)
public Date DateEnd = null;
@DataMember(Order=30)
public EventsSummary Events = null;
@DataMember(Order=40)
public ArrayList<OwningAgencyLocationIdEventsSummary> Branches = null;
public Date getDateStart() { return DateStart; }
public BookingEventsSummary setDateStart(Date value) { this.DateStart = value; return this; }
public Date getDateEnd() { return DateEnd; }
public BookingEventsSummary setDateEnd(Date value) { this.DateEnd = value; return this; }
public EventsSummary getEvents() { return Events; }
public BookingEventsSummary setEvents(EventsSummary value) { this.Events = value; return this; }
public ArrayList<OwningAgencyLocationIdEventsSummary> getBranches() { return Branches; }
public BookingEventsSummary setBranches(ArrayList<OwningAgencyLocationIdEventsSummary> value) { this.Branches = value; return this; }
}
@DataContract(Name="Events", Namespace="schemas.agentivity.com/types")
public static class EventsSummary
{
@DataMember(Order=10)
public String Create = null;
@DataMember(Order=20)
public String Cancel = null;
@DataMember(Order=30)
public String Change = null;
@DataMember(Order=50)
public String Ticketing = null;
@DataMember(Order=60)
public String Service = null;
@DataMember(Order=70)
public Integer TicketsIssued = null;
public String getCreate() { return Create; }
public EventsSummary setCreate(String value) { this.Create = value; return this; }
public String getCancel() { return Cancel; }
public EventsSummary setCancel(String value) { this.Cancel = value; return this; }
public String getChange() { return Change; }
public EventsSummary setChange(String value) { this.Change = value; return this; }
public String getTicketing() { return Ticketing; }
public EventsSummary setTicketing(String value) { this.Ticketing = value; return this; }
public String getService() { return Service; }
public EventsSummary setService(String value) { this.Service = value; return this; }
public Integer getTicketsIssued() { return TicketsIssued; }
public EventsSummary setTicketsIssued(Integer value) { this.TicketsIssued = value; return this; }
}
@DataContract(Name="Branch", Namespace="schemas.agentivity.com/types")
public static class OwningAgencyLocationIdEventsSummary
{
@DataMember(Order=10)
public String BranchId = null;
@DataMember(Order=20)
public EventsSummary Events = null;
@DataMember(Order=30)
public ArrayList<AccountEventsSummary> Accounts = null;
public String getBranchId() { return BranchId; }
public OwningAgencyLocationIdEventsSummary setBranchId(String value) { this.BranchId = value; return this; }
public EventsSummary getEvents() { return Events; }
public OwningAgencyLocationIdEventsSummary setEvents(EventsSummary value) { this.Events = value; return this; }
public ArrayList<AccountEventsSummary> getAccounts() { return Accounts; }
public OwningAgencyLocationIdEventsSummary setAccounts(ArrayList<AccountEventsSummary> value) { this.Accounts = value; return this; }
}
@DataContract(Name="Account", Namespace="schemas.agentivity.com/types")
public static class AccountEventsSummary
{
@DataMember(Order=10)
public String AccountId = null;
@DataMember(Order=20)
public EventsSummary Events = null;
@DataMember(Order=30)
public ArrayList<ConsultantEventsSummary> Consultants = null;
public String getAccountId() { return AccountId; }
public AccountEventsSummary setAccountId(String value) { this.AccountId = value; return this; }
public EventsSummary getEvents() { return Events; }
public AccountEventsSummary setEvents(EventsSummary value) { this.Events = value; return this; }
public ArrayList<ConsultantEventsSummary> getConsultants() { return Consultants; }
public AccountEventsSummary setConsultants(ArrayList<ConsultantEventsSummary> value) { this.Consultants = value; return this; }
}
@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
public static class ConsultantEventsSummary
{
@DataMember(Order=10)
public String ConsultantId = null;
@DataMember(Order=20)
public EventsSummary Events = null;
public String getConsultantId() { return ConsultantId; }
public ConsultantEventsSummary setConsultantId(String value) { this.ConsultantId = value; return this; }
public EventsSummary getEvents() { return Events; }
public ConsultantEventsSummary setEvents(EventsSummary value) { this.Events = value; return this; }
}
@DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")
public static class BookingEventsSummaryRequestResponseReport extends Report<BookingEventsSummaryRequestItemResponse, BookingEventsSummary>
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
public TItem Item = null;
public TItem getItem() { return Item; }
public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
}
}
Java BookingEventsSummaryRequest DTOs
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.
POST /BookingEventsSummary HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BookingEventsSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningCompanyCode>
<UserName>String</UserName>
<EventDateEnd>String</EventDateEnd>
<EventDateStart>String</EventDateStart>
<OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningAgencyLocationID>
</BookingEventsSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<DateStart>0001-01-01T00:00:00</DateStart>
<DateEnd>0001-01-01T00:00:00</DateEnd>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Branches>
<Branch>
<BranchId>String</BranchId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Accounts>
<Account>
<AccountId>String</AccountId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Consultants>
<Consultant>
<ConsultantId>String</ConsultantId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
</Consultant>
</Consultants>
</Account>
</Accounts>
</Branch>
</Branches>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>