Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
contentItemId (required)stringID of the content item that you want to invite users to.
users (optional)string[]An array Array of user IDs , of the users who will be invited to view the content item.
groups (optional)string[]An array Array of group IDs , which members will be invited to view the content item.
emails (optional)string[]An array of e-mail Array of email addresses to send invitations to (available for public content only).
invitationMessage(optional)stringInvitation text added to the e-mail.
autoAddPermissions(optional, default: true)boolIf true and a user/group has no permissions to view a the 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:

ParameterTypeDescription
successboolTrue , if the invitations has have been sent successfully.
usersWithoutPermissionstring[]An array of user IDs , who have no permissions to view a the given content item.
usersWithoutPermissionstring[]An array of group IDs , which members have no permissions to view a the given content item.

 

Sample Call

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <InviteUsersToContentItemRequest><inviteUsersToContentItemRequest>
      <Credentials><credentials>
        <AccountUrl>http<accountUrl>http://myaccount.ispringlearn.com</AccountUrl>accountUrl>
        <Email>email@email<email>email@email.com</Email>email>
        <Password>password<<password>password</Password>password>
      </Credentials>credentials>
      <ContentItemId>1234<<contentItemId>1234</ContentItemId>contentItemId>
      <Users><users>
        <id>1</id>
        <id>2</id>
      </Users>users>
      <Groups><groups>
        <id>1</id>
        <id>2</id>
      </Groups>groups>
      <Emails><emails>
        <Email>user1@email<email>user1@email.com</Email>email>
        <Email>user2@email<email>user2@email.com</Email>email>
      </Emails>emails>
      <InvitationMessage>Invitation<invitationMessage>Invitation Message</InvitationMessage>invitationMessage>
    </InviteUsersToContentItemRequest>inviteUsersToContentItemRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <InviteUsersToContentItemResult><inviteUsersToContentItemResult>
      <Success>True<<success>True</Success>success>
    </InviteUsersToContentItemResult>inviteUsersToContentItemResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>