Events
This resource allows you to create/update an Event with all the information. You can also retrieve the Event details.
GET
End Point: /events
You can search for any existing Event using this service. All the event details that displayed in Search Event window in R2 are retrievable. Along with that, you can also retrieve Project ID, Profit Center ID, Project Manager ID, Project Manager Name, and status (open/closed) of the event details.
You can search for any existing Department using filters as defined here.
Pagination is supported for this resource. Click here to see the details of it.
Sample response payload
[
{
"recordid": "string",
"type": "string",
"id": "string",
"description": "string",
"projectid": "string",
"referenceno": "string",
"clientmanagerid": "string",
"clientmanagername": "string",
"salesmanagerid": "string",
"salesmanagername": "string",
"projectmanagerid": "string",
"projectmanagername": "string",
"billingcompany": "string",
"maincompany": "string",
"createdbyid": "string",
"createdbyname": "string",
"eventstartdate": "MM/dd/yyyy HH:mm",
"eventenddate": "MM/dd/yyyy HH:mm",
"eventprepdate": "MM/dd/yyyy HH:mm",
"eventreturndate": "MM/dd/yyyy HH:mm",
"profitcenter": "string",
"isclosed": true
}
]GET By ID
End Point: /events/{id}
You can retrieve all information including the comments of a specific event by ID using this service.
Sample response payload
{
"recordid": "string",
"eventid": "string",
"eventname": "string",
"referencenumber": "string",
"closed": true,
"projectid": "string",
"profitcenterid": "string",
"salesmanagerid": "string",
"clientmanagerid": "string",
"projectmanagerid": "string",
"eventtype": "Conference",
"itempricegroupid": "string",
"laborpricegroupid": "string",
"billtocustomertype": "Main Company",
"maincustomerid": "string",
"maincontactid": "string",
"mainworkphone": "string",
"billingcustomerid": "string",
"billingcontactid": "string",
"billingworkphone": "string",
"datecreated": "MM/dd/yyyy HH:mm",
"createdbyid": "string",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm",
"prepdate": "MM/dd/yyyy HH:mm",
"shipdate": "MM/dd/yyyy HH:mm",
"loadindate": "MM/dd/yyyy HH:mm",
"rehearsaldate": "MM/dd/yyyy HH:mm",
"showstartdate": "MM/dd/yyyy HH:mm",
"showenddate": "MM/dd/yyyy HH:mm",
"strikedate": "MM/dd/yyyy HH:mm",
"pickupdate": "MM/dd/yyyy HH:mm",
"returndate": "MM/dd/yyyy HH:mm",
"eventlocations":
[
{
"recordid": "string",
"locationid": "string",
"locationname": "string",
"address":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"type": "Convention",
"isdefault": true
}
],
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"comments":
[
{
"recordid": "string",
"comment": "string"
}
]
}POST
End Point: /events
This action is used to create an Event by providing following event details: General, Dates, Location, Comments, and UDF. Mandatory field details must be entered for successful creation. Recordid in comments must be null.
You can enable the Event ID mandatory in Employee Defaults → Account → Events → Mandatory → Event ID. When this setting is ON, the POST /events API requires you to provide a valid Event ID in the request. If you send a missing, null, or empty Event ID, the API rejects the request and returns the message. When the setting is OFF, the API automatically generates the Event ID using either the IDS sequence or the sequencer, depending on availability.
On successful creation, you will see the entire object in the response.
The ID of the new record will be returned in 'Location' attribute of the HTTP Header.
The 'Location' indicates the target of a redirection or the URL of a newly created resource.
For example: /events/{id}
Sample request payload
{
"recordid": "string",
"eventid": "string",
"eventname": "string",
"referencenumber": "string",
"closed": true,
"projectid": "string",
"profitcenterid": "string",
"salesmanagerid": "string",
"clientmanagerid": "string",
"projectmanagerid": "string",
"eventtype": "Conference",
"itempricegroupid": "string",
"laborpricegroupid": "string",
"billtocustomertype": "Main Company",
"maincontactid": "string",
"mainworkphone": "string",
"billingcontactid": "string",
"billingworkphone": "string",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm",
"prepdate": "MM/dd/yyyy HH:mm",
"shipdate": "MM/dd/yyyy HH:mm",
"loadindate": "MM/dd/yyyy HH:mm",
"rehearsaldate": "MM/dd/yyyy HH:mm",
"showstartdate": "MM/dd/yyyy HH:mm",
"showenddate": "MM/dd/yyyy HH:mm",
"strikedate": "MM/dd/yyyy HH:mm",
"pickupdate": "MM/dd/yyyy HH:mm",
"returndate": "MM/dd/yyyy HH:mm",
"eventlocations":
[
{
"recordid": "string",
"locationid": "string",
"address":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"type": "Convention",
"isdefault": true
}
],
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"comments":
[
{
"recordid": "string",
"comment": "string"
}
]
}PUT
End Point: /events/{id}
You can modify the details of an existing Event including the comments.
You can configure the Event ID requirement in Employee Defaults → Account → Events → Mandatory → Event ID. When this setting is ON, the PUT /events API does not allow you to clear or empty the Event ID. If you send an empty or null Event ID in the PUT request, the API rejects the update and returns an error message. When this setting is OFF, the Event ID remains optional for PUT requests.
After a successful update, you will see the entire object in the response.
Sample request payload
{
"recordid": "string",
"eventid": "string",
"eventname": "string",
"referencenumber": "string",
"closed": true,
"projectid": "string",
"profitcenterid": "string",
"salesmanagerid": "string",
"clientmanagerid": "string",
"projectmanagerid": "string",
"eventtype": "Conference",
"itempricegroupid": "string",
"laborpricegroupid": "string",
"billtocustomertype": "Main Company",
"maincontactid": "string",
"mainworkphone": "string",
"billingcontactid": "string",
"billingworkphone": "string",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm",
"prepdate": "MM/dd/yyyy HH:mm",
"shipdate": "MM/dd/yyyy HH:mm",
"loadindate": "MM/dd/yyyy HH:mm",
"rehearsaldate": "MM/dd/yyyy HH:mm",
"showstartdate": "MM/dd/yyyy HH:mm",
"showenddate": "MM/dd/yyyy HH:mm",
"strikedate": "MM/dd/yyyy HH:mm",
"pickupdate": "MM/dd/yyyy HH:mm",
"returndate": "MM/dd/yyyy HH:mm",
"eventlocations":
[
{
"recordid": "string",
"locationid": "string",
"address":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"type": "Convention",
"isdefault": true
}
],
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"comments":
[
{
"recordid": "string",
"comment": "string"
}
]
}