POST api/v3/Events/List
Request Information
URI Parameters
None.
Body Parameters
EventsListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| pkEventScheduleID | string |
None. |
|
| CampaignId | string |
None. |
|
| CampaignCandidateId | string |
None. |
|
| EventTypeId | string |
None. |
|
| EventFromDate | date |
None. |
|
| EventToDate | date |
None. |
|
| Location | string |
None. |
|
| Notes | string |
None. |
|
| Published | boolean |
None. |
|
| NotPublished | boolean |
None. |
|
| CreatedBy | string |
None. |
|
| CandidateAvailability | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"pkEventScheduleID": "sample string 1",
"campaignId": "sample string 2",
"campaignCandidateId": "sample string 3",
"eventTypeId": "sample string 4",
"eventFromDate": "2025-12-06T04:38:52.7516363+00:00",
"eventToDate": "2025-12-06T04:38:52.7516363+00:00",
"location": "sample string 5",
"notes": "sample string 6",
"published": true,
"notPublished": true,
"createdBy": "sample string 7",
"candidateAvailability": "sample string 8"
}
text/html
Sample:
{"pkEventScheduleID":"sample string 1","campaignId":"sample string 2","campaignCandidateId":"sample string 3","eventTypeId":"sample string 4","eventFromDate":"2025-12-06T04:38:52.7516363+00:00","eventToDate":"2025-12-06T04:38:52.7516363+00:00","location":"sample string 5","notes":"sample string 6","published":true,"notPublished":true,"createdBy":"sample string 7","candidateAvailability":"sample string 8"}
application/xml, text/xml
Sample:
<EventsListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IC_Web_API_V3.Models"> <CampaignCandidateId>sample string 3</CampaignCandidateId> <CampaignId>sample string 2</CampaignId> <CandidateAvailability>sample string 8</CandidateAvailability> <CreatedBy>sample string 7</CreatedBy> <EventFromDate>2025-12-06T04:38:52.7516363+00:00</EventFromDate> <EventToDate>2025-12-06T04:38:52.7516363+00:00</EventToDate> <EventTypeId>sample string 4</EventTypeId> <Location>sample string 5</Location> <NotPublished>true</NotPublished> <Notes>sample string 6</Notes> <Published>true</Published> <pkEventScheduleID>sample string 1</pkEventScheduleID> </EventsListRequest>
application/x-www-form-urlencoded
Sample:
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. |