Web Service APIs

The table below is an overview of the available APIs for Report2Web. Each individual API is discussed in detail within this chapter.

API Name	Description
wsSecurity.wsdl	Facilitates basic administrative functions
rwSDK.wsdl	Alternate methods for managing Content Access

wsSecurity.wsdl

logout()

Usage

Used by portals to decrement a user’s portal status count. Typically, this is called after the user has retrieved a needed document so that the user connection is not held ‘open’ while viewing the document outside of Report2Web.

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

Return Value

Boolean (1 = successful logout, 0 = unable to logout specified user)

authorize()

Usage

Used by portals to validate that a user can login and if so increments portal status count, consuming a user license.

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

Return Value

Boolean (1 = successful authorization, 0 = unable to authorize user)

setPermission()

Usage

Allows an authorized user to set Content Access permissions for one or more users.

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

- com.redwood.wachabe.webservices.types.User[]

- com.redwood.wachabe.webservices.types.Folder

- permission

Return Value

Boolean (1 = success, 0 = failure)

removePermissions()

Usage

Allows an authorized user to remove Content Access for one or more users.

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

- com.redwood.wachabe.webservices.types.User[]

- com.redwood.wachabe.webservices.types.Folder

- permission (will always be applied to all New sub-folders)

Return Value

Boolean (1 = success, 0 = failure)

setUserRole()

Usage

Allows an authorized user to set a role for one or more users (no groups).

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

- com.redwood.wachabe.webservices.types.User[]

- rolename

Return Value

Boolean (1 = success, 0 = failure)

addUsers()

Usage

Allows an authorized user to add one or more users to Report2Web with a predefined role.

Parameters

- com.redwood.wachabe.webservices.types.User

- application id

- com.redwood.wachabe.webservices.types.User[]

- rolename

Return Value

Boolean (1 = success, 0 = failure)

getAvailableMembers()

Usage

Allows an authorized user to retrieve members by type, where a user is of type 1 and a group is of type 2.

Parameters

- com.redwood.wachabe.webservices.types.User

- membertype

- com.redwood.wachabe.webservices.types.User[]

- rolename

Return Value

Boolean (1 = success, 0 = failure)

getCatalogProperty()

Usage

Allows an authorized user to retrieve catalog properties for a given catalog.

Parameters

- com.redwood.wachabe.webservices.types.User

- catalogname

- property key

Return Value

String

resetPassword()

Usage

Allows an authorized user to reset a user’s password to a known value and, optionally, force the user to change their password at next login. This is only available for Application members, and cannot be used to change the password of a Corp LDAP member.

Parameters

- com.redwood.wachabe.webservices.types.User

- memberId (login name)

- newPassword

- forceChangeNextLogin (Boolean flag)

Return Value

String

rwSDK.wsdl

The rwSDK.wsdl can be used to perform common batch load and unload functions rather than directly making the changes within the Report2Web interface. The following tasks can be accomplished via rwSDK:

Add Group Membership
Add Member
Add Subscription
Create Folder
Create Member
Delete Member
Delete Subscription
Move Folder
Remove Member
Set Content Access

The rwSDK.wsdl can be accessed from the following URL:

http://<host_name>:<port>/r2w/services/rwSDK?wsdl

addGroupMembership()

addGroupMembership can be used to add members that already exist in Report2Web (corporate or local) to a local Report2Web group.

Field	Description
Usage	Adds users to groups.
Parameters	AddGroupMembershipRequest (authorizedmember, targetgroup, member[ ])
Return Value	AddGroupMembershipResponse (result, failedmemberships[ ])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addGroupMembershipRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:name>target_group_name</rwt:name>

<rwt:domain>local</rwt:domain>

</targetGroup>

<rwt:name>member_to_be_added_to_target_group</rwt:name>

<rwt:domain>domain_of_the_member</rwt:domain>

</member>

</addMember>

