Agentivity API

<back to all web services

GetConsultantDetails

The following routes are available for this service:
All Verbs/ConsultantDetails
import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetConsultantDetails : CompanyLevelRequestBase, IRequestConsultantID
{
    /**
    * Consultant ID (sign on)
    */
    // @DataMember
    public var consultantID:String

    /**
    * Booking system (1G, 1A or 1S)
    */
    // @DataMember
    public var bookingSource:String

    /**
    * Request Consultant ID (sign on)
    */
    // @DataMember
    public var requestConsultantID:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case consultantID
        case bookingSource
        case requestConsultantID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        consultantID = try container.decodeIfPresent(String.self, forKey: .consultantID)
        bookingSource = try container.decodeIfPresent(String.self, forKey: .bookingSource)
        requestConsultantID = try container.decodeIfPresent(String.self, forKey: .requestConsultantID)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if consultantID != nil { try container.encode(consultantID, forKey: .consultantID) }
        if bookingSource != nil { try container.encode(bookingSource, forKey: .bookingSource) }
        if requestConsultantID != nil { try container.encode(requestConsultantID, forKey: .requestConsultantID) }
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class CompanyLevelRequestBase : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    public var owningCompanyCode:[String]

    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case owningCompanyCode
        case userName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        owningCompanyCode = try container.decodeIfPresent([String].self, forKey: .owningCompanyCode) ?? []
        userName = try container.decodeIfPresent(String.self, forKey: .userName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if owningCompanyCode != nil { try container.encode(owningCompanyCode, forKey: .owningCompanyCode) }
        if userName != nil { try container.encode(userName, forKey: .userName) }
    }
}

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public var offset:String

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public var limit:String

    /**
    * 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 var totalRecords:Int

    /**
    * 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 var responseRecords:Int

    required public init(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class GetConsultantDetailsItemResponse : ItemResponse<ConsultantDetails, GetConsultantDetailsResponseReport>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class ItemResponse<TItem : Codable, TReport : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:TReport

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var responseError:AgentivityError

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
    // @DataMember(Order=0)
    public var success:Bool

    // @DataMember(Order=1)
    public var hasCache:Bool

    // @DataMember(Order=2)
    public var hasPaging:Bool

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var cacheMetadata:CacheMetadata

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var pagingMetadata:PagingMetadata

    required public init(){}
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
    // @DataMember(Order=1)
    public var cachedAt:Date

    // @DataMember(Order=2)
    public var cacheExpiresAt:Date

    // @DataMember(Order=0)
    public var isFromCache:Bool

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
    // @DataMember
    public var errorCode:String

    // @DataMember
    public var message:String

    // @DataMember
    public var statusCode:String

    // @DataMember
    public var verboseMessage:String

    required public init(){}
}

// @DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
public class ConsultantDetails : Codable
{
    // @DataMember(Order=10)
    public var consultant:ConsultantMainDetails

    // @DataMember(Order=20)
    public var consultantGroups:ConsultantGroups

    // @DataMember(Order=30)
    public var bookingSources:[BookingSource]

    required public init(){}
}

// @DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
public class ConsultantMainDetails : Codable
{
    // @DataMember(Order=10)
    public var firstname:String

    // @DataMember(Order=20)
    public var lastname:String

    // @DataMember(Order=30)
    public var staffNumber:String

    // @DataMember(Order=40)
    public var email:String

    // @DataMember(Order=50)
    public var onLeave:Bool

    required public init(){}
}

// @DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")
public class ConsultantGroups : Codable
{
    // @DataMember(Order=10)
    public var leaveCover:[ConsultantInGroupDetails]

    required public init(){}
}

// @DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
public class ConsultantInGroupDetails : Codable
{
    // @DataMember(Order=10)
    public var consultantID:String

    // @DataMember(Order=20)
    public var firstname:String

    // @DataMember(Order=30)
    public var lastname:String

    required public init(){}
}

// @DataContract(Name="BookingSource", Namespace="schemas.agentivity.com/types")
public class BookingSource : Codable
{
    // @DataMember(Order=10)
    public var consultantID:String

    // @DataMember(Order=20)
    public var bookingSourceCode:String

    required public init(){}
}

// @DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
public class GetConsultantDetailsResponseReport : Report<GetConsultantDetailsItemResponse, ConsultantDetails>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class Report<TItemResponse : Codable, TItem : Codable> : Codable
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public var item:TItem

    required public init(){}
}

Swift GetConsultantDetails DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>