Lookup Data #
| Type | Details |
|---|---|
| resource | Use the duration configured for the resources on the template |
| custom | Use a custom defined duration for this template |
| schedule | Use the slots for the schedule as available durations |
| Interval | Details |
|---|---|
| day | Days (ie one day) |
| week | Week (ie two weeks) |
| month | Month (ie three months) |
| year | Year (ie four years) |
GET Methods #
Get Event Templates #
Description
Gets a list of all event templates./div>
Route
/EventTemplates/
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Response
{
"links": [],
"message": null,
"templates": [
{
"links": [],
"message": null,
"id": "template-id",
"resourceIds": [
1,
2
],
"scheduleId": 1,
"accessoryIds": [
1,
2
],
"attributeIds": [
1,
2
],
"name": "internal name",
"notes": "internal notes",
"heading": "event template heading",
"images": [
"image1.jpg"
],
"userNotes": "user facing notes",
"durationType": "resource | custom | schedule",
"duration": "1h",
"createNoticeRule": {
"type": "relative",
"relative": {
"noticeAmount": 1,
"noticeInterval": "day"
},
"dayOfWeek": null,
"dayOfMonth": null,
"dateOfMonth": null
},
"updateNoticeRule": {
"type": "dayOfWeek",
"relative": null,
"dayOfWeek": {
"noticeAmount": 1,
"noticeInterval": "week",
"dayOfWeek": 2,
"timeOfDay": "10:30:00",
"closeAmount": 10,
"closeInterval": "day"
},
"dayOfMonth": null,
"dateOfMonth": null
},
"deleteNoticeRule": {
"type": "dayOfMonth",
"relative": null,
"dayOfWeek": null,
"dayOfMonth": {
"noticeAmount": 12,
"noticeInterval": "month",
"dayOfWeek": 2,
"timeOfDay": "10:30:00",
"closeAmount": 10,
"closeInterval": "day",
"weekOfMonth": "1"
},
"dateOfMonth": null
},
"maximumNoticeRule": {
"type": "resource",
"relative": null,
"dayOfWeek": null,
"dayOfMonth": null,
"dateOfMonth": null
},
"displayColor": "#000000"
}
]
}Get Event Template #
Description
Gets an event templates by id./div>
Route
/EventTemplates/:templateId
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Response
{
"links": [],
"message": null,
"id": "template-id",
"resourceIds": [
1,
2
],
"scheduleId": 1,
"accessoryIds": [
1,
2
],
"attributeIds": [
1,
2
],
"name": "internal name",
"notes": "internal notes",
"heading": "event template heading",
"images": [
"image1.jpg"
],
"userNotes": "user facing notes",
"durationType": "resource | custom | schedule",
"duration": "1h",
"createNoticeRule": {
"type": "relative",
"relative": {
"noticeAmount": 1,
"noticeInterval": "day"
},
"dayOfWeek": null,
"dayOfMonth": null,
"dateOfMonth": null
},
"updateNoticeRule": {
"type": "dayOfWeek",
"relative": null,
"dayOfWeek": {
"noticeAmount": 1,
"noticeInterval": "week",
"dayOfWeek": 2,
"timeOfDay": "10:30:00",
"closeAmount": 10,
"closeInterval": "day"
},
"dayOfMonth": null,
"dateOfMonth": null
},
"deleteNoticeRule": {
"type": "dayOfMonth",
"relative": null,
"dayOfWeek": null,
"dayOfMonth": {
"noticeAmount": 12,
"noticeInterval": "month",
"dayOfWeek": 2,
"timeOfDay": "10:30:00",
"closeAmount": 10,
"closeInterval": "day",
"weekOfMonth": "1"
},
"dateOfMonth": null
},
"maximumNoticeRule": {
"type": "resource",
"relative": null,
"dayOfWeek": null,
"dayOfMonth": null,
"dateOfMonth": null
},
"displayColor": "#000000"
}
Powered by BetterDocs