</rws:addGroupMembershipRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<targetGroup>	<rwt:name>	Name of the Report2Web group to which users should be added.
<targetGroup>	<rwt:domain>	Must be local.
<member>	<rwt:name>	Name of Report2Web member to be added to the target group.
<member>	<rwt:domain>	Domain associated with the member to be added to the target group.

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addGroupMembershipRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>test</rwt:name>

<rwt:domain>local</rwt:domain>

</targetGroup>

<rwt:name>joeuser</rwt:name>

<rwt:domain>local</rwt:domain>

</member>

</addMember>

</rws:addGroupMembershipRequest>

</soapenv:Body>

</soapenv:Envelope>

addMember()

addMember can be used to add corporate users and groups to an existing Report2Web Catalog.

Usage	Adds users to groups.
Parameters	memberRequest
Return Value	MemberResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:name>CORP_member_name_to_be_added</rwt:name

<rwt:type>user_or_group</rwt:type>

</member>

<role>

</role>

</addMember>

</rws:addMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<addMember>	<rwt:name>	Name of corporate member to be added to the selected Report2Web Catalog.
<addMember>	<rwt:type>	Specifies whether the targeted member is a user or a group.
<role>	<name>	Specifies the name of the role (as defined within Report2Web) that should be associated with the member.

Sample Usage – Add User

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addMemberRequest>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>joeuser</rwt:name>

<rwt:type>user</rwt:type>

</member>

<role>

<name>SuperAdministrator</name>

</role>

</addMember>

</rws:addMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

Sample Usage – Add Group

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>SG_Support</rwt:name>

<rwt:type>group</rwt:type> </member>

<role>

<name>SuperAdministrator</name>

</role>

</addMember>

</rws:addMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

addSubscription()

addSubscription can be used to add an email subscription to an existing Report2Web member.

Usage	Adds subscription to folder(s) or document(s)
Parameters	AddSubscriptionRequest (authorizedmember, subscription[ ])
Return Value	AddSubscriptionResponse (result, failedsubscriptions[ ])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addSubscriptionRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:id>-1</rwt:id>

<rwt:attachmentTypeId>include_as_id</rwt:attachmentTypeId>

<rwt:creator>

<rwt:name>creator_member_name</rwt:name>

<rwt:domain>creator_member_domain</rwt:domain

</rwt:creator>

<rwt:folder>

<rwt:id>folder_id</rwt:id

</rwt:folder>

<rwt:formatTypeId>format_id</rwt:formatTypeId>

<rwt:includeSubfolders>to_include_subfolders</rwt:includeSubfolders>

<rwt:owner>

<rwt:name>owner_member_name</rwt:name

<rwt:domain>owner_member_domain</rwt:domain

</rwt:owner>

<rwt:publicationId>publication_id</rwt:publicationId>

<rwt:templateName>template_name</rwt:templateName>

<rwt:triggerTypeId>trigger_id</rwt:triggerTypeId>

</subscription>

</rws:addSubscriptionRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Subscriptions.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<subscription>	<rwt:id>	This value must be -1.
<subscription>	<rwt:attachmentTypeId>	Specifies the type of subscription. Valid values are: 1 (link), 2 (attachment) and 3 (link and attachment)
<subscription>	<rwt:creator> <rwt:name>	Specifies the member name to be associated with the creator of the subscription.
<subscription>	<rwt:creator> <rwt:domain>	Specifies the domain associated with the targeted subscription creator.
<subscription>	<rwt:folder> <rwt:id>	Specifies the folder id associated with the subscription. Folder id’s can be found within the folder table for each Report2Web Catalog.
<subscription>	<rwt:formatTypeId>	Specifies which file formats should be associated with the subscription. Use the value of 16 to specify ‘any’ as the format type.
<subscription>	<rwt:includeSubfolders>	For a folder-based subscription, specifies whether the subscriptions should also apply to subfolders. Use a value of 1 to include subfolders and 0 to exclude subfolders.
<subscription>	<rwt:owner> <rwt:name>	Specifies the member name to be associated with the owner of the subscription.
<subscription>	<rwt:owner> <rwt:domain>	Specifies the domain to be associated with the targeted subscription owner.
<subscription>	<rwt:publicationId>	When creating a subscription based on a publication rather than a folder, this element specifies the publication id. The publication id can be found by calling the doSearch API and extracting the publication id or by directly querying the database for the targeted catalog. If not creating a subscription based on the publication, this value should be 0.
<subscription>	<rwt:templateName>	Indicates which email template will be used when sending the subscription. If the <rwt:triggerTypeID> is 1, valid values are “Report Published (HTML)” and “Report Published (text).” If the <rwt:triggerTypeiD> is 2, valid values are “Daily Digest (HTML)” and “Daily Digest (text).”
<subscription>	<rwt:triggerTypeID>	Indicates the type of subscription that will be created. A value of 1 specifies that the subscription will be setup as “when published” while a value of 2 indicates the subscription will be setup as a “daily digest.”

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:addSubscriptionRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:id>-1</rwt:id>

