|
| 1 | +name: MeetingRegistrant |
| 2 | +endpoint: meetings/{meetingId}/registrants |
| 3 | +object_type: meetingRegistrant |
| 4 | +methods: |
| 5 | + - list |
| 6 | + - get |
| 7 | + - create |
| 8 | + - delete |
| 9 | +url_parameters: |
| 10 | + - name: meetingId |
| 11 | + description: Unique identifier for the meeting. |
| 12 | + type: basestring |
| 13 | +query_parameters: |
| 14 | + - name: max |
| 15 | + description: Limit the maximum number of registrants in the response, up to 100. |
| 16 | + optional: True |
| 17 | + type: int |
| 18 | + - name: hostEmail |
| 19 | + description: Email address for the meeting host. |
| 20 | + optional: True |
| 21 | + type: basestring |
| 22 | + - name: current |
| 23 | + description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. |
| 24 | + optional: True |
| 25 | + type: bool |
| 26 | + - name: email |
| 27 | + description: Registrant's email to filter registrants. |
| 28 | + optional: True |
| 29 | + type: basestring |
| 30 | + - name: registrationTimeFrom |
| 31 | + description: The time registrants register a meeting starts from the specified date and time (inclusive) in any ISO 8601 compliant format. |
| 32 | + optional: True |
| 33 | + type: basestring |
| 34 | + - name: registrationTimeTo |
| 35 | + description: The time registrants register a meeting before the specified date and time (exclusive) in any ISO 8601 compliant format. |
| 36 | + optional: True |
| 37 | + type: basestring |
| 38 | +list: |
| 39 | + properties: |
| 40 | + - name: registrantId |
| 41 | + description: New registrant's ID. |
| 42 | + type: basestring |
| 43 | + - name: status |
| 44 | + description: New registrant's status. |
| 45 | + type: basestring |
| 46 | + - name: firstName |
| 47 | + description: Registrant's first name. |
| 48 | + type: basestring |
| 49 | + - name: lastName |
| 50 | + description: Registrant's last name. |
| 51 | + type: basestring |
| 52 | + - name: email |
| 53 | + description: Registrant's email. |
| 54 | + type: basestring |
| 55 | + - name: jobTitle |
| 56 | + description: Registrant's job title. |
| 57 | + type: basestring |
| 58 | + - name: companyName |
| 59 | + description: Registrant's company. |
| 60 | + type: basestring |
| 61 | + - name: address1 |
| 62 | + description: Registrant's first address line. |
| 63 | + type: basestring |
| 64 | + - name: address2 |
| 65 | + description: Registrant's second address line. |
| 66 | + type: basestring |
| 67 | + - name: city |
| 68 | + description: Registrant's city name. |
| 69 | + type: basestring |
| 70 | + - name: state |
| 71 | + description: Registrant's state. |
| 72 | + type: basestring |
| 73 | + - name: zipCode |
| 74 | + description: Registrant's postal code. |
| 75 | + type: int |
| 76 | + - name: countryRegion |
| 77 | + description: Registrant's country or region. |
| 78 | + type: basestring |
| 79 | + - name: workPhone |
| 80 | + description: Registrant's work phone number. |
| 81 | + type: basestring |
| 82 | + - name: fax |
| 83 | + description: Registrant's FAX number. |
| 84 | + type: basestring |
| 85 | + - name: registrationTime |
| 86 | + description: Registrant's registration time. |
| 87 | + type: basestring |
| 88 | + - name: customizedQuestions |
| 89 | + description: List of registrant's answers for customized questions, |
| 90 | + type: list |
| 91 | + - name: sourceId |
| 92 | + description: Registrant's source id. |
| 93 | + type: basestring |
| 94 | + - name: registrationId |
| 95 | + description: Registrant's registration ID. |
| 96 | + type: basestring |
| 97 | + |
| 98 | +create: |
| 99 | + required: |
| 100 | + - firstName |
| 101 | + - lastName |
| 102 | + - email |
| 103 | + optional: |
| 104 | + - name: sendEmail |
| 105 | + description: If true send email to the registrant. |
| 106 | + type: bool |
| 107 | + - jobTitle |
| 108 | + - address1 |
| 109 | + - address2 |
| 110 | + - city |
| 111 | + - state |
| 112 | + - zipCode |
| 113 | + - countryRegion |
| 114 | + - workPhone |
| 115 | + - fax |
| 116 | + - customizedQuestions |
| 117 | +update: |
| 118 | + # required: |
| 119 | + optional: |
| 120 | + - firstName |
| 121 | + - lastName |
| 122 | + - email |
| 123 | + - name: sendEmail |
| 124 | + description: If true send email to the registrant. |
| 125 | + type: bool |
| 126 | + - jobTitle |
| 127 | + - address1 |
| 128 | + - address2 |
| 129 | + - city |
| 130 | + - state |
| 131 | + - zipCode |
| 132 | + - countryRegion |
| 133 | + - workPhone |
| 134 | + - fax |
| 135 | + - customizedQuestions |
0 commit comments