Share via

RestoreRecordingRequest Element

  • Artigo

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Requests the specified recording to be restored.

Syntax

<RestoreRecordingRequest>
  <StringQuery...></StringQuery>
</RestoreRecordingRequest>

The following sections describe attributes, parent elements, and child elements.

Attributes

None.

Element Information

Parent Elements

Element

Description

PlaceWareConfCenter

1

Child Element

Element

Description

StringQuery

1 or more

Remarks

The StringQuery element must match exactly one restorable recording. The list of available StringQuery options is limited to only those search options that return a single recording. The StringQuery element can search the following options:

  • reid

  • name

This element can be used only by account administrators to restore expired or manually deleted recordings that are restorable. To get a list of the restorable recordings, call ListRecordings4Request element with a restorableOnly attribute value of True (Added in Live Meeting service API Update for Live Meeting 2007). For more information about restoring a meeting or recording, see Maintaining Meetings and Recordings.

If attempting to restore a recording, a RestoreRecordingReply element is returned on success and a Fault element is returned on failure. For a complete list of fault return values, see Fault Element.

Examples

The two following examples demonstrate a successful recording restoration request and a failed request that generates a fault response.

Example 1

The following is an example of a successful recording restoration request. The interested recording is identified by name.

Request

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <RestoreRecordingRequest>
    <StringQuery fieldName="name" operator="=" value="strategy"/>
  </RestoreRecordingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
   <RestoreRecordingReply/>
</PlaceWareConfCenter>

Example 2

This example illustrates a recording restoration request that generates a fault response. The interested recording is already in an active state.

Request

<PlaceWareConfCenter authUser="BVTAdmin" authPassword="Pa$$w0rd">
   <RestoreRecordingRequest >
      <StringQuery fieldName="name" operator="=" value="apiRecording1" />
   </RestoreRecordingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadState.Recording</FaultCode>
      <FaultString>The recording you are trying to restore is already in Active state. It should be in either Deleted or Expired state.</FaultString>
      <OptionList>
         <TimeOption value="2007-07-11T23:29:14Z" name="time">
         </TimeOption>
         <StringOption value="kn2k7sm54z" name="rapid.requestId">
         </StringOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

See Also

Concepts

RestoreRecordingReply Element

RestoreRecording Message