Agentivity API

<back to all web services

BookingEventsSummaryRequest

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

// @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="Events", Namespace="schemas.agentivity.com/types")
export class EventsSummary
{
    // @DataMember(Order=10)
    public Create: string;

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

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

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

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

    // @DataMember(Order=70)
    public TicketsIssued: number;

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

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

    // @DataMember(Order=20)
    public Events: EventsSummary;

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

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

    // @DataMember(Order=20)
    public Events: EventsSummary;

    // @DataMember(Order=30)
    public Consultants: ConsultantEventsSummary[];

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

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

    // @DataMember(Order=20)
    public Events: EventsSummary;

    // @DataMember(Order=30)
    public Accounts: AccountEventsSummary[];

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

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

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

    // @DataMember(Order=30)
    public Events: EventsSummary;

    // @DataMember(Order=40)
    public Branches: OwningAgencyLocationIdEventsSummary[];

    public constructor(init?: Partial<BookingEventsSummary>) { (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="BookingEventsSummary", Namespace="schemas.agentivity.com/types")
export class BookingEventsSummaryRequestResponseReport extends Report<BookingEventsSummaryRequestItemResponse, BookingEventsSummary>
{

    public constructor(init?: Partial<BookingEventsSummaryRequestResponseReport>) { 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 BookingEventsSummaryRequestItemResponse extends ItemResponse<BookingEventsSummary, BookingEventsSummaryRequestResponseReport>
{

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

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

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

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

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

TypeScript BookingEventsSummaryRequest 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 /BookingEventsSummary HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"EventDateStart":"String","EventDateEnd":"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":{"DateStart":"\/Date(-62135596800000-0000)\/","DateEnd":"\/Date(-62135596800000-0000)\/","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Branches":[{"BranchId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Accounts":[{"AccountId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Consultants":[{"ConsultantId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0}}]}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}