The Basics

cmd=listPeople

Parameters
Takes fIncludeActive (defaults to 1), fIncludeNormal (defaults to 1), fIncludeDeleted (defaults to 0), fIncludeCommunity (defaults to 0), fIncludeVirtual  (defaults to 0). 
Example
https://kakapo.fogbugz.com/api.asp?cmd=listPeople&token=04t6193822pekbba09nt74ninuihk2
Returns
A list of users meeting the criteria set by the parameters.

cmd=newPerson

Parameters
Requires sEmail and sFullname. Takes almost all fields that it is possible to edit through the user interface.  See parameters for details.
Example
https://kakapo.fogbugz.com/api.asp?cmd=newPerson&sEmail=jeremy%40kakapo.com&sfullname=Jeremy%20Chase&token=erd3d6kuivqds2fdd7mdvj4knb8s3f
Returns
Details of the newly created user. 

cmd=viewPerson

Parameters
Takes only ixPerson OR sEmail.  If no parameters are supplied, the user currently logged in is returned.
Example
https://kakapo.fogbugz.com/api.asp?cmd=viewPerson&ixPerson=11&token=04t6193822pekbba09nt74ninuihk2 
Returns
The case number of the edited case.

cmd=editPerson

Parameters
Requires ixPerson. Takes almost all fields that it is possible to edit through the user interface.  See parameters for details.
Example
https://kakapo.fogbugz.com/api.asp?api.asp?cmd=editPerson&ixPerson=11&ntype=2&sLanguage=English&sEmail=elinorb%40kakapo.com&token=04t6193822pekbba09nt74ninuihk2
Returns
Updated user data.

List Existing Users (cmd=listPeople)

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

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>
 <person>
  <ixPerson>19</ixPerson>
  <sFullName>
   <![CDATA[ Jeremy Chase ]]>
  </sFullName>
  <sEmail>
   <![CDATA[ jeremy@kakapo.com ]]>
  </sEmail>
  <sPhone/>
  <fAdministrator>false</fAdministrator>
  <fCommunity>false</fCommunity>
  <fVirtual>false</fVirtual>
  <fDeleted>false</fDeleted>
  <sHomepage/>
  <sLocale>
   <![CDATA[ * ]]>
  </sLocale>
  <sLanguage>
   <![CDATA[ * ]]>
  </sLanguage>
  <sTimeZoneKey>
   <![CDATA[ * ]]>
  </sTimeZoneKey>
  <sSnippetKey>
   <![CDATA[ ` ]]>
  </sSnippetKey>
   <ixBugWorkingOn>0</ixBugWorkingOn>
  <nType>0</nType>
 </person>
</response>

Create a New User (cmd=newPerson)

URL
https://kakapo.fogbugz.com/api.asp?cmd=newPerson&sEmail=jeremy%40kakapo.com&sfullname=Jeremy%20Chase&token=erd3d6kuivqds2fdd7mdvj4knb8s3f
fogbugz.py
fb.newPerson(sEmail="jeremy@kakapo.com", sFullname="Jeremy Chase")

Parameters

  • sEmail – required
  • sFullname – required
  • nTypedefault 0
    • Set to 0 for a normal user, 1 for an administrator, 2 for a community user, and 3 for a virtual user
  • fActivedefault 1
    • Use only when creating new person
  • sPassworddefault = random
  • sLocaleoptional
  • sLanguage – optional
  • sTimeZoneKey – optional
  • sSnippetKey – optional
  • fNotify – optional
  • sPhone – optional
  • sHomepage – optional
  • fDeleted – optional
    • Set fDeleted to True to mark a user as Inactive (does not delete the user, or their history)

Possible Responses

Successful Response
XML
<response>
 <person>
  <ixPerson>19</ixPerson>
  <sFullName>
   <![CDATA[ Jeremy Chase ]]>
  </sFullName>
  <sEmail>
   <![CDATA[ jeremy@kakapo.com ]]>
  </sEmail>
  <sPhone/>
  <fAdministrator>false</fAdministrator>
  <fCommunity>false</fCommunity>
  <fVirtual>false</fVirtual>
  <fDeleted>false</fDeleted>
  <sHomepage/>
  <sLocale>
   <![CDATA[ * ]]>
  </sLocale>
  <sLanguage>
   <![CDATA[ * ]]>
  </sLanguage>
  <sTimeZoneKey>
   <![CDATA[ * ]]>
  </sTimeZoneKey>
  <sSnippetKey>
   <![CDATA[ ` ]]>
  </sSnippetKey>
   <ixBugWorkingOn>0</ixBugWorkingOn>
  <nType>0</nType>
 </person>
