getCollectionEntryByEntryCode()

CustomCollectionEntryType getCollectionEntryByEntryCode(string collectionCode, string entryCode)

This method retrieves details of a custom collection entry by entry code.

Parameters

collectionCode: Format: string; Purpose: Specifies the custom collection that the entry to be retrieved belongs to.
entryCode: Format: string; Purpose: Specifies the custom collection entry to be retrieved.

Results

This method returns a CustomCollectionEntry XML document that describes the custom collection entry.

There are no messages defined by this method.

Example: A returned CustomCollectionEntry XML document

This example shows a CustomCollectionEntry XML document.

<CustomCollectionEntry xmlns="http://xml.inomial.com/smile/2.xsd" key="6547">
  <CollectionCode>AirFreightDestinations</CollectionCode>
  <EntryCode>UK_London</EntryCode>
  <Object objectId="1266" formId="125" displayName="LHR - Heathrow">
    <String name="airportName">Heathrow</String>
    <String name="airportIcaoCode">EGLL</String>
    <String name="airportIataCode">LHR</String>
  </Object>
</CustomCollectionEntry>

Faults

NoSuchItemException

This fault is returned when the specified collection code does not exist, or if the collection lacks an entry with the given entry code.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetCollectionByEntryCode
 collectionCode entryCode

collectionCode: Purpose: Specifies the custom collection that the entry to be retrieved belongs to.
entryCode: Purpose: Specifies the custom collection entry to be retrieved.

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