TicketUserServices

<back to all web services

EventSendGuardBatchRequest

The following routes are available for this service:
POST/EventSendGuard
EventSendGuardBatchRequest Parameters:
NameParameterData TypeRequiredDescription
EventIdsbodyList<int>No
ChangeLookbackHoursbodyint?No
EventSendGuardBatchResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<EventSendGuardResult>No
SendableCountformintNo
BlockedCountformintNo
StatusCodeformintNo
MessageformstringNo
EventSendGuardResult Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
EventNameformstringNo
SendableformboolNo
ReasonsformList<string>No
CurrentTimeOfEventUtcformDateTime?No
AssumedTimeUtcformDateTime?No
TimeChangedSincePlannedformboolNo
PostponedNoDateformboolNo
EventActiveformboolNo
HideEventformboolNo
AlreadyStartedformboolNo
LastChangeAtformDateTime?No
RecentChangesformList<EventSendGuardChange>No
StatusCodeformintNo
MessageformstringNo
EventSendGuardChange Parameters:
NameParameterData TypeRequiredDescription
ChangedAtformDateTimeNo
TimeHasChangedformboolNo
LocationHasChangedformboolNo
OldTimeOfEventformDateTime?No
NewTimeOfEventformDateTime?No
AlertHandledformboolNo

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 /EventSendGuard HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventSendGuardBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ChangeLookbackHours>0</ChangeLookbackHours>
  <EventIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </EventIds>
</EventSendGuardBatchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventSendGuardBatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <BlockedCount>0</BlockedCount>
  <Items>
    <EventSendGuardResult>
      <AlreadyStarted>false</AlreadyStarted>
      <AssumedTimeUtc>0001-01-01T00:00:00</AssumedTimeUtc>
      <CurrentTimeOfEventUtc>0001-01-01T00:00:00</CurrentTimeOfEventUtc>
      <EventActive>false</EventActive>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <HideEvent>false</HideEvent>
      <LastChangeAt>0001-01-01T00:00:00</LastChangeAt>
      <Message>String</Message>
      <PostponedNoDate>false</PostponedNoDate>
      <Reasons xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Reasons>
      <RecentChanges>
        <EventSendGuardChange>
          <AlertHandled>false</AlertHandled>
          <ChangedAt>0001-01-01T00:00:00</ChangedAt>
          <LocationHasChanged>false</LocationHasChanged>
          <NewTimeOfEvent>0001-01-01T00:00:00</NewTimeOfEvent>
          <OldTimeOfEvent>0001-01-01T00:00:00</OldTimeOfEvent>
          <TimeHasChanged>false</TimeHasChanged>
        </EventSendGuardChange>
      </RecentChanges>
      <Sendable>false</Sendable>
      <StatusCode>0</StatusCode>
      <TimeChangedSincePlanned>false</TimeChangedSincePlanned>
    </EventSendGuardResult>
  </Items>
  <Message>String</Message>
  <SendableCount>0</SendableCount>
  <StatusCode>0</StatusCode>
</EventSendGuardBatchResult>