Path:
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList
Element
Schema
<xsd:element name=
"TicketList"
>
<xsd:complexType
>
<xsd:sequence
>
<xsd:element ref=
"Ticket" maxOccurs="unbounded"
/>
</xsd:sequence
>
</xsd:complexType
>
</xsd:element
>
Example
<TicketList>
<Ticket>
<TicketID>7610</TicketID>
<SecurityCode>abc</SecurityCode>
<SerialNo>12</SerialNo>
<FullName>John
Smith</FullName>
<TextOnTicketBody>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>Test
Conference</LineContent>
</LineInfo>
</TextOnTicketBody>
<TextOnTicketSideBar>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>May 1,
2009</LineContent>
</LineInfo>
</TextOnTicketSideBar>
<CustomFieldList>
<CustomField>
<FieldName>Company
Name</FieldName>
<FieldValue>Good
Company</FieldValue>
</CustomField>
</CustomFieldList>
<ConditionOfSale>All
sales are final.</ConditionOfSale>
</Ticket>
<Ticket>
<TicketID>7610</TicketID>
<SecurityCode>abc</SecurityCode>
<SerialNo>12</SerialNo>
<FullName>Mary
Doe</FullName>
<TextOnTicketBody>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>Test
Conference</LineContent>
</LineInfo>
</TextOnTicketBody>
<TextOnTicketSideBar>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>May 1,
2009</LineContent>
</LineInfo>
</TextOnTicketSideBar>
<CustomFieldList>
<CustomField>
<FieldName>Company
Name</FieldName>
<FieldValue>Better
Company</FieldValue>
</CustomField>
</CustomFieldList>
<ConditionOfSale>All
sales are final.</ConditionOfSale>
</Ticket>
</TicketList>
Ticket
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket
Elements:
Schema
<xsd:element name=
"Ticket"
>
<xsd:complexType
>
<xsd:sequence
>
<xsd:element ref=
"TicketID" minOccurs="0"
/>
<xsd:element ref=
"SecurityCode"
/>
<xsd:element ref=
"SerialNo"
/>
<xsd:element ref=
"FullName" minOccurs="0"
/>
<xsd:element ref=
"TextOnTicketBody"
/>
<xsd:element ref=
"TextOnTicketSideBar"
/>
<xsd:element ref=
"CustomFieldList" minOccurs="0"
/>
<xsd:element ref=
"ConditionOfSale" minOccurs="0"
/>
</xsd:sequence
>
</xsd:complexType
>
</xsd:element>
TicketID
|
Name
|
TicketID
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TicketID
|
|
Description
|
TicketID as provided in the
administrative system. TicketID is
used for retrieving the logo or banner graphics used in defining the
ticket. The API uses the graphics
uploaded in the admin for the ticket. If left blank no graphics will be used.
|
|
Data Type
|
Int64
|
|
Range
|
Minimum: 1
Maximum: 9999999999
|
|
Default
|
|
|
Operation
|
Ticket Banner
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
(Engine use -1 if it is blank)
|
|
Example
|
<TicketID>7610</TicketID>
|
Schema
<xsd:element name=
"TicketID"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation>
TicketID as provided in the
administrative system. TicketID is used
for retrieving the logo or banner graphics used in defining the ticket. The API uses the graphics uploaded in the
admin for the ticket. 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>
SecurityCode
|
Name
|
SecurityCode
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.
SecurityCode
|
|
Description
|
A 1-5 character security
code. The security code will be
embedded in the 1d and 2d barcode and will not appear on the ticket. It may be used as a verification when a
barcode scanner is used.
|
|
Data Type
|
String
|
|
Range
|
Minimum: 1 character
Maximum: 5 characters
|
|
Default
|
|
|
Operation
|
Securing the barcode
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<SecurityCode>123ab</SecurityCode>
|
Schema
<xsd:element name=
"SecurityCode"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation>
A 1-5 character security code. The security code will be embedded in the 1d
and 2d barcode and will not appear on the ticket. It may be used as a verification when a
barcode scanner is used.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:normalizedString"
>
<xsd:minLength value=
"1"
/>
<xsd:maxLength value=
"5"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
SerialNo
|
Name
|
SerialNo
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.
SerialNo
|
|
Description
|
A counter which will be
incremented for each ticket issued. The serial number will be included in the 2d barcode.
|
|
Data Type
|
String
|
|
Range
|
Minimum: 0 digit
Maximum: 10 digits
|
|
Default
|
|
|
Operation
|
Included in the barcode
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<SerialNo>1000</SerialNo>
|
Schema
<xsd:element name=
"SerialNo"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation>
A counter which will be incremented
for each ticket issued. The serial
number will be included in the 2d barcode.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:normalizedString"
>
<xsd:minLength value=
"0"
/>
<xsd:maxLength value=
"10"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
FullName
|
Name
|
FullName
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.
FullName
|
|
Description
|
Ticket holder’s full name as it
should appear on the ticket. Leave it
blank if no name is needed on the ticket. Names may be added as an extra measure of security since names may be
checked against an ID card during check-in. Names may also be matched against the Mobile Ticketing system. Check the manual for details.
|
|
Data Type
|
String
|
|
Range
|
Minimum: blank
Maximum: 20 characters
|
|
Default
|
|
|
Operation
|
Included in the barcode
|
|
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>
Ticket holder’s full name as it
should appear on the ticket. Leave it
blank if no name is needed on the ticket. Names may be added as an extra measure of security since names may be
checked against an ID card during check-in. Names may also be matched against the Mobile Ticketing system. Check the manual for details.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:normalizedString"
>
<xsd:minLength value=
"0"
/>
<xsd:maxLength value=
"20"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
TextonTicketBody
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextOnTicketBody
Elements
Schema
<xsd:element name=
"TextOnTicketBody"
>
<xsd:complexType
>
<xsd:sequence
>
<xsd:element ref=
"LineInfo" maxOccurs="unbounded"
/>
</xsd:sequence
>
</xsd:complexType
>
</xsd:element>
LineInfo
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextOnTicketBody.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
>
Example
<TextOnTicketBody>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>Test Conference</LineContent>
</LineInfo>
</TextOnTicketBody>
LineNo
|
Name
|
LineNo
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.
TextonTicketBody. LineNo
|
|
Description
|
Up to six lines of information
may be added to each ticket. The lines
will appear on the main ticket body. Information such as date, location, and event name are typical values
for these lines. Identify the line
number prior to defining the text. Lines may be skipped if not needed.
|
|
Data Type
|
Int
|
|
Range
|
1 digit
|
|
Default
|
|
|
Operation
|
Ordering the line content
|
|
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 six lines of information may be added to each ticket. The lines will appear on the main ticket body. Information such as date, location, and event
name are typical values for these lines. Identify the line number prior to defining the text. Lines may be skipped if not needed.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:int"
>
<xsd:minInclusive value=
"1"
/>
<xsd:maxInclusive value=
"6"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
LineContent
|
Name
|
LineContent
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextonTicketBody.LineContent
|
|
Description
|
Text to appear in the ticket’s
main body. Each text appears based on
the Line number provided in the LineNo tag.
|
|
Data Type
|
String
|
|
Range
|
Line 1: Max 18 characters
Line 2: Max 18 characters
Line 3: Max 36 characters
Line 4: Max 36 characters
Line 5: Max 36 characters
Line 6: Max 36 characters
|
|
Default
|
|
|
Operation
|
Included in the ticket
|
|
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>
Text to appear in the ticket’s main
body. Each text appears based on the
Line number provided in the 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>
TextonTicketSideBar
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextonTicketSideBar
Element
Schema
<xsd:element name=
"TextOnTicketSideBar"
>
<xsd:complexType
>
<xsd:sequence
>
<xsd:element ref=
"LineInfo" maxOccurs="unbounded"
/>
</xsd:sequence
>
</xsd:complexType
>
</xsd:element>
LineInfo
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextonTicketSideBar.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
>
Example
<TextOnTicketSideBar>
<LineInfo>
<LineNo>1</LineNo>
<LineContent>May 1,
2009</LineContent>
</LineInfo>
</TextOnTicketSideBar>
LineNo
|
Name
|
LineNo
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextonTicketSideBar.LineInfo.LineNo
|
|
Description
|
Up to six lines of text may
appear on the ticket’s side bar. Side
bar may be treated as the ticket stub. Identify the line number prior to adding text. Lines may be skipped if not needed.
|
|
Data
Type
|
Int
|
|
Range
|
1 digit
|
|
Default
|
|
|
Operation
|
|
|
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 six lines of information may be added to each ticket. The lines will appear on the main ticket
body. Information such as date,
location, and event name are typical values for these lines. Identify the line number prior to defining
the text. Lines may be skipped if not
needed.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:int"
>
<xsd:minInclusive value=
"1"
/>
<xsd:maxInclusive value=
"6"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
LineContent
|
Name
|
LineContent
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.TextonTicketSideBar.LineInfo.LineContent
|
|
Description
|
The text that appears on the
ticket sidebar based on the line number as set in the LineNo tag.
|
|
Data Type
|
String
|
|
Range
|
Line 1: Max 12 Characters
Line 2: Max 20 Characters
Line 3: Max 20 Characters
|
|
Default
|
|
|
Operation
|
|
|
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>
Text to appear in the ticket’s main
body. Each text appears based on the
Line number provided in the 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.TicketList.Ticket.CustomFieldList
Element:
Schema
<xsd:element name=
"CustomFieldList"
>
<xsd:complexType
>
<xsd:sequence
>
<xsd:element ref=
"CustomField" maxOccurs="unbounded"
/>
</xsd:sequence
>
</xsd:complexType
>
</xsd:element
>
Example
<CustomField>
<FieldName>Company
Name</FieldName>
<FieldValue>Good Company</FieldValue>
</CustomField>
</CustomFieldList>
CustomField
Path: CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.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>
FieldName
|
Name
|
FieldName
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.CustomFieldList.CustomField.FieldName
|
|
Description
|
Additional information to be
added to the 2d barcode. The answer
will be included in the ticket barcode. Fieldname provides the question to be asked. Fieldname will be included in the report.
|
|
Data Type
|
String
|
|
Range
|
Minimum: blank
Maximum: 20 characters
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<FieldName>Employer</FieldName>
|
Schema
<xsd:element name=
"FieldName"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation>
Additional
information collected from the card holder. Field name is typically used as the question for the field and the
FieldValue used as the answer. Example: Who is your
employer? FieldName will be saved and
may be exported through the report section.</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.TicketList.Ticket.CustomeFieldList.CustomField.FieldValue
|
|
Description
|
Answer to the FieldName
question. Answer will be included in
the 2d barcode as well as the report.
|
|
Data Type
|
String
|
|
Range
|
Minimum: blank
Maximum: 50 characters
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<FieldValue>ClickandPledge</FieldValue>
|
Schema
<xsd:element name=
"FieldValue"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation><![CDATA[Answer to
the FieldName question. Example: Click & Pledge for the Who is your
Employer? FieldName. FieldValue will be saved and may be exported
through the report section.]]></xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:normalizedString"
>
<xsd:maxLength value=
"50"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element
>
ConditionOfSale
|
Name
|
ConditionOfSale
|
|
Path
|
CnPAPI.Engine.Request.Order.OrderItemList.OrderItem.TicketList.Ticket.ConditionOfSale
|
|
Description
|
Sales condition will be included
at the bottom of the ticket. Typical
Sales Condition includes return and refund policy as well as various legal
terms and disclaimers.
|
|
Data Type
|
String
|
|
Range
|
Minimum: blank
Maximum: 500 characters
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<ConditionOfSale>All sales
are final and non-refundable</ConditionOfSale>
|
Schema
<xsd:element name=
"ConditionOfSale"
>
<xsd:simpleType
>
<xsd:annotation
>
<xsd:documentation>
Sales
condition will be included at the bottom of the ticket. Typical Sales Condition includes return and
refund policy as well as various legal terms and disclaimers.</xsd:documentation
>
</xsd:annotation
>
<xsd:restriction base=
"xsd:normalizedString"
>
<xsd:minLength value=
"0"
/>
<xsd:maxLength value=
"500"
/>
</xsd:restriction
>
</xsd:simpleType
>
</xsd:element>
Uploading ....