PUT api/SchedulerEvents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}
Allows for a Put of a schedule event
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorID | string |
Required |
|
| VendorPassword | string |
Required |
|
| APIGUID | string |
Required |
Body Parameters
CompanyEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyEventKey | integer |
None. |
|
| ce_Changed | boolean |
None. |
|
| CompanyKey | integer |
None. |
|
| CommitteeKey | integer |
None. |
|
| CommonCodeKey | integer |
None. |
|
| ce_Name | string |
None. |
|
| ce_Event | date |
None. |
|
| ce_IsPublic | boolean |
None. |
|
| ce_Location | string |
None. |
|
| ce_Address | string |
None. |
|
| ce_Address2 | string |
None. |
|
| ce_City | string |
None. |
|
| ce_State | string |
None. |
|
| ce_ZipCode | string |
None. |
|
| ce_ImageName | string |
None. |
|
| ce_Type | integer |
None. |
|
| ce_EndDate | date |
None. |
|
| ce_AllDay | boolean |
None. |
|
| ce_Status | integer |
None. |
|
| ce_ReminderInfo | string |
None. |
|
| ce_RecurrenceInfo | string |
None. |
|
| ce_Description | string |
None. |
|
| ce_EmployeeKey | integer |
None. |
|
| ce_EmployeeRoleKey | integer |
None. |
|
| ce_EmployeeType | integer |
None. |
|
| EventType | string |
None. |
|
| CommitteeName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CompanyEventKey": 1,
"ce_Changed": true,
"CompanyKey": 3,
"CommitteeKey": 4,
"CommonCodeKey": 5,
"ce_Name": "sample string 6",
"ce_Event": "2025-10-27T12:15:34.9871761-07:00",
"ce_IsPublic": true,
"ce_Location": "sample string 9",
"ce_Address": "sample string 10",
"ce_Address2": "sample string 11",
"ce_City": "sample string 12",
"ce_State": "sample string 13",
"ce_ZipCode": "sample string 14",
"ce_ImageName": "sample string 15",
"ce_Type": 16,
"ce_EndDate": "2025-10-27T12:15:34.9871761-07:00",
"ce_AllDay": true,
"ce_Status": 19,
"ce_ReminderInfo": "sample string 20",
"ce_RecurrenceInfo": "sample string 21",
"ce_Description": "sample string 22",
"ce_EmployeeKey": 23,
"ce_EmployeeRoleKey": 24,
"ce_EmployeeType": 25,
"EventType": "sample string 26",
"CommitteeName": "sample string 27"
}
application/xml, text/xml
Sample:
<Scheduler.CompanyEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesScheduler"> <CommitteeKey>4</CommitteeKey> <CommitteeName>sample string 27</CommitteeName> <CommonCodeKey>5</CommonCodeKey> <CompanyEventKey>1</CompanyEventKey> <CompanyKey>3</CompanyKey> <EventType>sample string 26</EventType> <ce_Address>sample string 10</ce_Address> <ce_Address2>sample string 11</ce_Address2> <ce_AllDay>true</ce_AllDay> <ce_Changed>true</ce_Changed> <ce_City>sample string 12</ce_City> <ce_Description>sample string 22</ce_Description> <ce_EmployeeKey>23</ce_EmployeeKey> <ce_EmployeeRoleKey>24</ce_EmployeeRoleKey> <ce_EmployeeType>25</ce_EmployeeType> <ce_EndDate>2025-10-27T12:15:34.9871761-07:00</ce_EndDate> <ce_Event>2025-10-27T12:15:34.9871761-07:00</ce_Event> <ce_ImageName>sample string 15</ce_ImageName> <ce_IsPublic>true</ce_IsPublic> <ce_Location>sample string 9</ce_Location> <ce_Name>sample string 6</ce_Name> <ce_RecurrenceInfo>sample string 21</ce_RecurrenceInfo> <ce_ReminderInfo>sample string 20</ce_ReminderInfo> <ce_State>sample string 13</ce_State> <ce_Status>19</ce_Status> <ce_Type>16</ce_Type> <ce_ZipCode>sample string 14</ce_ZipCode> </Scheduler.CompanyEvent>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |