| All Verbs | /BookingEventsSummary |
|---|
"use strict";
export class PagingMetadata {
/** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Starting Record */
Offset;
/**
* @type {string}
* @description Number of records to return (PageSize) */
Limit;
/**
* @type {number}
* @description Total Number of Records in a Full Reponse (if no paging) */
TotalRecords;
/**
* @type {number}
* @description Total Number of Records in this Reponse (on this page) */
ResponseRecords;
}
export class CompanyLevelRequestBase extends PagingMetadata {
/** @param {{OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string[]}
* @description Comma Delimited List of Owning Company Codes */
OwningCompanyCode;
/**
* @type {string}
* @description UserName in form of an email address */
UserName;
}
export class EventsSummary {
/** @param {{Create?:string,Cancel?:string,Change?:string,Ticketing?:string,Service?:string,TicketsIssued?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Create;
/** @type {string} */
Cancel;
/** @type {string} */
Change;
/** @type {string} */
Ticketing;
/** @type {string} */
Service;
/** @type {number} */
TicketsIssued;
}
export class ConsultantEventsSummary {
/** @param {{ConsultantId?:string,Events?:EventsSummary}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ConsultantId;
/** @type {EventsSummary} */
Events;
}
export class AccountEventsSummary {
/** @param {{AccountId?:string,Events?:EventsSummary,Consultants?:ConsultantEventsSummary[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AccountId;
/** @type {EventsSummary} */
Events;
/** @type {ConsultantEventsSummary[]} */
Consultants;
}
export class OwningAgencyLocationIdEventsSummary {
/** @param {{BranchId?:string,Events?:EventsSummary,Accounts?:AccountEventsSummary[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BranchId;
/** @type {EventsSummary} */
Events;
/** @type {AccountEventsSummary[]} */
Accounts;
}
export class BookingEventsSummary {
/** @param {{DateStart?:string,DateEnd?:string,Events?:EventsSummary,Branches?:OwningAgencyLocationIdEventsSummary[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
DateStart;
/** @type {?string} */
DateEnd;
/** @type {EventsSummary} */
Events;
/** @type {OwningAgencyLocationIdEventsSummary[]} */
Branches;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class BookingEventsSummaryRequestResponseReport extends Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class CacheMetadata {
/** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CachedAt;
/** @type {string} */
CacheExpiresAt;
/** @type {boolean} */
IsFromCache;
}
export class ResponseMetadata {
/** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {boolean} */
HasCache;
/** @type {boolean} */
HasPaging;
/** @type {CacheMetadata} */
CacheMetadata;
/** @type {PagingMetadata} */
PagingMetadata;
}
export class AgentivityError {
/** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ErrorCode;
/** @type {string} */
Message;
/** @type {string} */
StatusCode;
/** @type {string} */
VerboseMessage;
}
/** @typedef TItem {any} */
/** @typedef TReport {any} */
export class ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseMetadata} */
ResponseMetadata;
/** @type {TReport} */
ResponseReport;
/** @type {AgentivityError} */
ResponseError;
}
export class BookingEventsSummaryRequestItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class BookingEventsSummaryRequest extends CompanyLevelRequestBase {
/** @param {{EventDateStart?:string,EventDateEnd?:string,OwningAgencyLocationID?:string[],OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Date in format YYYYMMDD */
EventDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
EventDateEnd;
/**
* @type {string[]}
* @description Comma Delimited List of PCCs */
OwningAgencyLocationID;
}
JavaScript BookingEventsSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<BookingEventsSummaryRequest 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>
<EventDateEnd>String</EventDateEnd>
<EventDateStart>String</EventDateStart>
<OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningAgencyLocationID>
</BookingEventsSummaryRequest>
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>
<DateStart>0001-01-01T00:00:00</DateStart>
<DateEnd>0001-01-01T00:00:00</DateEnd>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Branches>
<Branch>
<BranchId>String</BranchId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Accounts>
<Account>
<AccountId>String</AccountId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
<Consultants>
<Consultant>
<ConsultantId>String</ConsultantId>
<Events>
<Create>String</Create>
<Cancel>String</Cancel>
<Change>String</Change>
<Ticketing>String</Ticketing>
<Service>String</Service>
<TicketsIssued>0</TicketsIssued>
</Events>
</Consultant>
</Consultants>
</Account>
</Accounts>
</Branch>
</Branches>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>