Agentivity API

<back to all web services

QLogEm

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

// @DataContract(Namespace="schemas.agentivity.com/types")
public class QLogEm : PagingMetadata
{
    /**
    * ID of a Company (travel agency)
    */
    // @DataMember
    public var companyID:Int?

    /**
    * ID for queue entry
    */
    // @DataMember
    public var queueEntryID:Int?

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var logDateStart:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var logDateEnd:String

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

    private enum CodingKeys : String, CodingKey {
        case companyID
        case queueEntryID
        case logDateStart
        case logDateEnd
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyID = try container.decodeIfPresent(Int.self, forKey: .companyID)
        queueEntryID = try container.decodeIfPresent(Int.self, forKey: .queueEntryID)
        logDateStart = try container.decodeIfPresent(String.self, forKey: .logDateStart)
        logDateEnd = try container.decodeIfPresent(String.self, forKey: .logDateEnd)
    }

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

// @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 QLogEmItemResponse : ItemResponse<QLogEmItem, QLogEmResponseReport>
{
    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="QLogEmItem", Namespace="schemas.agentivity.com/types")
public class QLogEmItem : Codable
{
    // @DataMember(Order=10)
    public var agentivityRef:Int

    // @DataMember(Order=20)
    public var entryID:Int

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

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

    // @DataMember(Order=50)
    public var logDate:Date?

    // @DataMember(Order=60)
    public var eventType:String

    required public init(){}
}

// @DataContract(Name="QLogEmItem", Namespace="schemas.agentivity.com/types")
public class QLogEmResponseReport : Report<QLogEmItemResponse, QLogEmItem>
{
    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 QLogEm 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 /QLogEm HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QLogEm 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>
  <CompanyID>0</CompanyID>
  <LogDateEnd>String</LogDateEnd>
  <LogDateStart>String</LogDateStart>
  <QueueEntryID>0</QueueEntryID>
</QLogEm>

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>
      <AgentivityRef>0</AgentivityRef>
      <EntryID>0</EntryID>
      <MatchedOn>String</MatchedOn>
      <RecordLocator>String</RecordLocator>
      <LogDate>0001-01-01T00:00:00</LogDate>
      <EventType>String</EventType>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>