GetURLRequest Element

Article
05/23/2014

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 URL for a given resource.

Syntax

<GetURLRequest>
    <StringQuery...></StringQuery>
    <OptionList>...</OptionList>

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

Attributes

None.

Element Information

Parent Element

Element	Occurrences
PlaceWareConfCenter Element	1

Child Elements

Element	Occurrences
StringQuery Element	1
OptionList Element	1

Remarks

If the resourceType option indicates a slide set, the query must match exactly one non-deleted meeting. This is the meeting to which the slide set is to be uploaded.

If the resourceType option indicates a recording, the query must match exactly one non-deleted recording. This is the recording to be downloaded.

The GetURLRequest element introduces a new High Fidelity Format Recording, although the Basic Format is still accessible for compatibility.

Any child elements, if present, must be in the order shown in the Child Elements table.

The following table specifies the options that can be present in the OptionList Element.

Option Name	Description
Bytes	DecimalOption Element. Value range 1–10,000,000. Specifies the number of bytes to upload. This is required for uploads and must not be present for downloads. The number is the total after any encoding is applied.
encoding	EnumerationOption Element. Value range [base64 \| none]. The encoding for uploading. This is only meaningful for uploads and is ignored for downloads. base64 indicates the Base-64 encoding specified in RFC 2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies." none indicates no encoding. If the value of the resourceType option is password-protected (PWP), the encoding must be base64. The default is none.
isUpload	BooleanOption Element. Value range [True \| False]. True for uploads and False for downloads. The default is False.
protocol	EnumerationOption Element. Value range [http \| https]. Specifies the protocol to be used in the URL in the reply. The http value for the protocol field in the XML request is ignored. GetURLReply returns only https regardless of the value supplied in the protocol field.
recViewerCompany	StringOption Element. Length range 1–256 characters. Specifies the viewer’s company. The company name and viewer’s e-mail are required if the particular recording requires extended registration. The value of this option appears in the company query field of the URL returned by the reply. If the registration option for the recording is True, these fields must be present to send the user to the recording. If one or both of these fields is absent, the user sees a form to fill in.
recViewerEmail	StringOption Element. Length range 1–256 characters. Specifies the viewer’s e-mail address. The company name and viewer’s e-mail are required if the particular recording requires extended registration. The value of this option appears in the email query field of the URL returned by the reply. If the registration option for the recording is True, these fields must be present to send the user to the recording. If one or both of these fields is absent, the user sees a form to fill in.
recViewerName	StringOption Element. Length range 1–256 characters. Specifies the viewer’s name. This option is mandatory. The value of this option appears in the cn query field of the URL returned by the reply. If this field is absent, the user sees a form to fill in.
resourceType	EnumerationOption Element. Value range [ESS \| HighFidelityPresentation \|HighFidelityPresentationDownload\| PWP \| WindowsMediaMovieRecording \| WindowsMediaMovieRecordingDownload \| BasicRecording]. This is a required option. Specifies the type of resource requested. HighFidelityPresentation specifies the new high fidelity presentation (HFP) recording format. This format can be uploaded and downloaded. HighFidelityPresentationDownload specifies an HFP-formatted resource download. ESS indicates a slide set in Live Meeting Extensible Slide Set (ESS) format. ESS can only be used for uploads. PWP indicates a slide set in Live Meeting Presentation format. PWP can only be used for uploads. WindowsMediaMovieRecording indicates a recording in Windows Media Format. WindowsMediaMovieRecordingDownload specifies a .wmv download. BasicRecording specifies a basic recording (slidelog.htm). This enumeration remains in the enumeration list to allow the retrieval of legacy BasicRecording format recordings.
showSlideSet	BooleanOption Element. Value range [True \| False]. Permitted only when a slide set is uploaded. The uploaded slide set is displayed if, and only if, this option is True. The default is False.
uploadName	StringOption Element. Length range 1–256 characters. Specifies the name for the upload. This is required for uploads and cannot be present for downloads. In cases where an upload is visible in the user interface, this is the name used.

Example

The following code shows the request sent to the conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <GetURLRequest>
       <StringQuery fieldName="name" operator="=" value="ZTB93J-1"/>
       <OptionList>
         <StringOption name="recViewerCompany" value="Contoso Corporation"/>
         <StringOption name="recViewerName" value="John"/>
           <StringOption name="recViewerEmail" value="john@contoso.com"/>
           <EnumerationOption name="resourceType" value="HighFidelityPresentation">
               <String>ESS</String>
               <String>PWP</String>
                  <String>BasicRecording<String>
               <String>WindowsMediaMovieRecording</String>
               <String>WindowsMediaMovieRecordingDownload</String>
               <String>HighFidelityPresentation</String>
              <String>HighFidelityPresentationDownload</String>
      </EnumerationOption>
       </OptionList>
  </GetURLRequest>
</PlaceWareConfCenter>

The following shows the reply returned from the conference center when the request is processed successfully.

<PlaceWareConfCenter>
  <GetURLReply url="https://www112.livemeeting.com/cc/_XML/contoso/view?id=8G2G4J&amp;fmt=hff&amp;pw=&amp;cn=john&amp;email=john@contoso.com&amp;company=Contoso Corporation"></GetURLReply>
</PlaceWareConfCenter>

The returned URL can be sent to a client browser to retrieve a page that displays the streamed recording.

Constraints

The HighFidelityPresentation format only returns the URL if the recording contains HighFidelityPresentation format.

Note

When this request is used to upload a presentation in ESS format, the Live Meeting server will scans the uploaded presentation for virus infection. If a virus is found in the uploaded presentation, a fault message is returned in an InfoWarnFaultList Element.

Share via