Agentivity API

GetChurns

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel.Base
Imports AgentivityAPI.ServiceModel

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItemResponse(Of TItem, TReport)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As TReport

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Report(Of TItemResponse, TItem)
            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property Item As TItem
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Base

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CompanyLevelRequestBase
            Inherits PagingMetadata
            Implements IMemberUsername
            Implements IMemberOwningCompanyCode
            '''<Summary>
            '''Comma Delimited List of Owning Company Codes
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode

            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String Implements IMemberUsername.UserName
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Name:="Churn", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Churn
            <DataMember(Order:=10)>
            Public Overridable Property Recordlocator As String

            <DataMember(Order:=20)>
            Public Overridable Property PNRCreationDate As Date

            <DataMember(Order:=30)>
            Public Overridable Property OwningAgencyLocationID As String

            <DataMember(Order:=40)>
            Public Overridable Property Account As String

            <DataMember(Order:=50)>
            Public Overridable Property OwningConsultantID As String

            <DataMember(Order:=60)>
            Public Overridable Property OwningConsultant As String

            <DataMember(Order:=70)>
            Public Overridable Property PNRTicketed As String

            <DataMember(Order:=80)>
            Public Overridable Property AirlineCode As String

            <DataMember(Order:=90)>
            Public Overridable Property FirstDetectedDate As Date

            <DataMember(Order:=100)>
            Public Overridable Property LastDetectedDateTime As Date

            <DataMember(Order:=110)>
            Public Overridable Property DetectedCount As Integer
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ChurnsItemResponse
            Inherits ItemResponse(Of Churn, ChurnsResponseReport)
        End Class

        <DataContract(Name:="Churn", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ChurnsResponseReport
            Inherits Report(Of ChurnsItemResponse, Churn)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetChurns
            Inherits CompanyLevelRequestBase
            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property ChurnDateStart As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property ChurnDateEnd As String

            '''<Summary>
            '''Return only PNRs that are ticketed/all
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRTicketed As String

            '''<Summary>
            '''Two letter airline code
            '''</Summary>
            <DataMember>
            Public Overridable Property AirlineCode As String

            '''<Summary>
            '''Two letter Segment Status
            '''</Summary>
            <DataMember>
            Public Overridable Property SegmentStatus As String

            '''<Summary>
            '''Comma Delimited List of PCCs
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningAgencyLocationID As String()
        End Class

        <DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PagingMetadata
            '''<Summary>
            '''Starting Record
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
            Public Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<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")>
            Public Overridable Property TotalRecords As Integer

            '''<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")>
            Public Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class
    End Namespace
End Namespace

VB.NET 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>