1. Home / Web Services API Version 7.5 / GetSubscribers

GetSubscribers

Returns the subscriber list of the document or folder in the specified path.

Syntax

Visual Basic (declaration) 
Public Function GetSubscribers( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String) as XmlNode

C# (declaration) 
public XmlNode GetSubscribers( 
	string AuthenticationTicket,
	string Path)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string The path of a document or a folder that subscribers to be returned.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the subscribers has been retrived successfully like the xml below.
if success attribute is "false", the error attribute indicates the encountered error.

<response success="TRUE" error="">
  <subscribers>
    <usersubscriber>
      <userid>10119</userid>
      <username>adamb</username>
      <firstname>Adam</firstname>
      <lastname>Boeve</lastname>
      <email>adamb@inforouter.com</email>
      <emailtype />
      <language />
      <attachdocumenttoemail>FALSE</attachdocumenttoemail>
      <userstatus>1</userstatus>
      <on_read>TRUE</on_read>
      <on_read>TRUE</on_read>
      <on_update>TRUE</on_update>
      <on_checkout>TRUE</on_checkout>
      <on_approve>FALSE</on_approve>
      <on_reject>FALSE</on_reject>
      <on_comment>TRUE</on_comment>
      <on_move>FALSE</on_move>
      <on_delete>FALSE</on_delete>
      <on_checkin>FALSE</on_checkin>
      <on_newdoc>FALSE</on_newdoc>
    </usersubscriber>
    <usersubscriber>
      <userid>10243</userid>
      <username>diannaf</username>

      <firstname>Dianna</firstname>
      <lastname>Finch</lastname>
      <email>diannaf@inforouter.com</email>
      <emailtype>HTML</emailtype>
      <language />
      <attachdocumenttoemail>FALSE</attachdocumenttoemail>

      <userstatus>1</userstatus>
      <on_read>TRUE</on_read>
      <on_read>TRUE</on_read>
      <on_update>TRUE</on_update>
      <on_checkout>TRUE</on_checkout>
      <on_approve>FALSE</on_approve>

      <on_reject>FALSE</on_reject>
      <on_comment>TRUE</on_comment>
      <on_move>FALSE</on_move>
      <on_delete>FALSE</on_delete>
      <on_checkin>FALSE</on_checkin>
      <on_newdoc>FALSE</on_newdoc>
    </usersubscriber>
  </subscribers>
</response>

Remarks

The caller must have at least "Read" permission.

See Also