</response>
User Already Exists
XML
Error Code 22: ![CDATA[A user with that name already exists.]]

View a User (cmd=viewPerson)

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

Parameters

Takes only ixPerson OR sEmail. If no parameters are supplied, the user currently logged in is returned.

Possible Responses

Successful Response
XML
  <response>
    <person>
      <ixPerson>11</ixPerson>
      <sFullName>
        <![CDATA[ Elinor Bennett ]]>
      </sFullName>
      <sEmail>
        <![CDATA[ elinor@kakapo.com ]]>
      </sEmail>
      <sPhone/>
      <fAdministrator>false</fAdministrator>
      <fCommunity>false</fCommunity>
      <fVirtual>false</fVirtual>
      <fDeleted>false</fDeleted>
      <sHomepage/>
      <sLocale>
        <![CDATA[ * ]]>
      </sLocale>
      <sLanguage>
        <![CDATA[ * ]]>
      </sLanguage>
      <sTimeZoneKey>
        <![CDATA[ * ]]>
      </sTimeZoneKey>
      <sSnippetKey>
        <![CDATA[ ` ]]>
      </sSnippetKey>
      <ixBugWorkingOn>0</ixBugWorkingOn>
      <nType>0</nType>
    </person>
</response>
No Matching User
XML
</response>

Updating a User (cmd=editPerson)

URL
https://kakapo.fogbugz.com/api.asp?cmd=editPerson&ixPerson=11&ntype=2&sLanguage=English&sEmail=elinorb%40kakapo.com&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.editPerson(ixPerson=11,
        sLanguage="English",
        sEmail="elinorb@kakapi.com
        )

Parameters

  • sEmail – required
  • sFullname – required
  • nTypedefault 0
    • Set to 0 for a normal user, 1 for an administrator, 2 for a community user, and 3 for a virtual user
  • fActivedefault 1
    • Use only when creating new person
  • sPassworddefault = random
  • sLocaleoptional
  • sLanguage – optional
  • sTimeZoneKey – optional
  • sSnippetKey – optional
  • fNotify – optional
  • sPhone – optional
  • sHomepage – optional
  • fDeleted – optional
    • Set fDeleted to True to mark a user as Inactive (does not delete the user, or their history)

Possible Responses

Successful Response

The call will return the updated information for the user. The example below reflects the changes made by the example code above.

XML
<response>
  <person>
      <ixPerson>11</ixPerson>
      <sFullName>
        <![CDATA[ Elinor Bennett ]]>
      </sFullName>
      <sEmail>
        <![CDATA[ elinorb@kakapo.com ]]>
      </sEmail>
      <sPhone/>
      <fAdministrator>false</fAdministrator>
      <fCommunity>true</fCommunity>
      <fVirtual>false</fVirtual>
      <fDeleted>false</fDeleted>
      <sHomepage/>
      <sLocale>
        <![CDATA[ * ]]>
      </sLocale>
      <sLanguage>
        <![CDATA[ English ]]>
      </sLanguage>
      <sTimeZoneKey>
        <![CDATA[ * ]]>
      </sTimeZoneKey>
      <sSnippetKey>
        <![CDATA[ ` ]]>
      </sSnippetKey>
      <ixBugWorkingOn>0</ixBugWorkingOn>
      <nType>2</nType>
    </person>
</response>