Home / ... / OrderItemList / OrderItem / NameBadgeList

NameBadgeList


Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList

Element:

Schema

 <xsd:element name= "NameBadgeList" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "NameBadge" maxOccurs="unbounded" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <NameBadgeList>

 <NameBadge>

 <NameBadgeID>7610</NameBadgeID>

 <Enable1dBarcode>true</Enable1dBarcode>

 <Enable2dBarcode>false</Enable2dBarcode>

 <FullName>John Smith</FullName>

 <NameBadgeFooter>

  <LineInfo>

 <LineNo>1</LineNo>

 <LineContent>Test Conference</LineContent>

 </LineInfo>

 </NameBadgeFooter>

 <CustomFieldList>

 <CustomField>

 <FieldName>Company Name</FieldName>

 <FieldValue>Good Company</FieldValue>

 </CustomField>

 </CustomFieldList>

 </NameBadge>

 <NameBadge>

 <NameBadgeID>7610</NameBadgeID>

 <Enable1dBarcode>true</Enable1dBarcode>

 <Enable2dBarcode>false</Enable2dBarcode>

 <FullName>Jane Doe</FullName>

 <NameBadgeFooter>

 <LineInfo>

  <LineNo>1</LineNo>

 <LineContent>Test Conference</LineContent>

 </LineInfo>

 </NameBadgeFooter>

 <CustomFieldList>

 <CustomField>

 <FieldName>Company Name</FieldName>

 <FieldValue>My Company</FieldValue>

 </CustomField>

 </CustomFieldList>

 </NameBadge>

 </NameBadgeList>

NameBadge

Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge

Elements:

Schema

 <xsd:element name= "NameBadge" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "NameBadgeID" minOccurs="0" />  

 <xsd:element ref= "Enable1dBarcode" />  

 <xsd:element ref= "Enable2dBarcode" />  

 <xsd:element ref= "FullName" />  

 <xsd:element ref= "NameBadgeFooter" />  

 <xsd:element ref= "CustomFieldList" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <NameBadge>

 <NameBadgeID>7610</NameBadgeID>

 <Enable1dBarcode>true</Enable1dBarcode>

 <Enable2dBarcode>false</Enable2dBarcode>

  <FullName>John Smith</FullName>

 <NameBadgeFooter>

 <LineInfo>

 <LineNo>1</LineNo>

 <LineContent>Test Conference</LineContent>

 </LineInfo>

 </NameBadgeFooter>

 <CustomFieldList>

 <CustomField>

 <FieldName>Company Name</FieldName>

 <FieldValue>Good Company</FieldValue>

 </CustomField>

 </CustomFieldList>

 </NameBadge>

NameBadgeID

Name  

NameBadgeID  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.NameBadgeID  

Description  

NameBadgeID as provided in the administrative system. NameBadgeID is used for retrieving the logo or banner graphics used in defining the name badge. The API uses the graphics uploaded in the admin for the name badge. If left blank no graphics will be used.  

Data Type  

Int64  

Range  

Minimum: 1 digit  

Maximum: 9999999999  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No (Engine use -1 if it is blank)  

Example  

<NameBadgeID>7610</NameBadgeID>  

Schema

 <xsd:element name="NameBadgeID">

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> NameBadgeID as provided in the administrative system. NameBadgeID is used for retrieving the logo or banner graphics used in defining the name badge. The API uses the graphics uploaded in the admin for the name badge. If left blank no graphics will be used.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:long" >  

 <xsd:minInclusive value= "1" />  

 <xsd:maxInclusive value= "9999999999" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

Enable1dBarcode

Name  

Enable1dBarcode  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.Enable1dBarcode  

Description  

If True the 1d barcode will appear on the name badge.  

Data Type  

Boolean  

Range  

True / False  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<Enable1dBarcode>true</Enable1dBarcode>  

Schema

 <xsd:element name= "Enable1dBarcode" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> If True the 1d barcode will appear on the name badge.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:boolean" />  

 </xsd:simpleType >  

 </xsd:element>

Enable2dBarcode

Name  

Enable2dBarcode  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBageList.NameBadge.Enable2dBarcode  

Description  

If True the 2d barcode will appear on the name badge.  

