YM REST Services

<back to all web services

ZoomEventListener

The following routes are available for this service:
POST/Ams/ZoomEventListenerReceives and records a Zoom Event Subscription payload.
ZoomEventListener Parameters:
NameParameterData TypeRequiredDescription
EventbodystringNo
Event_TsbodystringNo
PayloadbodyZoomEventPayloadNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ZoomEventPayload Parameters:
NameParameterData TypeRequiredDescription
Account_IdformstringNo
ObjectformPayloadObjectNo
PayloadObject Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UuidformstringNo
Host_IdformstringNo
TopicformstringNo
TypeformintNo
Start_TimeformDateTimeNo
TimezoneformstringNo
DurationformintNo
ParticipantformZoomParticipantNo
ZoomParticipant Parameters:
NameParameterData TypeRequiredDescription
User_IdformstringNo
User_NameformstringNo
EmailformstringNo
IdformstringNo
Join_TimeformDateTimeNo
Leave_TimeformDateTimeNo

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 /Ams/ZoomEventListener HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ZoomEventListener xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Event>String</Event>
  <Event_Ts>String</Event_Ts>
  <Payload xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.Web.Services">
    <d2p1:Account_Id>String</d2p1:Account_Id>
    <d2p1:Object>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:Host_Id>String</d2p1:Host_Id>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Participant>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Join_Time>0001-01-01T00:00:00</d2p1:Join_Time>
        <d2p1:Leave_Time>0001-01-01T00:00:00</d2p1:Leave_Time>
        <d2p1:User_Id>String</d2p1:User_Id>
        <d2p1:User_Name>String</d2p1:User_Name>
      </d2p1:Participant>
      <d2p1:Start_Time>0001-01-01T00:00:00</d2p1:Start_Time>
      <d2p1:Timezone>String</d2p1:Timezone>
      <d2p1:Topic>String</d2p1:Topic>
      <d2p1:Type>0</d2p1:Type>
      <d2p1:Uuid>String</d2p1:Uuid>
    </d2p1:Object>
  </Payload>
</ZoomEventListener>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ZoomEventListenerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Event>String</Event>
  <Event_Ts>String</Event_Ts>
  <Payload xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.Web.Services">
    <d2p1:Account_Id>String</d2p1:Account_Id>
    <d2p1:Object>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:Host_Id>String</d2p1:Host_Id>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Participant>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Join_Time>0001-01-01T00:00:00</d2p1:Join_Time>
        <d2p1:Leave_Time>0001-01-01T00:00:00</d2p1:Leave_Time>
        <d2p1:User_Id>String</d2p1:User_Id>
        <d2p1:User_Name>String</d2p1:User_Name>
      </d2p1:Participant>
      <d2p1:Start_Time>0001-01-01T00:00:00</d2p1:Start_Time>
      <d2p1:Timezone>String</d2p1:Timezone>
      <d2p1:Topic>String</d2p1:Topic>
      <d2p1:Type>0</d2p1:Type>
      <d2p1:Uuid>String</d2p1:Uuid>
    </d2p1:Object>
  </Payload>
</ZoomEventListenerResponse>