A mechanism for granting access to content to a child organization.

Syntax

LmsGrantResult[] = lmsBinding.GrantContent (string licenseeId, string[] activityIds)

Usage

When invoked by a client application, Firmwater LMS will grant the child organization identified by the licenseeId field access to each of the content activities listed in the activityIds array. Upon completion, the content can be assigned to users within the child organization by creating registrations (see LmsRegistrationObject).

Rules and Guidelines

Permissions

A client application must be logged in as a 'Master Administrator' with access to the organization that the content is being granted from.

Arguments

Name	Type	Description
licenseeId	string	Client ID of organization to which the content will be granted
activityIds	string[]	Root activities are container items such as courses that are loaded into the LMS. This argument contains an ID list of such container items that are to be granted. The items in the list belong to the parent of the organization specified by 'licenseeId'.

Return Object

LmsGrantContentResult

Sample SOAP messages

Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
 xmlns:ns4="http://firmwater.com/webservices/lms/lmsservice1"
>

  <SOAP-ENV:Header>
    <ns4:SessionHeader SOAP-ENV:actor="http://schemas.xmlsoap.org/soap/actor/next" SOAP-ENV:mustUnderstand="0">
    <ns4:sessionId>f943cde4-802c-48e1-ae28-78bd63b2d0bf</ns4:sessionId></ns4:SessionHeader>
  </SOAP-ENV:Header>

  <SOAP-ENV:Body>
    <ns4:GrantContent>
      <ns4:licenseeId>acme</ns4:licenseeId>
      <ns4:activityIds>
        <ns4:string xsi:type="xsd:string">E4058E69-3212-4341-8AA9-B3AC0E94EC90</ns4:string>
        <ns4:string xsi:type="xsd:string">6F39EE5F-6456-4D9E-BBD1-EFAC81A90887</ns4:string>
      </ns4:activityIds>
    </ns4:GrantContent>
  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
>

  <soap:Body>
    <GrantContentResponse xmlns="http://firmwater.com/webservices/lms/lmsservice1">
      <GrantContentResult>

        <LmsGrantContentResult>
          <SourceId>E4058E69-3212-4341-8AA9-B3AC0E94EC90</SourceId>
          <TargetId>EECF81ED-A174-419B-B7BB-79CC576D8CF4</TargetId>
          <Success>true</Success>
          <Status>NO_ERROR</Status>
        </LmsGrantContentResult>

        <LmsGrantContentResult>
          <SourceId>6F39EE5F-6456-4D9E-BBD1-EFAC81A90887</SourceId>
          <TargetId>BB4A6C82-DCF0-4CD0-A4E1-06B5E5451126</TargetId>
          <Success>true</Success>
          <Status>NO_ERROR</Status>
        </LmsGrantContentResult>

      </GrantContentResult>
    </GrantContentResponse>
  </soap:Body>

</soap:Envelope>