<rwt:attachmentTypeId>1</rwt:attachmentTypeId>

<rwt:creator>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:domain>local</rwt:domain>

</rwt:creator>

<rwt:folder>

<rwt:id>15</rwt:id>

</rwt:folder>

<rwt:formatTypeId>16</rwt:formatTypeId>

<rwt:includeSubfolders>1</rwt:includeSubfolders>

<rwt:owner>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:domain>local</rwt:domain>

</rwt:owner>

<rwt:publicationId>0</rwt:publicationId>

<rwt:templateName>Daily Digest (HTML)</rwt:templateName>

<rwt:triggerTypeId>2</rwt:triggerTypeId>

</subscription>

</rws:addSubscriptionRequest>

</soapenv:Body>

</soapenv:Envelope>

createFolder()

createFolder can be used to load folders into an existing Report2Web Catalog.

Usage	Creates new folders in the targeted catalog.
Parameters	createFolderRequest
Return Value	CreateFolderResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:createFolderRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<folders>folder_path</folders>

</rws:createFolderRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Create Folders.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<subscription>	<rwt:id>	This value must be -1.
<folders>		Specifies the folder (or folder path) to be created. Folders to be created at the root of the Catalog should be preceded with the “/” character. Additional subfolders in a folder path should also be separated by the “/” character. Examples: /Accounting Reports /Sales Reports/By Region

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:createFolderRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<folders>/test create folders/and a subfolder</folders>

</rws:createFolderRequest>

</soapenv:Body>

</soapenv:Envelope>

createMember()

createMember can be used to create local application users within an existing Report2Web Catalog.

Usage	Creates new application level users in the targeted catalog.
Parameters	createMemberRequest
Return Value	CreateMemberResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:createMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:id>-1</rwt:id>

<rwt:name>member_name</rwt:name>

<rwt:password>password</rwt:password>

<rwt:fullname>full_name</rwt:fullname>

<rwt:email>email</rwt:email>

<rwt:type>user_or_group</rwt:type>

<rwt:domain>local</rwt:domain>

</member>

<role>

<rwt:name>role_name</rwt:name>

</role>

</createMember>

</rws:createMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<createMember>	<rwt:id>	This value must be -1.
<createMember>	<rwt:name>	Name of member (group or user) to be created. In the case of a user, this is also referred to as the User ID.
<createMember>	<rwt:password>	If creating a user, specifies the Base64 encoded password associated with the targeted user name. If creating a group, this value should be omitted.
<createMember>	<rwt:fullname>	If creating a user, specifies the full name to be associated with the user. As an example, while the value specified for <rwt:name> is be juser, the <rwt:fullname> value might be Joe User. If creating a group, this value should be the same as the value specified in <rwt:name>.
<createMember>	<rwt:email>	If creating a user, specifies the email address to be associated with the user. If creating a group, this value should be omitted.
<createMember>	<rwt:type>	Specifies whether the member being created is a user or group.
<createMember>	<rwt:domain>	This value must be local.
<role>	<rwt:name>	Specifies the name of the role (as defined within Report2Web) that should be associated with the member

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:createMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:id>-1</rwt:id>

