Element: getDownloadableFilesRequest

Description

A getDownloadableFilesRequest message contains an element of getDownloadableFiles.

Derived By

Extending RequestByPrincipal

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
Member	string	0..1	User ID (email).
EntitlementId	string	0..1	Entitlement ID.
ActivationId	string	0..1	Activation ID.
DownloadPackageReference	DownloadPackageReference	1..1	The identifiers for a Download Package.
OrganizationId	string	1..1	Organization ID.
OrganizationCountryName	string	0..1	Country name of an organization.
OrganizationRegionName	string	0..1	Region name of an organization.
NetStorageLocation	string	0..1	Net storage location.
FileReference	DownloadableFileReference	0..*	See DownloadableFileReference.
IncludeDownloadedFiles	boolean	0..1	Flag indicating whether all files or only not downloaded files must be included in response. Defaults to "true". When the request is made on behalf of a user, it only includes files this user is entitled to. When the request is made per activation id, it includes files that a particular line item is entitled to.
IncludeExternalFiles	boolean	0..1	Flag indicating whether the external files are downloadable or not.
OrderBy	DownloadableFileOrderBy	0..1	Sort order of files in the response.
Ascending	boolean	0..1	Flag indicating whether files in the request are sorted in ascending order.
emailNoticeId	string	0..1	Email notice ID (if user got to the page by following email link).
ipAddress	string	0..1	IP Address of the requesting party. In case of a UI client, this is hopefully the UI browser's IP address.
EULARequired	boolean	0..1	Flag indicating whether EULA is required.
UdfFilters	UserDefinedField	0..*	Custom attribute filters to apply to returned files: Custom Attribute Name Content - The values must contain "TagName" and "Value" in every "Content" element.
LocaleLanguage	language	0..1	Language of the file description.

Referenced By

Name	Type
getDownloadableFiles	Method

XML Example

The following XML fragment illustrates an getDownloadableFilesRequest message:

      <esd:getDownloadableFilesRequest>
         <esd:Member>member@someorg.org</esd:Member>
         <esd:OrganizationId>FlexQACustOrg1</esd:OrganizationId>
         <!--Zero or more repetitions:-->
         <esd:FileReference>
            <esd:SystemFileId>5329433</esd:SystemFileId>
         </esd:FileReference>
         <!--Optional:-->
         <esd:IncludeDownloadedFiles>true</esd:IncludeDownloadedFiles>
         <!--Optional:-->
         <esd:OrderBy>?</esd:OrderBy>
         <!--Optional:–>
         <esd:Ascending>?</esd:Ascending>

         <!--Optional:-->

         <esd:emailNoticeId>?</esd:emailNoticeId>

         <!--Optional:–>

         <esd:ipAddress>?</esd:ipAddress>
         <!--Optional:-->
         <esd:EULARequired>true</esd:EULARequired>
         <!--Zero or more repetitions:-->
         <esd:UdfFilters>
            <esd:TagName>?</esd:TagName>
            <esd:TagDescription>?</esd:TagDescription>
            <!--Zero or more repetitions:-->
            <esd:Content>
               <esd:Description>?</esd:Description>
               <!--Optional:-->
               <esd:Value>?</esd:Value>
            </esd:Content>
         </esd:UdfFilters>
      </esd:getDownloadableFilesRequest>