Inviting Users to View a Content Item

You can invite a user to view a content item with the inviteUsersToContentItem method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
contentItemId (required) string ID of the content item that you want to invite users to.
users (optional) string[] An array of user IDs, who will be invited to view the content item.
groups (optional) string[] An array of group IDs, which members will be invited to view the content item.
emails (optional) string[] An array of e-mail addresses to send invitations to (for public content only).
invitationMessage (optional) string Invitation text added to the e-mail.
autoAddPermissions (optional, default: true) bool If true and a user/group has no permissions to view a given content item, these permissions will be added automatically.

Return Value

After the request has been completed, the system returns an object with the following properties:

Parameter Type Description
success bool True, if the invitations has been sent successfully.
usersWithoutPermission string[] An array of user IDs, who have no permissions to view a given content item.
usersWithoutPermission string[] An array of group IDs, which members have no permissions to view a given content item.

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InviteUsersToContentItemRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
      <ContentItemId>1234</ContentItemId>
      <Users>
        <id>1</id>
        <id>2</id>
      </Users>
      <Groups>
        <id>1</id>
        <id>2</id>
      </Groups>
      <Emails>
        <Email>user1@email.com</Email>
        <Email>user2@email.com</Email>
      </Emails>
      <InvitationMessage>Invitation Message</InvitationMessage>
    </InviteUsersToContentItemRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InviteUsersToContentItemResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>True</Success>
    </InviteUsersToContentItemResult>
  </soap:Body>
</soap:Envelope>