Spaces

Here are examples of XML output for API calls to the various space resources.

Retrieve all Spaces -> /spaces

<?xml version="1.0" encoding="UTF-8"?>
<spaces type="array">
  <space>
    <id>employees</id>
    <title>Employee Stuff</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/employees</url>
  </space>
  <space>
    <id>562</id>
    <title>Internal Stuff</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/562</url>
  </space>
  <space>
    <id>medianotes</id>
    <title>MediaNotes</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/medianotes</url>
  </space>
  <space>
    <id>screensteps</id>
    <title>ScreenSteps</title>
    <protected>false</protected>
    <url>http://help.screensteps.com</url>
  </space>
  <space>
    <id>screenstepslive</id>
    <title>ScreenSteps Live</title>
    <protected>false</protected>
    <url>http://bmls.screenstepslive.com/spaces/screenstepslive</url>
  </space>
</spaces>

Retrieve a Single Space -> /spaces/#{space_id}

<?xml version="1.0" encoding="UTF-8"?>
<space>
  <id>720</id>
  <title>Employee Stuff</title>
  <permalink>employees</permalink>
  <message></message>
  <description></description>
  <protected>true</protected>
  <assets type="array">
    <asset>
      <title>Employee Stuff</title>
      <id>employee_stuff</id>
      <type>Bucket</type>
      <asset_type>Bucket</asset_type>
      <hidden>false</hidden>
      <url>http://bmls.screenstepslive.com/spaces/employees/buckets/employee_stuff</url>
    </asset>
    <asset>
      <title>Working With Highrise</title>
      <id>highrise</id>
      <type>Manual</type>
      <asset_type>Manual</asset_type>
      <hidden>false</hidden>
      <url>http://bmls.screenstepslive.com/spaces/employees/manuals/highrise</url>
    </asset>
  </assets>
</space>

Search a Single Space -> /spaces/#{space_id}/searches?text=#{search_string}

<?xml version="1.0" encoding="UTF-8"?>
<lessons type="array">
  <lesson>
    <title>Using the Capture Tool</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2385</url>
    <description>&lt;p&gt;Shows you how to use the capture tool.&lt;/p&gt;</description>
    <id type="integer">2385</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using the Capture Palette</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2386</url>
    <description>&lt;p&gt;Learn how to use the Capture Palette in ScreenSteps to quickly get screen shots.  The Capture Palette can float on top of other applications while you work.  Just click the capture icon to capture an image and add it to a ScreenSteps lesson.&lt;/p&gt;</description>
    <id type="integer">2386</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Creating a Lesson</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How to Capture a Menu</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/8935</url>
    <description>&lt;p&gt;There are a variety of ways you can capture menu items. This is one solution that will work on Mac or Windows.&lt;/p&gt;</description>
    <id type="integer">8935</id>
    <tags type="array">
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Capturing Images Using the Global Key Command (Mac only)</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2384</url>
    <description>&lt;p&gt;As of version 2.0.3 you can now assign a global key command to capture images into ScreenSteps.  This means that you no longer have to use the Clipboard Recorder unless you have a specific screen capture utility you want to interface with.  Currently this feature is only available for Mac OS X.&lt;/p&gt;</description>
    <id type="integer">2384</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using SnagIt with ScreenSteps</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2389</url>
    <description>&lt;p&gt;Learn how to set SnagIt to output to the system clipboard.  You can then turn on the Clipboard Recorder in ScreenSteps and use SnagIt to capture images for your ScreenSteps lessons.&lt;/p&gt;</description>
    <id type="integer">2389</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>SnagIt</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Creating a Lesson</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2380</url>
    <description>&lt;p&gt;Learn how to create a lesson using ScreenSteps 2.&lt;/p&gt;</description>
    <id type="integer">2380</id>
    <tags type="array">
      <tag>
        <name>Getting Started</name>
      </tag>
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>2.5</name>
      </tag>
      <tag>
        <name>Creating a Lesson</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using the Clipboard Recorder</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2387</url>
    <description>&lt;p&gt;Learn how to use the Clipboard Recorder.  The Clipboard Recorder will add any image that is copied to the system clipboard as a ScreenSteps step.&lt;/p&gt;</description>
    <id type="integer">2387</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Importing Images Into a Step</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2388</url>
    <description>&lt;p&gt;This lesson will show you how to import images that you already have saved on your hard drive into a step.  We know that this workflow isn't optimal right now and will be improving this in a future release of ScreenSteps.&lt;/p&gt;</description>
    <id type="integer">2388</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Dragging and Dropping Images Onto Lessons</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2390</url>
    <description>&lt;p&gt;This lesson will show you how to drag single or multiple images onto a lesson.  This can be a quick way to create steps if you already have existing images you would like to use.&lt;/p&gt;</description>
    <id type="integer">2390</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Image Tools</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2396</url>
    <description>&lt;p&gt;Learn what those icons are next to images in ScreenSteps.&lt;/p&gt;</description>
    <id type="integer">2396</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using Split Step</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2423</url>
    <description>&lt;p&gt;See how you can take traditional, text based documentation and turn it into something visual in just a couple of minutes.  &lt;/p&gt;</description>
    <id type="integer">2423</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
</lessons>

Comments (0)

Add your comment

E-Mail me when someone replies to this comment