Agentivity API

<back to all web services

GetChurns

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

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

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

    /** @description 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 TotalRecords: number;

    /** @description 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 ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="Churn", Namespace="schemas.agentivity.com/types")
export class Churn
{
    // @DataMember(Order=10)
    public Recordlocator: string;

    // @DataMember(Order=20)
    public PNRCreationDate: string;

    // @DataMember(Order=30)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=40)
    public Account: string;

    // @DataMember(Order=50)
    public OwningConsultantID: string;

    // @DataMember(Order=60)
    public OwningConsultant: string;

    // @DataMember(Order=70)
    public PNRTicketed: string;

    // @DataMember(Order=80)
    public AirlineCode: string;

    // @DataMember(Order=90)
    public FirstDetectedDate: string;

    // @DataMember(Order=100)
    public LastDetectedDateTime: string;

    // @DataMember(Order=110)
    public DetectedCount: number;

    public constructor(init?: Partial<Churn>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Churn", Namespace="schemas.agentivity.com/types")
export class ChurnsResponseReport extends Report<ChurnsItemResponse, Churn>
{

    public constructor(init?: Partial<ChurnsResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

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

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

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ChurnsItemResponse extends ItemResponse<Churn, ChurnsResponseReport>
{

    public constructor(init?: Partial<ChurnsItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetChurns extends CompanyLevelRequestBase
{
    /** @description Date in format YYYYMMDD */
    // @DataMember
    public ChurnDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public ChurnDateEnd: string;

    /** @description Return only PNRs that are ticketed/all */
    // @DataMember
    public PNRTicketed: string;

    /** @description Two letter airline code */
    // @DataMember
    public AirlineCode: string;

    /** @description Two letter Segment Status */
    // @DataMember
    public SegmentStatus: string;

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[];

    public constructor(init?: Partial<GetChurns>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetChurns DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ChurnDateStart":"String","ChurnDateEnd":"String","PNRTicketed":"String","AirlineCode":"String","SegmentStatus":"String","OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"Recordlocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","PNRTicketed":"String","AirlineCode":"String","FirstDetectedDate":"\/Date(-62135596800000-0000)\/","LastDetectedDateTime":"\/Date(-62135596800000-0000)\/","DetectedCount":0}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}