Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

File format for Pass Visits

The generic file format is described in Generic file format (Extended). This documents describes all available import fields.

Examples

Attachments
 


Field codeField typeMandatoryDescription
INSTITUTION
Text 15
CodeYesInstitution code owning the data to be imported.
ORGANIZATION
Text 15
Code
Yes
NoOrganization code owning the data to be imported.
By default
If leave it empty, the
organization code is the same as the institution code.
institution code will be used.
ORDER_NRNumberNoIf leave it empty, order number will be set while importing by default.
One line is one ticket. So each line is a unique order number if leave it empty.
Many tickets can be in an order if leave them the same order number. This number can be started from 1 in a new data file. Then it will be given new one while importing.
This will be file number also.
ORDER_DATEDateNoBuying date.
If leave it empty, it will be imported date by default.
OPERATION_TYPEEnumYesAllowed values: SALE or RESERVATION.
CONFIRMATION_DATEDateNoExpiration date to confirm reservation.
REMARKText 2000NoInternal remark of order.
BUYING_CONTACT_NRNumber
Yes
NoContact number
ORDER_NRNumberYesOrder number
who buys the order.
If leave it empty, the sale will be anonymous by default.
ORIGIN_COUNTRYText 50NoCountry of buying contact (only if buying contact is not specified).
ORIGIN_REGIONText 50NoRegion of buying contact (only if buying contact is not specified).
ORIGIN_ZIPCODEText 50NoZip code of buying contact (only if buying contact is not specified).
SEASON
SEASON_CODE
CodeYesSeason code
for the
of visit pass.
VISIT_
CODE
PASSCodeYes
Code
Product code of
the
visit
product
pass.
START_TIMETimestampYesStart time of the visit.
DURATIONNumberYesDuration of the visit in seconds.
GROUP_NAME
TARIFF
Text
CodeYes
for group visits

Leave empty for individual visits

Name of the group.

 

Tariff code.
CONTINGENT
GROUP_KIND
Code

Yes for group visits

Leave empty for individual visits

Group kindTHEMECode 

Theme of the visit

(only useful for guided visits)

LANGUAGECode 

ISO Language code of the visit (fr, en, ...)

(only useful for guided visits)

HOLDER_CONTACT_NRNumber 

If not filled in, the purchase contact is used

For a group visit, the contact must be of type RELAY.

ORDER_DATEDateYesOrder dateOPERATION_TYPEText 50Yes

Operation type.

Possible values: SALE or RESERVATION

VISITOR_TYPE Yes

Type of visitor

Possible values: PARTICIPANT or ACCOMPANIER

NB_VISITORSNumberYesNumber ofTARIFFCodeYes PRICEAmountYes

Gross amount

If flat rate, full price of the visit

If individual rate, unit price per participant

VATPercentageYes CHARGEAmount  REMARKText  PAYMENT_DATETimestampYes if OPERATION_TYPE=SALE TICKET_STATECodeYes if OPERATION_TYPE=SALE
NoContingent code.
PRICEAmountYesPrice of ticket * 100 (so that 25$ = 2500).
CHARGEAmountNoCharge of ticket * 100 (so that 1$ = 100).
VATPercentageNoIf leave it empty, it will be 0 while importing by default.
Vat rate in percent * 100 (so that 1% = 100).
Choose the rate that active and valid following this:
Valid from date of vat rate <= ORDER_DATE <= Valid to date of vat rate.
PAYMENT_DATEDateNoIf leave it empty, the operation type is SALE and the price is not 0, the order date will be used by default. Means it can be imported date if the order date is not given.
VISIT_PASS_NRNumberNoEach visit pass has a unique number to know how many visit passes have been published.
In importation, it helps to define ticket to check between data excel file and database system after importing.
This number can be started from 1 in a new data file. Then it will be given new one while importing.
CULTURAL_CONTACT_NRNumberNoContact number who is ticket holder.
If leave it empty and first/last name are empty, the buying contact number will be used by default.
BENEFICIARY_FIRSTNAMEText 50NoBeneficiary first name (only if cultural contact is not specified).
BENEFICIARY_LASTNAMEText 50NoBeneficiary last name (only if cultural contact is not specified).
TICKET_STATEEnumYes if SALEMandatory when the operation type is SALE.
Allowed
Possible
values: NOT_PRINTED, PRINTED, CONTROLLED.
GENERATION_DATEDate
TimestampYes if TICKET_STATEPRINTED 
NoIf leave it empty and the ticket has been printed or controlled, the order date will be used by default. Means it can be imported date if the order date is not given.
BARCODEText 50NoIf leave it empty and the ticket has been printed or controlled, it will be generated following import rules by default.
BARCODETextYes if TICKET_STATE>=PRINTED 
TAX_NUMBERText
Yes if TICKET_STATE=PRINTED
50NoIf leave it empty and the ticket has been printed or controlled, it will be generated following import rules by default.
SHIPMENT_DATEDateNoIf leave it empty, the order date will be used by default. Means it can be imported date if the order date is not given.
 
SHIPMENT_MODECode
Yes if TICKET_STATE=PRINTEDPossible values are SENT, SENT EMAIL, BOXOFFICE, CONTROL
NoIf leave it empty and the ticket has been printed or controlled, it will be imported following import rules by default.
GROUP_NAMEText 50Yes if group visitsName of the group.
Leave empty for individual visits.
GROUP_KINDCodeYes if group visitsKind of the group.
Leave empty for individual visits.
THEMECodeNoTheme of the visit (only use for guided visits).
LANGUAGECodeNoISO Language code of the visit (fr, en, ...) (only use for guided visits).
VISITOR_TYPEEnumYesAllowed values: PARTICIPANT or ACCOMPANIER.
NB_VISITORSNumberYesMust be > 0.
PLACECodeNo
GUIDECodeNoLast name and first name of the guide.
GROUP_CRIT_ELEMENTCodeNoGroup criterion element code.
SHIPMENT_DATETimestampYes if SHIPMENT_MODE=SENT PLACE   GUIDE