CustomCollectionEntryAdded

Smile emits this message when a new collection entry is created.

Message header

The following table lists the parameters in the CustomCollectionEntryAdded message header.

Table 1. CustomCollectionEntryAdded header parameters
Parameter Type Values
companyId integer Company that the custom collection entry belongs to
key integer Unique custom collection entry key that identifies the entry being added
smileMessageType string "CustomCollectionEntryAdded"
collectionCode string Code name of the collection possessing the entry that this message concerns
entryCode string Code name of the collection entry that this message concerns

Message body

The root element of the message body is <CustomCollectionEntry> and has the following format:
{http://xml.inomial.com/smile/2.xsd}CustomCollectionEntry

The message body always reflects the latest (post-operation) state of the custom collection entry.

It should be noted that the objectId="..." attribute of the <Object> element is purely intended for Inomial's own diagnostic reference, and is not intended to be used by third-party developers.

If the values of the objectId="..." and top-level key="..." attributes appear identical, this is purely of coincidence, and merely a side-effect of the underlying storage system used in Smile. You should not rely on the value of the objectId="..." attribute as Inomial reserves the right to alter the way this attribute is generated in future versions of Smile without notice.

Example: The <CustomCollectionEntry element

This example shows an CustomCollectionEntry XML document that contains the <CustomCollectionEntry> element.

<CustomCollectionEntry key="6564" xmlns="http://xml.inomial.com/smile/2.xsd">
  <CollectionCode>products</CollectionCode>
  <EntryCode>MobilePhoneModel</EntryCode>
  <Object objectId="6564" formId="1156" displayName="iPhone 6S (Silver)">
    <String name="productCode">iphone6s</String>
    <String name="productDescription">iPhone 6S</String>
    <String name="colour">Silver</String>
  </Object>
</CustomCollectionEntry>