BugzScout cases can be created through both the XML API and the dedicated BugzScout API. The BugzScout API requires more information about the incoming case workflow, and is a good fit for automated crash reporting in programs. The XML API requires a valid Normal (or Administrator) login, and is a good fit for automating internal workflows. Both have very similar features.

BugzScout cases can be created and manipulated through the FogBugz XML API by passing sScoutDescription, sScoutMessage,and fScoutStopReporting to case activity commands such as cmd=new, cmd=edit, cmd=assign, cmd=reactivate and cmd=reopen. Read more about that under editing cases.

Creating a New Scout Case Using the XML API

Note: The “new” command is the same command used to open any new FogBugz case. What makes this a scout case is the choice to pass

cmd=new

Parameters
Requires sScoutDescription.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listScoutCase&sScoutDescription=scoutcasedescription&token=04t6193822pekbba09nt74ninuihk2
Returns
Takes any of the parameters that can be passed to cmd=new, but requires sScoutDescription to be a scout case.
URL

Example

https://kakapo.fogbugz.com/api.asp?cmd=new&sTitle=Scout%20Case%20Title&sScoutDescription=Scout%20Case%20Description&sEvent=Example%20stack%20trace&ixProject=4&ixArea=2&ixCategory=3&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.new(
    sTitle="Scout Case Title", 
    sScoutDescription="Scout Case Description",
    sEvent="Example stack trace"
    ixProject=4,
    ixArea=2,
    ixCategory=3)

Successful Response

XML
<response>
  <case ixBug="1005" operations="edit,assign,resolve,email,remind"/>
</response>

Finding a Scout Case Using the XML API

cmd=listScoutCase

Parameters
Requires sScoutDescription.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listScoutCase&sScoutDescription=scoutcasedescription&token=04t6193822pekbba09nt74ninuihk2
Returns
ixBug, sScoutMessage, fScoutStopReporting, sScoutDescription, and dtLastOccurence for matching scout.
URL

Example

https://kakapo.fogbugz.com/api.asp?cmd=listScoutCase&sScoutDescription=scoutcasedescription&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listScoutCase(sScoutDescription="scoutcasedescription")

Successful Response

XML
<response>
  <case ixBug="1005" operations="edit,assign,resolve,email,remind">
    <ixBug>1005</ixBug>
    <sScoutMessage/>
    <fScoutStopReporting>
      <![CDATA[ False ]]>
    </fScoutStopReporting>
    <sScoutDescription>
      <![CDATA[ Scout Case Description ]]>
    </sScoutDescription>
    <dtLastOccurrence>2016-05-19T16:53:07Z</dtLastOccurrence>
  </case>
</response>