| All Verbs | /ConsultantDetails |
|---|
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantMainDetails() =
[<DataMember(Order=10)>]
member val Firstname:String = null with get,set
[<DataMember(Order=20)>]
member val Lastname:String = null with get,set
[<DataMember(Order=30)>]
member val StaffNumber:String = null with get,set
[<DataMember(Order=40)>]
member val Email:String = null with get,set
[<DataMember(Order=50)>]
member val OnLeave:Boolean = new Boolean() with get,set
[<DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantInGroupDetails() =
[<DataMember(Order=10)>]
member val ConsultantID:String = null with get,set
[<DataMember(Order=20)>]
member val Firstname:String = null with get,set
[<DataMember(Order=30)>]
member val Lastname:String = null with get,set
[<DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantGroups() =
[<DataMember(Order=10)>]
member val LeaveCover:ResizeArray<ConsultantInGroupDetails> = null with get,set
[<DataContract(Name="BookingSource", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingSource() =
[<DataMember(Order=10)>]
member val ConsultantID:String = null with get,set
[<DataMember(Order=20)>]
member val BookingSourceCode:String = null with get,set
[<DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantDetails() =
[<DataMember(Order=10)>]
member val Consultant:ConsultantMainDetails = null with get,set
[<DataMember(Order=20)>]
member val ConsultantGroups:ConsultantGroups = null with get,set
[<DataMember(Order=30)>]
member val BookingSources:ResizeArray<BookingSource> = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetConsultantDetailsResponseReport() =
inherit Report<GetConsultantDetailsItemResponse, ConsultantDetails>()
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with get,set
///<summary>
///Number of records to return (PageSize)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
member val Limit:String = null with get,set
///<summary>
///Total Number of Records in a Full Reponse (if no paging)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
member val TotalRecords:Int32 = new Int32() with get,set
///<summary>
///Total Number of Records in this Reponse (on this page)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetConsultantDetailsItemResponse() =
inherit ItemResponse<ConsultantDetails, GetConsultantDetailsResponseReport>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CompanyLevelRequestBase() =
inherit PagingMetadata()
///<summary>
///Comma Delimited List of Owning Company Codes
///</summary>
[<DataMember>]
member val OwningCompanyCode:String[] = null with get,set
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetConsultantDetails() =
inherit CompanyLevelRequestBase()
///<summary>
///Consultant ID (sign on)
///</summary>
[<DataMember>]
member val ConsultantID:String = null with get,set
///<summary>
///Booking system (1G, 1A or 1S)
///</summary>
[<DataMember>]
member val BookingSource:String = null with get,set
///<summary>
///Request Consultant ID (sign on)
///</summary>
[<DataMember>]
member val RequestConsultantID:String = null with get,set
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>