<rwt:name>myuser2</rwt:name>

<rwt:password>cGFzc3dvcmQ=</rwt:password>

<rwt:fullname>my user2</rwt:fullname>

<rwt:email>myuser@user.com</rwt:email>

<rwt:type>user</rwt:type>

<rwt:domain>local</rwt:domain>

</member>

<role>

<rwt:name>SuperAdministrator</rwt:name>

</role>

</createMember>

</rws:createMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

deleteMember()

Usage	Deletes an application user from the system.
Parameters	DeleteMemberRequest(authorizedmember, removeMember[])
Return Value	DeleteMemberResponse(result, failures[])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:deleteMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:name>membername</rwt:name>

<rwt:domain>member_domain</rwt:domain>

</member>

</deleteMember>

</rws:deleteMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

Where,

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<deleteMember>	<member> <rwt:name>	Name of the member that is targeted for deletion.
<deleteMember>	<member> <rwt:domain>	Domain name associated with the member that is targeted for deletion. If the targeted member is a Report2Web application member, this value must be local.

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:deleteMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>myuser1</rwt:name> <rwt:domain>local</rwt:domain>

</member>

</deleteMember>

</rws:deleteMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

deleteSubscription()

Usage	Delete subscription for folder(s) or document(s).
Parameters	DeleteSubscriptionRequest (authorizedmember, subscription[ ])
Return Value	DeleteSubscriptionResponse (result, failedsubscriptions[ ])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:deleteSubscriptionRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:id>id</rwt:id>

</subscription>

</rws:deleteSubscriptionRequest>

</soapenv:Body>

</soapenv:Envelope>

Where,

Parent Element	Child Element	Value
Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Subscriptions.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<subscription>	<rwt:id>	Database id of the subscription that is to be deleted. The Subscription ID can be found within the subscription table of each Report2Web Catalog.

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:deleteSubscriptionRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:id>3</rwt:id>

</subscription>

</rws:deleteSubscriptionRequest>

</soapenv:Body>

</soapenv:Envelope>

moveFolder()

moveFolder can be used to move an existing folder (and its contents) to a new location within the folder tree.

Usage	Move (relocate) a folder to a new location in the tree (same catalog only).
Parameters	MoveFolderRequest (authorizedmember, applicationId, autoUpdate, destinationFolderPath, srcFolderPath)
Return Value	MoveFolderResponse (result, failures[ ])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:moveFolderRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<srcFolderPath>source_folder_path</srcFolderPath>

<destFolderPath>destination_folder_path</destFolderPath>

</rws:moveFolderRequest>

</soapenv:Body>

</soapenv:Envelope>

Where,

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Create Folders.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<srcFolderPath>		Specifies the path to the folder that is to be moved (source folder).
<destFolderPath>		Specifies the destination path where the source folder is to be placed.
<autoUpdate>		This value is not implemented and will be ignored.
<failOnApproverConflict>		This value is not implemented and will be ignored.

Terminology

Parameter	Description	Example
SrcFolder	Name of the folder being moved	/Folder1, off the root
DestFolder	Location of the new folder after the move	/Folder2, off the root
NewFolder	Path to the newly moved folder, after the move	/Folder2/Folder1

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:moveFolderRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<srcFolderPath>/folder_to_be_moved</srcFolderPath>

<destFolderPath>/folder_moved_here</destFolderPath>

</rws:moveFolderRequest>

</soapenv:Body>

</soapenv:Envelope>

removeMember()

removeMember can be used to remove members from an existing Catalog.

Note: This does not delete the member.

Usage	Removes a member from a Catalog.
Parameters	RemoveMemberRequest(authorizedmember, removeMember[])
Return Value	RemoveMemberResponse(result, failures[])

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:removeMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:name>membername</rwt:name>

<rwt:domain>member_domain</rwt:domain>

</member>

</removeMember>

