topic Re: Inaccurate XML API Documentation in Cloud Collaboration

Inaccurate XML API Documentation

phillip.isley — Fri, 12 Aug 2016 18:43:48 GMT

Good afternoon,

I find that I'm frequently running into inaccurate documentation when trying to create proper XML requests. Is this https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/ the best and most accurate resource?

For instance, I'm currently trying to create a proper XML request for "lstrecordaccessDetailHistory as seen here https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lstrecordaccessdetailhistory, but finding that the examples are not complete. One of the elements is named "recondid" which I'm guessing should actually be "recordid". Both recondid and recordid exist though when compiling classes based off of the API Schema (10.0.0 SP4) so I'm unsure.

I'm currently trying the following request using a recordingID I know is valid:

<?xml version="1.0" encoding="utf-8"?>
<serv:message
  xmlns:history="http://www.webex.com/schemas/2002/06/service/history"
  xmlns:com="http://www.webex.com/schemas/2002/06/common"
  xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee"
  xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:use="http://www.webex.com/schemas/2002/06/service/user"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ep="http://www.webex.com/schemas/2002/06/service/ep"
  xmlns:serv="http://www.webex.com/schemas/2002/06/service">
  <serv:header>
       <serv:securityContext>
            <com:webExID>MYID</com:webExID>
            <com:password>MYPASSWORD</com:password>
            <com:siteID>MYSITEID</com:siteID>
       <com:partnerID>MYPARTNERID</com:partnerID>
       </serv:securityContext>
  </serv:header>
  <serv:body>
       <serv:bodyContent xsi:type="history:lstrecordaccessDetailHistory">
            <history:recordID>95612197</history:recordID>
            <history:listControl>
                 <serv:startFrom>0</serv:startFrom>
                 <serv:maximumNum>500</serv:maximumNum>
            </history:listControl>
       </serv:bodyContent>
  </serv:body>
</serv:message>

Please let me know if I am using the most accurate documentation at this time.

Re: Inaccurate XML API Documentation

ryanhunt — Mon, 15 Aug 2016 14:24:57 GMT

You are using the most accurate documentation, sorry but it is out of date and may contain errors.

Re: Inaccurate XML API Documentation

phillip.isley — Tue, 16 Aug 2016 13:55:03 GMT

Thanks. Would you be able to confirm for me what the appropriate XML request is for either "lstrecordaccessDetailHistory" or "lstrecordaccessHistory"? I have tried multiple variations of of both and all are failing with no record(s) found. I know the records exist since I'm already pulling a list of everything on my WebEx site.

For additional clarification, I'm trying to pull the view count and download count of the recorded meetings of our users. The two request types I mentioned look to be the correct choices, but maybe they are only for a specific section (Support Center, Training Center, etc.)

Re: Inaccurate XML API Documentation

mifierro — Thu, 18 Aug 2016 16:03:37 GMT

Greetings, Phillip! I just want to rule out one problem that a lot of people run into when using these two commands: the security level of the account being used to submit this requests. Per the documentation:

Note: Regular hosts can only retrieve the access information of their own recorded sessions, but site administrators can retrieve the access information of all the recorded sessions on their sites.

Please check the account you are using via the Web UI and ensure that it has either Site Admin access level. If it doesn't, try either giving that account Site Admin access, or run the XML API request using a different account that does have Site Admin access.

Re: Inaccurate XML API Documentation

phillip.isley — Thu, 18 Aug 2016 16:41:39 GMT

Hey Michael. Thanks for the response. I have, however, confirmed that it is a Site Admin account as I am using it for other site wide API calls. I did see the following text related to "LstrecordaccessHistory" that I thought was meaningful:

Provides the access details for a previously recorded training session

If I'm understanding this correctly, the LstrecordaccessHistory can only be used to query Training Center recordings. If so, then I don't know if there is an API that will allow me to look at view and download counts for individual user recorded meetings from the Meeting Center.

Re: Inaccurate XML API Documentation

mifierro — Mon, 29 Aug 2016 22:55:25 GMT

Hello again! This seems to be correct, but can you try running the below request, which should give a list of all recordings available:

<body>

<bodyContent

xsi:type="java:com.webex.service.binding.ep.LstRecording">

</listControl>

</bodyContent>

</body>

Once you have a list from there, run GetRecordingInfo on one of the returned values from the above request:

<body>

<recordingID>xxxxxx</recordingID>

</bodyContent>

</body>

And make sure that this returns information for the recordingID.