Data Type  

Boolean  

Range  

True / False  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<Enable2dBarcode>false</Enable2dBarcode>  

Schema

 <xsd:element name= "Enable2dBarcode" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Create 2d barcode on the name badge</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:boolean" />  

 </xsd:simpleType >  

 </xsd:element>

FullName

Name  

FullName  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.FullName  

Description  

Full name as it should appear on the name badge. No name will appear if left blank.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 20 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<FullName>John Smith</FullName>  

Schema

 <xsd:element name= "FullName" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Full name as it should appear on the name badge. No name will appear if left blank </xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "0" />  

 <xsd:maxLength value= "20" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

NameBadgeFooter

  Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.NameBadgeFooter

Element:

Schema

 <xsd:element name= "NameBadgeFooter" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "LineInfo" maxOccurs="unbounded" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <NameBadgeFooter>

 <LineInfo>

 <LineNo>1</LineNo>

 <LineContent>Test Conference</LineContent>

 </LineInfo>

 </NameBadgeFooter>

LineInfo

Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.NameBadgeFooter.LineInfo

Elements: 

Schema

 <xsd:element name= "LineInfo" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "LineNo" />  

  <xsd:element ref= "LineContent" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

LineNo

Name  

LineNo  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge. NameBadgeFooter.LineNo  

Description  

Up to three lines of information may be added to the name badge. Each line should be first identified by its respective line number then by the text that should appear on the name badge.  

Data Type  

Int  

Range  

1-3  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<LineNo>1</LineNo>  

Schema

 <xsd:element name= "LineNo" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation Up to three lines of information may be added to the name badge. Each line should be first identified by its respective line number then by the text that should appear on the name badge.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:int" >  

 <xsd:minInclusive value= "1" />  

 <xsd:maxInclusive value= "3" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

LineContent

Name  

LineContent  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.NameBadgeFooter.LineContent  

Description  

The text that appears for each line of text on the name badge footer. Each line is identified by a line number as listed with LineNo tag.  

Data Type  

String  

Range  

Line 1: Max 25 Characters  

Line 2: Max 25 Characters  

Line 3: Max 25 Characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<LineContent>Annual Meeting</LineContent>  

Schema

 <xsd:element name= "LineContent" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> The text that appears for each line of text on the name badge footer. Each line is identified by a line number as listed with LineNo tag.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "0" />  

 <xsd:maxLength value= "36" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

CustomFieldList

Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.CustomFieldList

Element:

Schema

 <xsd:element name= "CustomFieldList" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "CustomField" maxOccurs="unbounded" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <CustomFieldList>

 <CustomField>

 <FieldName>Company Name</FieldName>

 <FieldValue>My Company</FieldValue>

 </CustomField>

 </CustomFieldList>

CustomField

Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.CustomFieldList.CustomField

Elements:

Schema

 <xsd:element name= "CustomField" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "FieldName" />  

 <xsd:element ref= "FieldValue" />  

  </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <CustomField>

 <FieldName>Company Name</FieldName>

 <FieldValue>My Company</FieldValue>

 </CustomField>

FieldName

Name  

FieldName  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.NameBadgeList.NameBadge.CustomFieldList.CustomField.FieldName  

Description  

Additional information may be added for each name badge per user entry. Field name will appear in the report in addition to the Field value as the answer.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 20 characters [maximum of 2 custom questions]  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<FieldName>Occupation</FieldName>  

Schema

 <xsd:element name= "FieldName" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Additional information may be added for each name badge per user entry. Field name will appear in the report in addition to the Field value as the answer.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

FieldValue

Name  

FieldValue  

Path  

CnPAPI.Engine.Request.Order.OrderItemList.OrderItem. NameBadgeList. NameBadge.CustomFieldList.CustomField.FieldValue  

Description  

Answer to the FieldName question. Field value will be added to the name badge and will be available in the report for download.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 20 characters [maximum of 2 custom questions]  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<FieldValue>Programmer</FieldValue>  

Schema

 <xsd:element name= "FieldValue" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation><![CDATA[Answer to the FieldName question. Field value will be added to the name badge and will be available in the report for download.]]></xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>




     RSS of this page