</rws:removeMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

Where:

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<removeMember>	<member> <rwt:name>	Specifies the name of the member to be removed.
<removeMember>	<member> <rwt:domain>	Specifies the domain associated with the member that is to be removed. If the targeted member is an application member, the domain must be local.

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:removeMemberRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>Morrisville</rwt:name>

<rwt:domain>rwd.lan</rwt:domain>

</member>

</removeMember>

</rws:removeMemberRequest>

</soapenv:Body>

</soapenv:Envelope>

setContentAccess()

Usage	Sets Content Access for users and groups.
Parameters	setContentAccessRequest
Return Value	SetContentAccessResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:setContentAccessRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>username</rwt:name>

<rwt:password>base64_encoded_password</rwt:password>

<rwt:domain>domain</rwt:domain>

<rwt:catalogName>catalogname</rwt:catalogName>

</authorizedMember>

<rwt:name>membername</rwt:name>

<rwt:type>user_or_group</rwt:type>

<rwt:domain>member_domain</rwt:domain>

</member>

<rwt:path>folder_path</rwt:path>

</folder>

<includeSubFolder>to_include_subfolders</includeSubFolder>

<isPropagative>to_propagate</isPropagative>

<accessPermissions>permission_level</accessPermissions>

</contentAccess>

</rws:setContentAccessRequest>

</soapenv:Body>

</soapenv:Envelope>

Where,

Parent Element	Child Element	Value
<applicationid>		This value must be RWSDK.
<authorizedMember>	<rwt:id>	This value must be -1.
<authorizedMember>	<rwt:name>	Username within Report2Web that has the authority to Manage Members.
<authorizedMember>	<rwt:password>	Base64 encoded password associated with the authorized user.
<authorizedMember>	<rwt:domain>	Domain associated with the authorized user.
<authorizedMember>	<rwt:catalogName>	Report2Web Catalog to which the authorized user belongs.
<contentAccess>	<member> <rwt:name>	Specifies the name of the member for which the content access will apply.
<contentAccess>	<member> <rwt:type>	Specifies whether the targeted member is a user or group.
<contentAccess>	<member> <rwt:domain>	Specifies the domain that the targeted member is associated with. If the targeted member is a Report2Web application level user, this value must be local.
<contentAccess>	<folder> <rwt:path>	Specifies the folder (or folder path) to which th Content Access should be applied. Targeted folders at the root of the Catalog should be preceded with the “/” character. Additional subfolders in a folder path should also be separated by the “/” character. Examples: /Accounting Reports /Sales Reports/By Region
<contentAccess>	<includeSubFolder>	Determines if the applied Content Access should also be applied to any existing subfolders. Specify a value of 1 to include subfolders and 0 to exclude subfolders
<contentAccess>	<isPropagative>	Determines if the applied Content Access should be automatically propagated to any future subfolders that are created. Specify a value of 1 to propagate Content Access and 0 to not propagate.
<contentAccess>	<accessPermissions>	Determines if the applied Content Access will be Read, Change or Full Control. Specify R for Read, C for Change and F for Full Control access.

Sample Usage

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rws="http://r2w.redwood.com/webservices/rwSDK" xmlns:rwt="http://r2w.redwood.com/services/ws/rwTypes">

<soapenv:Header/>

<soapenv:Body>

<rws:setContentAccessRequest>

<applicationId>RWSDK</applicationId>

<rwt:id>-1</rwt:id>

<rwt:name>systemsuperadmin</rwt:name>

<rwt:password>cGFzc3cwcmQ=</rwt:password>

<rwt:domain>local</rwt:domain>

<rwt:catalogName>catalog01</rwt:catalogName>

</authorizedMember>

<rwt:name>myuser</rwt:name>

<rwt:type>user</rwt:type>

<rwt:domain>local</rwt:domain>

</member>

<rwt:path>/test</rwt:path>

</folder>

</contentAccess>

</rws:setContentAccessRequest>

</soapenv:Body>

</soapenv:Envelope>