Agentivity API

<back to all web services

GetChurns

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

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetChurns : CompanyLevelRequestBase
{
    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var churnDateStart:String

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

    /**
    * Return only PNRs that are ticketed/all
    */
    // @DataMember
    public var pnrTicketed:String

    /**
    * Two letter airline code
    */
    // @DataMember
    public var airlineCode:String

    /**
    * Two letter Segment Status
    */
    // @DataMember
    public var segmentStatus:String

    /**
    * Comma Delimited List of PCCs
    */
    // @DataMember
    public var owningAgencyLocationID:[String]

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

    private enum CodingKeys : String, CodingKey {
        case churnDateStart
        case churnDateEnd
        case pnrTicketed
        case airlineCode
        case segmentStatus
        case owningAgencyLocationID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        churnDateStart = try container.decodeIfPresent(String.self, forKey: .churnDateStart)
        churnDateEnd = try container.decodeIfPresent(String.self, forKey: .churnDateEnd)
        pnrTicketed = try container.decodeIfPresent(String.self, forKey: .pnrTicketed)
        airlineCode = try container.decodeIfPresent(String.self, forKey: .airlineCode)
        segmentStatus = try container.decodeIfPresent(String.self, forKey: .segmentStatus)
        owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if churnDateStart != nil { try container.encode(churnDateStart, forKey: .churnDateStart) }
        if churnDateEnd != nil { try container.encode(churnDateEnd, forKey: .churnDateEnd) }
        if pnrTicketed != nil { try container.encode(pnrTicketed, forKey: .pnrTicketed) }
        if airlineCode != nil { try container.encode(airlineCode, forKey: .airlineCode) }
        if segmentStatus != nil { try container.encode(segmentStatus, forKey: .segmentStatus) }
        if owningAgencyLocationID != nil { try container.encode(owningAgencyLocationID, forKey: .owningAgencyLocationID) }
    }
}

// @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 ChurnsItemResponse : ItemResponse<Churn, ChurnsResponseReport>
{
    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="Churn", Namespace="schemas.agentivity.com/types")
public class Churn : Codable
{
    // @DataMember(Order=10)
    public var recordlocator:String

    // @DataMember(Order=20)
    public var pnrCreationDate:Date

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

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

    // @DataMember(Order=50)
    public var owningConsultantID:String

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

    // @DataMember(Order=70)
    public var pnrTicketed:String

    // @DataMember(Order=80)
    public var airlineCode:String

    // @DataMember(Order=90)
    public var firstDetectedDate:Date

    // @DataMember(Order=100)
    public var lastDetectedDateTime:Date

    // @DataMember(Order=110)
    public var detectedCount:Int

    required public init(){}
}

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

<GetChurns 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>
  <AirlineCode>String</AirlineCode>
  <ChurnDateEnd>String</ChurnDateEnd>
  <ChurnDateStart>String</ChurnDateStart>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <PNRTicketed>String</PNRTicketed>
  <SegmentStatus>String</SegmentStatus>
</GetChurns>

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>
      <Recordlocator>String</Recordlocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <PNRTicketed>String</PNRTicketed>
      <AirlineCode>String</AirlineCode>
      <FirstDetectedDate>0001-01-01T00:00:00</FirstDetectedDate>
      <LastDetectedDateTime>0001-01-01T00:00:00</LastDetectedDateTime>
      <DetectedCount>0</DetectedCount>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>