3.4.4.3 AcquireTemplates Operation

The AcquireTemplates request is used to acquire specific rights policy templates from the server. The template can then be used to create protected content. The template describes usage policies for intended recipients when they access a particular content file protected using the template.

AcquireTemplates message sequence

Figure 10: AcquireTemplates message sequence

 <wsdl:operation name="AcquireTemplates"> 
     <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Return templates</wsdl:documentation>
     <wsdl:input message="tns:AcquireTemplatesSoapIn" />
     <wsdl:output message="tns:AcquireTemplatesSoapOut" />
 </wsdl:operation>

Exceptions Thrown: The AcquireTemplates method SHOULD return a fault code when a failure occurs.  Details of the RMS: Client to Server Protocol SOAP fault format can be found in section 3.1.4.5.

Exception

Description

Microsoft.RightsManagementServices.ClusterDecommissionedException

A request was received, but the server is in a decommissioned state and cannot process the request.

In the AcquireTemplates operation, the client MUST submit a list of rights policy template GUIDs and request templates corresponding to these GUIDs.

Upon receiving an AcquireTemplates request, the server SHOULD check whether it has the requested rights policy templates in the publishedTemplates field of the ServerState. The server SHOULD return a list of templates corresponding to the GUID list it obtained in the request. In addition to the template XML, each returned object in the list MUST include the GUID of the template and hash value. If the server cannot find a template matching the GUID, it MUST return a null value for that template's XML field. For an unsuccessful request, the server MUST return a SOAP fault code. If the serverDecommissioned field of ServerState is true, the server SHOULD return a Microsoft.RightsManagementServices.ClusterDecommissionedException fault.