Agentivity API

<back to all web services

BookingEventsSummaryRequest

The following routes are available for this service:
All Verbs/BookingEventsSummary
BookingEventsSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
EventDateStartquerystringYesDate in format YYYYMMDD
EventDateEndquerystringNoDate in format YYYYMMDD
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
BookingEventsSummary Parameters:
NameParameterData TypeRequiredDescription
DateStartformDateTime?No
DateEndformDateTime?No
EventsformEventsSummaryNo
BranchesformList<OwningAgencyLocationIdEventsSummary>No
EventsSummary Parameters:
NameParameterData TypeRequiredDescription
CreateformstringNo
CancelformstringNo
ChangeformstringNo
TicketingformstringNo
ServiceformstringNo
TicketsIssuedformintNo
OwningAgencyLocationIdEventsSummary Parameters:
NameParameterData TypeRequiredDescription
BranchIdformstringNo
EventsformEventsSummaryNo
AccountsformList<AccountEventsSummary>No
AccountEventsSummary Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNo
EventsformEventsSummaryNo
ConsultantsformList<ConsultantEventsSummary>No
ConsultantEventsSummary Parameters:
NameParameterData TypeRequiredDescription
ConsultantIdformstringNo
EventsformEventsSummaryNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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"}}