| All Verbs | /ConsultantDetails |
|---|
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 GetConsultantDetails extends CompanyLevelRequestBase implements IRequestConsultantID
{
/**
* Consultant ID (sign on)
*/
@DataMember
public String ConsultantID = null;
/**
* Booking system (1G, 1A or 1S)
*/
@DataMember
public String BookingSource = null;
/**
* Request Consultant ID (sign on)
*/
@DataMember
public String RequestConsultantID = null;
public String getConsultantID() { return ConsultantID; }
public GetConsultantDetails setConsultantID(String value) { this.ConsultantID = value; return this; }
public String getBookingSource() { return BookingSource; }
public GetConsultantDetails setBookingSource(String value) { this.BookingSource = value; return this; }
public String getRequestConsultantID() { return RequestConsultantID; }
public GetConsultantDetails setRequestConsultantID(String value) { this.RequestConsultantID = 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 GetConsultantDetailsItemResponse extends ItemResponse<ConsultantDetails, GetConsultantDetailsResponseReport>
{
}
@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="ConsultantDetails", Namespace="schemas.agentivity.com/types")
public static class ConsultantDetails
{
@DataMember(Order=10)
public ConsultantMainDetails Consultant = null;
@DataMember(Order=20)
public ConsultantGroups ConsultantGroups = null;
@DataMember(Order=30)
public ArrayList<BookingSource> BookingSources = null;
public ConsultantMainDetails getConsultant() { return Consultant; }
public ConsultantDetails setConsultant(ConsultantMainDetails value) { this.Consultant = value; return this; }
public ConsultantGroups getConsultantGroups() { return ConsultantGroups; }
public ConsultantDetails setConsultantGroups(ConsultantGroups value) { this.ConsultantGroups = value; return this; }
public ArrayList<BookingSource> getBookingSources() { return BookingSources; }
public ConsultantDetails setBookingSources(ArrayList<BookingSource> value) { this.BookingSources = value; return this; }
}
@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
public static class ConsultantMainDetails
{
@DataMember(Order=10)
public String Firstname = null;
@DataMember(Order=20)
public String Lastname = null;
@DataMember(Order=30)
public String StaffNumber = null;
@DataMember(Order=40)
public String Email = null;
@DataMember(Order=50)
public Boolean OnLeave = null;
public String getFirstname() { return Firstname; }
public ConsultantMainDetails setFirstname(String value) { this.Firstname = value; return this; }
public String getLastname() { return Lastname; }
public ConsultantMainDetails setLastname(String value) { this.Lastname = value; return this; }
public String getStaffNumber() { return StaffNumber; }
public ConsultantMainDetails setStaffNumber(String value) { this.StaffNumber = value; return this; }
public String getEmail() { return Email; }
public ConsultantMainDetails setEmail(String value) { this.Email = value; return this; }
public Boolean isOnLeave() { return OnLeave; }
public ConsultantMainDetails setOnLeave(Boolean value) { this.OnLeave = value; return this; }
}
@DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")
public static class ConsultantGroups
{
@DataMember(Order=10)
public ArrayList<ConsultantInGroupDetails> LeaveCover = null;
public ArrayList<ConsultantInGroupDetails> getLeaveCover() { return LeaveCover; }
public ConsultantGroups setLeaveCover(ArrayList<ConsultantInGroupDetails> value) { this.LeaveCover = value; return this; }
}
@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
public static class ConsultantInGroupDetails
{
@DataMember(Order=10)
public String ConsultantID = null;
@DataMember(Order=20)
public String Firstname = null;
@DataMember(Order=30)
public String Lastname = null;
public String getConsultantID() { return ConsultantID; }
public ConsultantInGroupDetails setConsultantID(String value) { this.ConsultantID = value; return this; }
public String getFirstname() { return Firstname; }
public ConsultantInGroupDetails setFirstname(String value) { this.Firstname = value; return this; }
public String getLastname() { return Lastname; }
public ConsultantInGroupDetails setLastname(String value) { this.Lastname = value; return this; }
}
@DataContract(Name="BookingSource", Namespace="schemas.agentivity.com/types")
public static class BookingSource
{
@DataMember(Order=10)
public String ConsultantID = null;
@DataMember(Order=20)
public String BookingSourceCode = null;
public String getConsultantID() { return ConsultantID; }
public BookingSource setConsultantID(String value) { this.ConsultantID = value; return this; }
public String getBookingSourceCode() { return BookingSourceCode; }
public BookingSource setBookingSourceCode(String value) { this.BookingSourceCode = value; return this; }
}
@DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
public static class GetConsultantDetailsResponseReport extends Report<GetConsultantDetailsItemResponse, ConsultantDetails>
{
}
@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 GetConsultantDetails 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 /ConsultantDetails HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetConsultantDetails 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>
<BookingSource>String</BookingSource>
<ConsultantID>String</ConsultantID>
<RequestConsultantID>String</RequestConsultantID>
</GetConsultantDetails>
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>
<Consultant>
<Firstname>String</Firstname>
<Lastname>String</Lastname>
<StaffNumber>String</StaffNumber>
<Email>String</Email>
<OnLeave>false</OnLeave>
</Consultant>
<ConsultantGroups>
<LeaveCover>
<Consultant>
<ConsultantID>String</ConsultantID>
<Firstname>String</Firstname>
<Lastname>String</Lastname>
</Consultant>
</LeaveCover>
</ConsultantGroups>
<BookingSources>
<BookingSource>
<ConsultantID>String</ConsultantID>
<BookingSourceCode>String</BookingSourceCode>
</BookingSource>
</BookingSources>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>