Sites API Output

This article contains information on the V1 XML API which has been deprecated. For docs on the V2 JSON API please see here:

http://help.screensteps.com/m/screenstepslive-api/c/182738

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

Important: For legacy reasons sites will be referred to as "spaces" in the xml that is returned. Spaces are synonymous with sites.

Example calls and responses:

Retrieve all sites -> /s

<?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 site -> /s/#{site_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>

Tags for a site -> /s/#{space_id}/tags?tag=(tag_name}

<?xml version="1.0" encoding="UTF-8"?>
<lessons type="array">
  <lesson>
    <title>How do I Permanently Delete a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2309</url>
    <id type="integer">2309</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Set the Status of a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2310</url>
    <id type="integer">2310</id>
    <description>&lt;p&gt;You can use lesson status to track the progress of a lesson from creation to review to approval. This setting is only to help you with your workflow. It does not affect how the lesson is displayed to the end user.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Status</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Enable/Disable Comments for a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2311</url>
    <id type="integer">2311</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Respond to Comments on a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2312</url>
    <id type="integer">2312</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Subscribe/Unsubscribe to Comments via Email for a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2313</url>
    <id type="integer">2313</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Delete a Comment?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2315</url>
    <id type="integer">2315</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Share the URL for a Lesson From the Administration Area?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/3517</url>
    <id type="integer">3517</id>
    <description>&lt;p&gt;Many times you will want to send the url for a lesson to customer or other user.  This lesson will show you how to easily get the urls for those lessons from the administration area.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Manuals</name>
      </tag>
      <tag>
        <name>Spaces</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Add Lesson Content</title>
    <url>http://help.bluemangolearning.com/m/customer_support_site/l/4248</url>
    <id type="integer">4248</id>
    <description>&lt;p&gt;Now it is time to go back and add some content to the lessons we created. ScreenSteps makes this really fast. &lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Methodology</name>
      </tag>
    </tags>
    <asset>
      <title>Creating a ScreenSteps Live Support Site</title>
      <type>Manual</type>
      <id>customer_support_site</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Download a Lesson to My ScreenSteps Library From ScreenSteps Live?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/16630</url>
    <id type="integer">16630</id>
    <description>&lt;p&gt;All editing of lesson content is done in the ScreenSteps Desktop software. &lt;/p&gt;


&lt;p&gt;If the lesson is already in your lesson library then you can just re-upload it. If it is not then follow the directions below to download the lesson into your library.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
</lessons>

0 Comments

Add your comment

E-Mail me when someone replies to this comment