Administering an Encyclopedia volume : Searching within an Encyclopedia volume : Getting Encyclopedia volume, printer, and file type information : Retrieving parameter definitions for a file type
 
Retrieving parameter definitions for a file type
GetFileTypeParameterDefinitions supports retrieving the parameter definitions for all files of a given type on an Encyclopedia volume.
<SOAP-ENV:Body>
<GetFileTypeParameterDefinitions>
<FileType>NewType</FileType>
</GetFileTypeParameterDefinitions>
</SOAP-ENV:Body>
The ParameterDefinition element of the response returns details about every parameter associated with the specified file type. If the file type parameter is an ad hoc parameter, you must set ColumnName and ColumnType parameters in ParameterDefinition. The following example includes two parameter definitions:
<SOAP-ENV:Body>
<GetFileTypeParameterDefinitionsResponse>
<ParameterList>
<ParameterDefinition>
<Name>City</Name>
<DataType>String</DataType>
<DefaultValue>Boston</DefaultValue>
<IsRequired>true</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<IsAdHoc>false</IsAdHoc>
</ParameterDefinition>
<ParameterDefinition>
<Name>Customer</Name>
<DataType>String</DataType>
<IsRequired>true</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<DisplayName>Client</DisplayName>
<IsAdHoc>false</IsAdHoc>
</ParameterDefinition>
</ParameterList>
</GetFileTypeParameterDefinitionsResponse>
</SOAP-ENV:Body>