The API commands listed here are new as of FogBugz version 8.17.59.

List All Site Holidays

cmd=listAllSiteHolidays

Parameters
None.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listAllSiteHolidays&token=04t6193822pekbba09nt74ninuihk2
Returns
Data for all site wide holidays.

Get Holiday by ID

cmd=getHolidayByID

Parameters
Requires ixHoliday.
Example
https://kakapo.fogbugz.com/api.asp?cmd=getHolidayById&ixHoliday=3&token=04t6193822pekbba09nt74ninuihk2
Returns
Data for selected holiday.

List Upcoming Holidays

cmd=listUpcomingHolidays

Parameters
Requires ixPerson.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listUpcomingHolidays&ixPerson=3&token=04t6193822pekbba09nt74ninuihk2
Returns
Upcoming holidays for the selected user.

Create a New Holiday

cmd=newHoliday

Parameters
Requires sHoliday, ixPerson, dtHoliday, and dtHolidayEnd.
Example
hthttps://kakapo.fogbugz.com/api.asp?cmd=newHoliday&sHoliday=Daughter%27s%20Graduation&ixPerson=2&dtHoliday=2017-06-23T00:00:00Z&dtHolidayEnd=2017-06-23T23:59:00Z&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
Data for newly created holiday.

Edit an Existing Holiday

cmd=editHoliday

Parameters
Requires ixHoliday.  Optionally takes sHoliday, ixPerson, dtHoliday, and dtHolidayEnd.
Example
https://kakapo.fogbugz.com/api.asp?cmd=editHoliday&ixHoliday=4&dtHoliday=2017-06-22T00:00:00Z&dtHolidayEnd=2017-06-22T23:59:00Z&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
Data for revised holiday.

Delete a Holiday

cmd=deleteHoliday

Parameters
Requires ixHoliday.
Example
https://kakapo.fogbugz.com/api.asp?cmd=deleteHoliday&ixHoliday=4&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
Empty response

List All Site Holidays (cmd=listAllSiteHolidays)

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listAllSiteHolidays&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listAllSiteHolidays()

Successful Response

XML
<response>
  <holidays>
    <holiday>
      <ixHoliday>3</ixHoliday>
      <ixPerson>0</ixPerson>
      <sHoliday>
        <![CDATA[ Grace Hopper's Birthday ]]>
      </sHoliday>
      <dtHoliday>2017-12-09T00:00:00Z</dtHoliday>
      <dtHolidayEnd>2017-12-09T23:59:00Z</dtHolidayEnd>
    </holiday>
  </holidays>
</response>

Get Holiday By ID (cmd=getHolidayByID)

Parameters

  • ixHoliday
    • The ID of the holiday you’d like to view. If API token does not belong to an administrator, API will return an insufficient permissions error if the holiday doesn’t belong to the logged in user.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=getHolidayById&ixHoliday=3&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.getHolidayByID(ixHoliday=3)

Successful Response

XML
<response>
  <holidays>
    <holiday>
      <ixHoliday>3</ixHoliday>
      <ixPerson>0</ixPerson>
      <sHoliday>
        <![CDATA[ Grace Hopper's Birthday ]]>
      </sHoliday>
      <dtHoliday>2017-12-09T00:00:00Z</dtHoliday>
      <dtHolidayEnd>2017-12-09T23:59:00Z</dtHolidayEnd>
    </holiday>
  </holidays>
</response>

List Upcoming Holidays (cmd=listUpcomingHolidays)

Parameters

  • ixPerson
    • The ID of the Person whose holidays you’d like to retrieve.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listUpcomingHolidays&ixPerson=3&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listUpcomingHolidays(ixPerson=3)

Successful Response

XML
<response>
  <holidays>
    <holiday>
      <ixHoliday>3</ixHoliday>
      <ixPerson>0</ixPerson>
      <sHoliday>
        <![CDATA[ Family Vacation ]]>
      </sHoliday>
      <dtHoliday>2017-12-09T00:00:00Z</dtHoliday>
      <dtHolidayEnd>2017-12-15T23:59:00Z</dtHolidayEnd>
    </holiday>
  </holidays>
</response>

Create a New Holiday (cmd=newHoliday)

Parameters

  • ixPerson
    • The person for whom you’d like to create a new holiday.
  • dtHoliday
    • Holiday start date (UTC)
  • dtHolidayEnd
    • Holiday end date (UTC)

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=newHoliday&sHoliday=Daughter%27s%20Graduation&ixPerson=2&dtHoliday=2017-06-23T00:00:00Z&dtHolidayEnd=2017-06-23T23:59:00Z&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.newHoliday(sHoliday="Daughter's Graduation", ixPerson=2, dtHoliday="2017-06-23T00:00:00Z", dtHolidayEnd="2017-06-23T23:59:00Z")

Successful Response

XML
<response>
  <holiday>
    <sHoliday>
      <![CDATA[ Daughter's Graduation ]]>
    </sHoliday>
    <ixHoliday>4</ixHoliday>
    <ixPerson>2</ixPerson>
    <dtHoliday>2017-06-23T00:00:00Z</dtHoliday>
    <dtHolidayEnd>2017-06-23T23:59:00Z</dtHolidayEnd>
  </holiday>
</response>

Edit an Existing Holiday (cmd=editHoliday)

Parameters

  • ixHoliday Required
    • The ID of the holiday you’d like to revise.
  • ixPerson Optional
    • The person for whom you’d like to create a new holiday.
  • dtHoliday Optional
    • Holiday start date (UTC)
  • dtHolidayEnd Optional
    • Holiday end date (UTC)

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=editHoliday&ixHoliday=4&dtHoliday=2017-06-22T00:00:00Z&dtHolidayEnd=2017-06-22T23:59:00Z&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.editHoliday(ixHoliday=4, dtHoliday="2017-06-22T00:00:00Z", dtHolidayEnd="2017-06-22T23:59:00Z")

Successful Response

XML
<response>
  <holiday>
    <sHoliday>
      <![CDATA[ Daughter's Graduation ]]>
    </sHoliday>
    <ixHoliday>4</ixHoliday>
    <ixPerson>2</ixPerson>
    <dtHoliday>2017-06-22T00:00:00Z</dtHoliday>
    <dtHolidayEnd>2017-06-22T23:59:00Z</dtHolidayEnd>
  </holiday>
</response>

Delete a Holiday (cmd=deleteHoliday)

Parameters

  • ixHoliday Required
    • The ID of the holiday you’d like to delete.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=deleteHoliday&ixHoliday=4&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.deleteHoliday(ixHoliday=4)

Successful Response

XML
</response>