DocLink Node
DocLink Node
This node contains document/link definitions. These nodes are contained within a DocLinks container node. The type of object that the document/link is attached to is indicated by the ParentType property. The indicator of whether this is a link or a document file is indicated by the DocType property. If the DocLink uses ContentTags, the DocLink will become a container node with the ContentTags node containing the corresponding tags.
Link Example:
<DocLink ParentType="Booth" AttachmentKey="9167" Name="NotifiedWeb Site" ExternalID="" DocType="Link" LinkURL="http://www.Notified.com" ParentKey="2144" ParentExternalID="B393Q" />
Document File Example:
<DocLink ParentType="Booth" AttachmentKey="9168" Name="Guide" ExternalID="" DocType="File" FileName="ManagerUserGuide.doc" ParentKey="2144" ParentExternalID="B393Q" />
Document File with ContentTags Example:
<DocLink ParentType="Booth" AttachmentKey="9168" Name="Guide" ExternalID="" DocType="File" FileName="ManagerUserGuide.doc" ParentKey="2144" ParentExternalID="B393Q">
<ContentTags>
<ContentTag ContentTagKey=”33” TagName=”Guide” ParentTag=”0” />
<ContentTag ContentTagKey=”35” TagName=”Demo” ParentTag=”0” />
</ContentTags>
</DocLink>
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call :https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50565&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&InfoTypeFilter={filter code list, in |OPTION|OPTION| format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50565. All other parameters may appear in any sequence order.
Attribute |
Type |
Comment |
---|---|---|
ParentType |
String |
Indicates the type of parent object that this document/link is attached to. Values are: Show, Booth, or Event. |
AttachmentKey |
Integer |
The Notified doc/link key for this document/link entry. |
Name |
String |
The title of the document/link. |
ExternalID |
String |
External ID for this document/link. |
DocType |
String |
File for document files, or Link for hyperlinks. |
FileName |
String |
If this document/link is a file, then the file name. Otherwise, this attribute is omitted. |
LinkURL |
String |
If this document/link is a link, then the URL that this link points to. Otherwise, this attribute is omitted. |
ParentKey |
Integer |
Key-value of the parent element that this document/link is attached to (ShowKey, BoothKey, EventKey). |
ParentExternalID |
String |
The External ID of the parent element that this document/link is attached to. |
ContentTag nodes:
Attribute |
Type |
Comment |
---|---|---|
ContentTagKey |
Integer |
The Notified content tag key for this tag. |
TagName |
String |
The tag used for searching and labeling content |
ParentTag |
Integer |
The content tag key represents a list of tags. Example: blue, red, green may all be children of tag colors. This will be 0 if it is a root tag. |