GET api/holidays/byyear?year={year}

GET: api/holidays by year

Request Information

URI Parameters

Name	Description	Type	Additional information
year		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of HolidayViewModel

Name	Description	Type	Additional information
Id	Id	integer	None.
Name	Name	string	Required Max length: 50
Description	Description	string	Max length: 250
EventScheduleId	EventScheduleId	integer	None.
IsLinked	sets if this holiday is been linked to a market	boolean	None.
IsCustom	sets if the holiday is not from the api, if it was created by the users	boolean	None.
EventSchedule	The event schedule associate with this holiday	EventScheduleViewModel	Required
Type	The type of the holiday, National , Federal, Custom, etc	string	Required Max length: 100

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "eventScheduleId": 4,
    "isLinked": true,
    "isCustom": true,
    "eventSchedule": {
      "id": 1,
      "startDateTime": "2025-04-03T17:46:21.8341961-04:00",
      "endDateTime": "2025-04-03T17:46:21.8341961-04:00",
      "recurrenceRule": "sample string 4",
      "nextOccurrenceDate": "2025-04-03T17:46:21.8341961-04:00",
      "recurrenceEndDate": "2025-04-03T17:46:21.8341961-04:00",
      "previousOccurrenceDate": "2025-04-03T17:46:21.8341961-04:00",
      "isActive": true,
      "isArchived": true,
      "createdOn": "2025-04-03T17:46:21.8341961-04:00",
      "createdBy": 9,
      "modifiedOn": "2025-04-03T17:46:21.8341961-04:00",
      "modifiedBy": 1
    },
    "type": "sample string 7"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "eventScheduleId": 4,
    "isLinked": true,
    "isCustom": true,
    "eventSchedule": {
      "id": 1,
      "startDateTime": "2025-04-03T17:46:21.8341961-04:00",
      "endDateTime": "2025-04-03T17:46:21.8341961-04:00",
      "recurrenceRule": "sample string 4",
      "nextOccurrenceDate": "2025-04-03T17:46:21.8341961-04:00",
      "recurrenceEndDate": "2025-04-03T17:46:21.8341961-04:00",
      "previousOccurrenceDate": "2025-04-03T17:46:21.8341961-04:00",
      "isActive": true,
      "isArchived": true,
      "createdOn": "2025-04-03T17:46:21.8341961-04:00",
      "createdBy": 9,
      "modifiedOn": "2025-04-03T17:46:21.8341961-04:00",
      "modifiedBy": 1
    },
    "type": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfHolidayViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Holiday">
  <HolidayViewModel>
    <Description>sample string 3</Description>
    <EventSchedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <d3p1:CreatedBy>9</d3p1:CreatedBy>
      <d3p1:CreatedOn>2025-04-03T17:46:21.8341961-04:00</d3p1:CreatedOn>
      <d3p1:EndDateTime>2025-04-03T17:46:21.8341961-04:00</d3p1:EndDateTime>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsActive>true</d3p1:IsActive>
      <d3p1:IsArchived>true</d3p1:IsArchived>
      <d3p1:ModifiedBy>1</d3p1:ModifiedBy>
      <d3p1:ModifiedOn>2025-04-03T17:46:21.8341961-04:00</d3p1:ModifiedOn>
      <d3p1:NextOccurrenceDate>2025-04-03T17:46:21.8341961-04:00</d3p1:NextOccurrenceDate>
      <d3p1:PreviousOccurrenceDate>2025-04-03T17:46:21.8341961-04:00</d3p1:PreviousOccurrenceDate>
      <d3p1:StartDateTime>2025-04-03T17:46:21.8341961-04:00</d3p1:StartDateTime>
    </EventSchedule>
    <EventScheduleId>4</EventScheduleId>
    <Id>1</Id>
    <IsCustom>true</IsCustom>
    <IsLinked>true</IsLinked>
    <Name>sample string 2</Name>
    <Type>sample string 7</Type>
  </HolidayViewModel>
  <HolidayViewModel>
    <Description>sample string 3</Description>
    <EventSchedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <d3p1:CreatedBy>9</d3p1:CreatedBy>
      <d3p1:CreatedOn>2025-04-03T17:46:21.8341961-04:00</d3p1:CreatedOn>
      <d3p1:EndDateTime>2025-04-03T17:46:21.8341961-04:00</d3p1:EndDateTime>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsActive>true</d3p1:IsActive>
      <d3p1:IsArchived>true</d3p1:IsArchived>
      <d3p1:ModifiedBy>1</d3p1:ModifiedBy>
      <d3p1:ModifiedOn>2025-04-03T17:46:21.8341961-04:00</d3p1:ModifiedOn>
      <d3p1:NextOccurrenceDate>2025-04-03T17:46:21.8341961-04:00</d3p1:NextOccurrenceDate>
      <d3p1:PreviousOccurrenceDate>2025-04-03T17:46:21.8341961-04:00</d3p1:PreviousOccurrenceDate>
      <d3p1:StartDateTime>2025-04-03T17:46:21.8341961-04:00</d3p1:StartDateTime>
    </EventSchedule>
    <EventScheduleId>4</EventScheduleId>
    <Id>1</Id>
    <IsCustom>true</IsCustom>
    <IsLinked>true</IsLinked>
    <Name>sample string 2</Name>
    <Type>sample string 7</Type>
  </HolidayViewModel>
</ArrayOfHolidayViewModel>