Start Work on a Case

cmd=startWork

Parameters
Requires ixBug.
Example
https://kakapo.fogbugz.com/api.asp?cmd=startWork&ixBug=364&token=04t6193822pekbba09nt74ninuihk2
Returns
Empty response.

Examples

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

Successful Response

XML
</response>

Stop Work on All Bugs

cmd=stopWork

Parameters
None.
Example
https://kakapo.fogbugz.com/api.asp?cmd=stopWork&token=04t6193822pekbba09nt74ninuihk2
Returns
Empty response.

Examples

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

Successful Response

XML
</response>

Create a New Time Interval

cmd=newInterval

Parameters
Requires ixBug, dtStart, dtEnd.  Optionally takes ixPerson (for FogBugz administrators only). 
Example
https://kakapo.fogbugz.com/api.asp?cmd=newInterval&ixBug=5303&dtStart=2017-06-22T08:30:00Z&dtEnd=2017-06-22T09:30:00Z
&token=2lplnu75qtetm4io6leivv1j6pbv3j
Returns
Data for the newly created interval

Examples

URL
https://kakapo.fogbugz.com/api.asp?cmd=newInterval&ixBug=5303&dtStart=2017-06-22T08:30:00Z&dtEnd=2017-06-22T09:30:00Z
&token=2lplnu75qtetm4io6leivv1j6pbv3j
fogbugz.py
fb.newInterval(ixBug=5303, 
	dtStart="2017-06-22 08:30:00Z", 
	dtEnd="2017-06-22 09:30:00Z")

Successful Response

For the sake of space, the sample below includes only one user. This command will return the details for all users between the <person> tags.

XML
<response>
	<interval>
		<ixInterval>15</ixInterval>
		<ixBug>5303</ixBug>
		<ixPerson>2</ixPerson>
		<dtStart>2017-06-22 08:30:00Z</dtStart>
		<dtEnd>2017-06-22 09:30:00Z</dtEnd>
	</interval>
</response>

View a Time Interval

cmd=viewInterval

Parameters
Requires ixInterval.
Example
https://kakapo.fogbugz.com/api.asp?cmd=viewInterval&ixInterval=15&token=04t6193822pekbba09nt74ninuihk2
Returns
Data for selected interval.

Examples

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

Successful Response

XML
<response>
	<interval>
		<ixInterval>15</ixInterval>
		<ixBug>5303</ixBug>
		<ixPerson>2</ixPerson>
		<dtStart>2017-06-22 08:30:00Z</dtStart>
		<dtEnd>2017-06-22 09:30:00Z</dtEnd>
	</interval>
</response>

List Time Intervals

cmd=listIntervals

Parameters
Optionally takes ixPerson, ixBug, and dtStart and dtEnd.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listIntervals&ixBug=364&token=04t6193822pekbba09nt74ninuihk2
Returns
Interval data for selected parameters.

Parameters

  • ixPerson – optional
    • Specifies which user’s intervals should be returned. If omitted, list intervals for the logged on user. If set to 1, list intervals for all users. Note that you must be an administrator to see time interval information for users other than the logged on user.
  • ixBug – optional
    • Specifies that only intervals associated with this bug should be returned.
  • dtStart, dtEnd – optional
    • If dtStart and/or dtEnd are supplied, listIntervals will return intervals whose start date falls between dtStart and dtEnd.

Examples

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

Successful Response

XML
<response>
  <intervals>
    <interval>
      <ixInterval>11</ixInterval>
      <ixPerson>2</ixPerson>
      <ixBug>364</ixBug>
      <dtStart>2016-05-19T21:01:12Z</dtStart>
      <dtEnd>2016-05-19T21:20:54Z</dtEnd>
      <fDeleted>false</fDeleted>
      <sTitle>
        <![CDATA[ CSS Bug - Header links overlap on narrow screen ]]>
      </sTitle>
    </interval>
    <interval>
      <ixInterval>14</ixInterval>
      <ixPerson>2</ixPerson>
      <ixBug>364</ixBug>
      <dtStart>2016-05-20T19:00:00Z</dtStart>
      <dtEnd>2016-05-20T20:00:00Z</dtEnd>
      <fDeleted>false</fDeleted>
      <sTitle>
        <![CDATA[ CSS Bug - Header links overlap on narrow screen ]]>
      </sTitle>
    </interval>
    <interval>
      <ixInterval>13</ixInterval>
      <ixPerson>2</ixPerson>
      <ixBug>364</ixBug>
      <dtStart>2016-05-23T14:52:58Z</dtStart>
      <dtEnd>2016-05-23T14:55:08Z</dtEnd>
      <fDeleted>false</fDeleted>
      <sTitle>
        <![CDATA[ CSS Bug - Header links overlap on narrow screen ]]>
      </sTitle>
    </interval>
  </intervals>
</response>

Edit an Existing Time Interval

cmd=editInterval

Parameters
Requires ixInterval.  Optionally takes ixBug, dtStart, dtEnd.  Optionally takes ixPerson. 
Example
https://kakapo.fogbugz.com/api.asp?cmd=editInterval&ixInterval=15&dtStart=2017-06-22T010:30:00Z&dtEnd=2017-06-22T011:30:00Z
&token=2lplnu75qtetm4io6leivv1j6pbv3j
Returns
Data for the updatedinterval

Examples

URL
https://kakapo.fogbugz.com/api.asp?cmd=editInterval&ixInterval=15&dtStart=2017-06-22T010:30:00Z&dtEnd=2017-06-22T011:30:00Z
&token=2lplnu75qtetm4io6leivv1j6pbv3j
fogbugz.py
fb.editInterval(ixInterval=15,
	dtStart="2017-06-22 10:30:00Z", 
	dtEnd="2017-06-22 11:30:00Z")

Successful Response

For the sake of space, the sample below includes only one user. This command will return the details for all users between the <person> tags.

XML
<response>
	<interval>
		<ixInterval>15</ixInterval>
		<ixBug>5303</ixBug>
		<ixPerson>2</ixPerson>
		<dtStart>2017-06-22 10:30:00Z</dtStart>
		<dtEnd>2017-06-22 11:30:00Z</dtEnd>
	</interval>
</response>

Delete a Time Interval

cmd=deleteInterval

Parameters
Requires ixInterval.
Example
https://kakapo.fogbugz.com/api.asp?cmd=deleteInterval&ixInterval=15&token=04t6193822pekbba09nt74ninuihk2
Returns
Empty response.

Examples

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

Successful Response

XML
</response>