getCollectionEntry()

CustomCollectionEntry getCollectionEntry(int key)

This method retrieves a custom collection entry directly by key.

Parameters

key: Format: integer; Purpose: Specifies the primary identifier of the custom collection entry to be returned.

Results

This method returns a CustomCollectionEntry XML document describing the requested custom collection entry.

There are no messages defined by this method.

Example: A returned CustomCollectionEntry XML document

This example shows CustomCollectionEntry XML document.

<CustomCollectionEntry xmlns="http://xml.inomial.com/smile/2.xsd" key="6550">
  <CollectionCode>AirFreightDestinations</CollectionCode>
  <EntryCode>AU_Sydney</EntryCode>
  <Object objectId="3455" formId="125" displayName="SYD - Kingsford Smith International">
    <String name="airportName">Kingsford Smith International</String>
    <String name="airportIcaoCode">YSSY</String>
    <String name="airportIataCode">SYD</String>
  </Object>
</CustomCollectionEntry>

Faults

NoSuchItemException

This fault is returned when a custom collection entry does not exist with the given key.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetCollectionEntry key

key: Purpose: Specifies the primary identifier of the custom collection entry to be returned.

Note: For more information about the Java client and the options it accepts, see Java client syntax.