FORKLIFT XML-Interface

XML Basics

XML Basics

The XML-File follows a special format, which is described in short form here:

     
     <?xml version="1.0" encoding=“UTF-8“ ?>
        <machinelist code="76382388">
            <machine type="1">
            [..tags..]
            </machine>
        </machinelist>
     

The machinelist code attribute value for your account is given to you by your FORKLIFT representative.

Then following are the machines with their corresponding types and their tags. The types are coded as follows:

Types

Forklift Attributes

Forklift Attributes

Here you can find all the tags, whether they are mandatory or not (marked with an X in the „default column), their default values and to what machine-types they can attach to.

Tag	Type	Default	Description	Values
enginetype	int	X	The engine type of the machine.	Go to
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.	-
manufacturer	string	X	The manufacturer name of the machine.	-
toc	int	X	The type of construction of the machine.	Go to
addeqbits	int	0	Bits for additional equipment. There can be more than 1 of these tags per machine. These items appear translated on the page.	Go to
addequip	string	''	Additional equipment of the machine, for forklifts see also next field for translateable values	-
attachbit	int	0	Bits for attachments. There can be more than 1 of there tags per machine. The items appear translated.	Go to
attachments	string	''	Attachments of the machine.	-
auctionend	datetime	''	If the machine is in an auction, this is the end datetime of the auction.	Go to
auctionurl	string	''	The URL of the auction. This links to an external auction-site. The URL has to be properly URL-encoded.	Go to
available	string	''	The availability of the machine (e.g. "at once")	-
battery	string	''	Description of the battery (size and age)	-
batterytype	int	1	Enter the type of battery.	Go to
capacity	int	0	The lifting capacity of the device	-
chassisno	string	''	The chassis (serial-) no. of the machine	-
closedheight	int	0	The closed height of the lifting mast	-
condition	Int	4	The condition of the machine. Default is "Ready to use and fully operational".	Go to
custprice	int	0	The end user price for the machine in your selected import-currency	-
dailyrentprice	int	0	The daily rental price for the machine in your selected import-currency.	-
dealerprice	int	0	The dealer price for the machine in your selected import-currency	-
demo	int	0	Set to 1 if this is an intranet demonstration machine. Only shown in intranet and is not meant to be sold	-
engine	string	''	Description of the machine's engine	-
expmascus	int	0	1 if the machine should be exported to Mascus, 0 if not. Note that you have to add this option to your contract.	-
expmobile	int	0	1 if the machine should be exported to Mobile, 0 if not. Note that you have to add this option to your contract.	-
expsupralift	int	0	1 if the machine should be exported to Supralift, 0 if not. Note that you have to add this option to your contract.	-
forkcarr	string	''	Description of the machines fork carriage	-
forklength	Int	0	The Length of the forks of the forklift	-
forks	string	''	Description of the forks of the machine	-
freelift	int	0	The free lift oft the lifting mast	-
hours	int	0	The machine's running hours	-
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.	-
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!	-
intprice	Int	0	Your internal price, only visible to you	-
intranetprice	int	0	The price for the machine in the intanet area your selected import-currency	-
intraremarks	string	''	Remarks visible in the Intranet-area.	-
intremarks	string	''	Remarks visible just to you.	-
length	int	0	The length of the machine	-
liftingheight	int	0	The lifting height of the lifting mast	-
loadcenter	int	0	The load-center of the machine	-
loccity	string		The city where the machine is located. Defaults to the user accounts city.	-
loccountry	int	0	The coded country where the machine is located. This defaults to the country of the user account.	Go to
locpostcode	string		The postcode where the machine is located. Defaults to the user accounts postcode.	-
masttype	int	0	The mast type.	Go to
model	string	''	The model type of the machine	-
monthlyrentpr	int	0	The monthly rental price per day for the machine in your selected import-currency.	-
optcond	int	6	The optical condition of the machine. Default is “Normal”.	Go to
remarks	string	''	Remarks visible to dealers	-
rental	int	0	Set to 1 if the machine is a rental machine	-
techcond	int	6	The technical condition of the machine. Default is “Normal”.	Go to
transmission	string	''	The machine's transmission	-
tyres	int	0	The type of front-tires of the machine. Defaults to "unknown".	Go to
tyres2	int	0	The type of back-tires of the machine. Defaults to „unknown“.	Go to
tyresfront	string	''	Description of the front tyres	-
tyresrear	string	''	Description of the rear tyres	-
userremarks	string	''	Remarks visible to end users	-
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine.	Go to
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers	-
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.	-
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.	-
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users	-
warranty	int	0	The coded warranty duration.	Go to
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.	-
weight	int	0	The weight (or dead weight) of the machine	-
width	int	0	The width of the machine	-
yoc	int	0	The year of construction. Use 0 for unknown.	-
yturl	string		A embed-URL to a YouTube-video for this machine	-

Attachment Attributes

Attachment Attributes

Tag	Type	Default	Description	Values
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.
manufacturer	string	X	The manufacturer name of the machine.
toc	int	X	The type of construction of the machine. See Appendix A for possible values.
armbroad	int	0	The fork-width or arm-width
armlength	int	0	The fork-length or arm-length
armsize	int	0	The fork-size or arm-size
available	string	''	The availability of the machine (e.g. "at once")
balancepoint	int	0	The balancepoint of the attachment
buildbroad	int	0	The build-width of the attachment
capacity	int	0	The lifting capacity of the device
carrbroad	int	0	The back width or front-carriage width of the attachment
chassisno	string	''	The chassis (serial-) no. of the machine
custprice	int	0	The end user price for the machine in your selected import-currency
dailyrentprice	int	0	The daily rental price for the machine in your selected import-currency.
dealerprice	int	0	The dealer price for the machine in your selected import-currency
frontend	int	0	The front end measure of the attachment
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!
intprice	Int	0	Your internal price, only visible to you
intranetprice	int	0	The price for the machine in the intranet area your selected import-currency
intraremarks	string	''	Remarks visible in the Intranet-area.
intremarks	string	''	Remarks visible just to you.
isoclass	string	'keine'	The ISO-class of the attachment. Possible values are "2", "3", "4", "Pin-Type"
loadcenter	int	0	The load-center of the machine
loccity	string		The city where the machine is located. Defaults to the user accounts city.
loccountry	int	0	The coded country where the machine is located. This defaults to the country of the user account. For the codes see Appendix H.
locpostcode	string	''	The postcode where the machine is located. Defaults to the user accounts postcode.
model	string	''	The model type of the machine
monthlyrentpr	int	0	The monthly rental price per day for the machine in your selected import-currency.
optcond	int	6	The optical condition of the machine. See Appendix K for values, defaults to “very bad”.
rangefrom	int	0	The minimum opening-width/ roll-diameter/ adjustable range of the attachment
rangeto	int	0	The maximum opening-width/ roll-diameter/ adjustable range of the attachment
remarks	string	''	Remarks visible to dealers
rental	int	0	Set to 1 if the machine is a rental machine
techcond	int	6	The technical condition of the machine. See Appendix K for values, defaults to “very bad”.
techdescr	string	''	A short technical description of the machine
userremarks	string	''	Remarks visible to end users
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.
weight	int	0	The weight (or dead weight) of the machine
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string	''	A embed-URL to a YouTube-video for this machine
tyres2	int	0	The type of back-tires of the machine. Defaults to „unknown“. See Appendix E for valid values.
tyresfront	string	''	Description of the front tyres
tyresrear	string	''	Description of the rear tyres
userremarks	string	''	Remarks visible to end users
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine. Auctions are described in Appendix L.
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
warranty	int	0	The coded warranty duration. See Appendix F for values
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.
weight	int	0	The weight (or dead weight) of the machine
width	int	0	The width of the machine
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string		A embed-URL to a YouTube-video for this machine

Aerial Equipment Attributes

Aerial Equipment Attributes

Tag	Type	Default	Description	Values
enginetype	int	X	The engine type of the machine. See Appendix C for possible values.
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.
manufacturer	string	X	The manufacturer name of the machine.
toc	int	X	The type of construction of the machine. See Appendix A for possible values.
addequip	string	''	Additional equipment of the machine
allwheel	int	0	Set to 1 if the carrier vehicle has all-wheel-drive, set to 2 if the vehicle has chain drive
auctionend	datetime	''	If the machine is in an auction, this is the end datetime of the auction. Auctions are described in Appendix L.
auctionurl	string	''	The URL of the auction. This links to an external auction-site. The URL has to be properly URL-encoded. Auctions are described in Appendix L.
available	string	''	The availability of the machine (e.g. "at once")
basketload	int	0	The basket load of the platform
battery	string	''	Description of the battery (size and age)
capacity	int	0	The lifting capacity of the device
carrvehicle	string	''	The carrier vehicle of the platform (if applicable)
chassisno	string	''	The chassis (serial-) no. of the machine
custprice	int	0	The end user price for the machine in your selected import-currency
dailyrentprice	int	0	The daily rental price for the machine in your selected import-currency.
dealerprice	int	0	The dealer price for the machine in your selected import-currency
height	int	0	The height of the platform or cleaner
hours	int	0	The machine's running hours
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!
intprice	Int	0	Your internal price, only visible to you
intranetprice	int	0	The price for the machine in the intanet area your selected import-currency
intraremarks	string	''	Remarks visible in the Intranet-area.
intremarks	string	''	Remarks visible just to you.
latrange	int	0	The lateral range of the platform
length	int	0	The length of the machine
loccity	string		The city where the machine is located. Defaults to the user accounts city.
loccountry	int	0	The coded country where the machine is located. This defaults to the country of the user account. For the codes see Appendix H.
locpostcode	string		The postcode where the machine is located. Defaults to the user accounts postcode.
model	string	''	The model type of the machine
monthlyrentpr	int	0	The monthly rental price per day for the machine in your selected import-currency.
optcond	int	6	The optical condition of the machine. See Appendix K for values, defaults to “very bad”.
platfeedmot	int	0	The platform feed motion
remarks	string	''	Remarks visible to dealers
rental	int	0	Set to 1 if the machine is a rental machine
techcond	int	6	The technical condition of the machine. See Appendix K for values, defaults to “very bad”.
userremarks	string	''	Remarks visible to end users
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine. Auctions are described in Appendix L.
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.
weight	int	0	The weight (or dead weight) of the machine
width	int	0	The width of the machine
workheight	int	0	The work height of the platform
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string		A embed-URL to a YouTube-video for this machine
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine. Auctions are described in Appendix L.
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
warranty	int	0	The coded warranty duration. See Appendix F for values
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.
weight	int	0	The weight (or dead weight) of the machine
width	int	0	The width of the machine
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string		A embed-URL to a YouTube-video for this machine

Cleaning Technology Attributes

Cleaning Technology Attributes

Tag	Type	Default	Description	Values
enginetype	int	X	The engine type of the machine. See appendix C for possible values.
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.
manufacturer	string	X	The manufacturer name of the machine.
toc	int	X	The type of construction of the machine. See appendix A for possible values.
addequip	string	''	Additional equipment of the machine
areaperformance	int	0	The areaperformance of the machine in m²/h or sqft/h (dependant on your units settings)
auctionend	datetime	''	If the machine is in an auction, this is the end datetime of the auction. Auctions are described in Appendix L.
auctionurl	string	''	The URL of the auction. This links to an external auction-site. The URL has to be properly URL-encoded. Auctions are described in Appendix L.
available	string	''	The availability of the machine (e.g. "at once")
battery	string	''	Description of the battery (size and age)
brushpressure	int	0	The brush pressure of the cleaner
chassisno	string	''	The chassis (serial-) no. of the machine
cleaningwidth	int	0	The cleaning width
custprice	int	0	The end user price for the machine in your selected import-currency
dailyrentprice	int	0	The daily rental price for the machine in your selected import-currency.
dealerprice	int	0	The dealer price for the machine in your selected import-currency
height	int	0	The height of the platform or cleaner
hoppercapacity	int	0	The capacity of the hopper, depending on your units in l or gal.
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!
intprice	Int	0	Your internal price, only visible to you
intranetprice	int	0	The price for the machine in the intranet area your selected import-currency
intraremarks	string	''	Remarks visible in the Intranet-area.
intremarks	string	''	Remarks visible just to you.
length	int	0	The length of the machine
loccity	string		The city where the machine is located. Defaults to the user accounts city.
loccountry	int	0	The coded country where the machine is located. This defaults to the country of the user account. For the codes see Appendix H.
locpostcode	string	''	The postcode where the machine is located. Defaults to the user accounts postcode.
model	string	''	The model type of the machine
monthlyrentpr	int	0	The monthly rental price per day for the machine in your selected import-currency.
optcond	int	6	The optical condition of the machine. See Appendix K for values, defaults to “very bad”.
recoverytank	int	0	The capacity of the recovery tank, depending on your units in l or gal.
remarks	string	''	Remarks visible to dealers
rental	int	0	Set to 1 if the machine is a rental machine
solutiontank	int	0	The capacity of the solution tank, depending on your units in l or gal.
suctionwidth	int	0	The suction width of the cleaner
techcond	int	6	The technical condition of the machine. See Appendix K for values, defaults to “very bad”.
userremarks	string	''	Remarks visible to end users
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine. Auctions are described in Appendix L.
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
weeklyrentpr	Int	0	The weekly rental price per day for the machine in your selected import-currency.
weight	int	0	The weight (or dead weight) of the machine
width	int	0	The width of the machine
workingwidth	int	0	The working width of the machine
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string		A embed-URL to a YouTube-video for this machine

Lifting Mast Attributes

Lifting Mast Attributes

Tag	Type	Default	Description	Values
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.
manufacturer	string	X	The manufacturer name of the machine.
capacity	int	0	The lifting capacity of the device
closedheight	int	0	The closed height of the lifting mast
custprice	int	0	The end user price for the machine in your selected import-currency
dealerprice	int	0	The dealer price for the machine in your selected import-currency
freelift	int	0	The free lift oft the lifting mast
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!
intprice	Int	0	Your internal price, only visible to you
intremarks	string	''	Remarks visible just to you.
liftingheight	int	0	The lifting height of the lifting mast
loccity	string		The city where the machine is located. Defaults to the user accounts city.
loccountry	int	0	The coded country where the machine is located. This defaults to the country of the user account. For the codes see Appendix H.
locpostcode	string		The postcode where the machine is located. Defaults to the user accounts postcode.
masttype	int	0	The mast type. See appendix D for valid values.
model	string	''	The model type of the machine
optcond	int	6	The optical condition of the machine. See Appendix K for values, defaults to “very bad”.
remarks	string	''	Remarks visible to dealers
techcond	int	6	The technical condition of the machine. See Appendix K for values, defaults to “very bad”.
userremarks	string	''	Remarks visible to end users
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
yturl	string		A embed-URL to a YouTube-video for this machine

Battery Attributes

Battery Attributes

Charger Attributes

Charger Attributes

Spare Parts Attributes

Spare Parts Attributes

Construction Equipment Attributes

Construction Equipment Attributes

Tag	Type	Default	Description	Values
enginetype	int	X	The engine type of the machine. See appendix C for possible values.
internalno	string	X	A unique string for you to identify a machine. Don't use special characters like space, %, ?, /, \ etc. because this identifier is also used to attach images to a machine.
manufacturer	string	X	The manufacturer name of the machine.
toc	int	X	The type of construction. See appendix A for possible values.
addequip	string	‘‘	Additional equipment of the machine
attachments	string	''	Attachments of the machine
auctionend	datetime	''	If the machine is in an auction, this is the end datetime of the auction. Auctions are described in Appendix L.
auctionurl	string	''	The URL of the auction. This links to an external auction-site. The URL has to be properly URL-encoded. Auctions are described in Appendix L.
available	string	‘‘	The availability as a string
chassisno	string	‘‘	The chassis (serial-) number of the machine
condition	int	4	The condition of the machine. See appendix B for possible values.
curbweight	int	0	The curb weight of the machine
custprice	int	0	The end user price for the machine in your selected import-currency
dealerprice	int	0	The dealer price for the machine in your selected import-currency
demo	int	0	Set to 1 if this is an intranet demonstration machine. Only shown in intranet and is not meant to be sold but rented for demonstration purposes
height	int	0	The height of the machine
hinges	string	‘‘	The hinges of the machine
hours	Int	0	The machine‘s running-hours
image	string		URL to an image for the machine. The attribute ‘pos’ is mandatory and gives the position of the image in the machines detail view. ‘pos’ has to be a number unique to the machine. If you have special characters in the URL, make sure to properly URL-encode them.
imagelist	string		This is a comma-separated list of image-URLs. You can give multiple URLs here and they are separately processed. This tag is only in effect if there are no tags for the machine. Special characters have to be properly URL-encoded!
intprice	int	0	Your internal price of the machine (only visible to you!)
intranetprice	int	0	The price for the machine in the intranet area your selected import-currency
intraremarks	string	''	Remarks visible in the Intranet-area.
intremarks	string	''	Remarks visible just to you.
length	int	0	The length of the machine
loccity	string		The city where the machine is located. Defaults to the user accounts city.
loccountry	int		The coded country where the machine is located. This defaults to the country of the user account. For the codes see Appendix H.
locpostcode	string		The postcode where the machine is located. Defaults to the user accounts postcode.
model	string	''	The model type of the machine
power	string	‘‘	The engine power of the machine. Please enter the units additionally (e.g. „100 hp“)
remarks	string	''	Remarks visible to dealers
rental	int	0	Set to 1 if the machine is a rental machine
rentprice	int	0	The minimum daily rental price of the machine
userremarks	string	''	Remarks visible to end users
viewauction	int	0	Set to 1 if the machine should be visible as auction-machine. Auctions are described in Appendix L.
viewforklift	int	0	Set to 1 if the machine should be visible in FORKLIFT to dealers
viewintrarent	int	0	Set to 1 if the machine should be visible in the Intranet rental-machine area.
viewintraused	int	0	Set to 1 if the machine should be visible in the Intranet used-machine area.
viewuser	int	0	Set to 1 if the machine should be visible in FORKLIFT to end users
weight	int	0	The maximum allowed weight of the machine
width	int	0	The width of the machine
yoc	int	0	The year of construction. Use 0 for unknown.
yturl	string	‘‘	A embed-URL to a YouTube video for this machine

Forklift Types of construction

Forklift Types of construction

Attachment Types of construction

Attachment Types of construction

Aerial Equipment Types of construction

Aerial Equipment Types of construction

Cleaning Technology Types of construction

Cleaning Technology Types of construction

Lifting Mast Types of construction

Lifting Mast Types of construction

Battery Types of construction

Battery Types of construction

Charger Types of construction

Charger Types of construction

Spare Part Types of construction

Spare Part Types of construction

Construction Equipment Types of construction

Construction Equipment Types of construction

Engine Types

Engine Types

Conditions

Conditions

Here are the values for the attribute "condition":

Tech. and Opt. Conditions

Tech. and Opt. Conditions

Here are the values for the attributes "techcond" and "optcond":

Tyres

Tyres

Warranty

Warranty

Voltages

Voltages

Countries

Countries

Units

Units

In Forklift you can select different units that is shown to you and used when you enter machine data. You cannot mix them! Here they are

Additional Equipment

Additional Equipment

The values you send in the XML are calculated as following. Note that there is only one „addeqbits“ entry per machine.

Example:
Machine with 4th valve (1) and Air-condition (17) = 2^1 + 2^17 = 131074

The correct line would be:

Additional Attachments

Additional Attachments

FORKLIFT also does have some special fields for the most common attachments. These are automatically translated on the website and dealers can search for them. This field can appear several times, see example.

The values you send in the XML are calculated as following. Note that there is only one „attachbit“ entry per machine.

Example:
Machine with Fork extention (7) and Fork clamps (8) = 2^7 + 2^8 = 384

The correct line would be:

Auctions

Auctions

Auctions are a new format. To use them, you have to contact your sales representative to enable it for you. Auctions are only for certain type of machines, namely forklifts, cleaning machines, work platforms and construction equipment.

Every machine that is in an auction needs three additional fields:

• viewauction: set this to 1 to set the machine as an auction-machine.
• auctionurl: URL to the machine on your auction-platform. In XML please take care that this is properly URL-encoded and XML-escaped.
• auctionend: the end date- and time of the auction. After this is reached, the viewauction-flag is cleared. The format of this datetime is: “YYYY-MM-DD HH:MM:SS“.

After an auction is finished, the machine visibility is set to the other given visibilities (be it forklift, rental, enduser). Note that „viewauction“ overrides all other visibilities, no prices will be shown when a machine is in auction-mode.

JSON Interface

JSON Interface

There are 2 further endpoints that help you with your worklflow. Calling convention is like the usual interface, you have to connect using HTTP Basic authentication. These endpoints are rate-limited, maximum rate is 6 requests per minute.

GET /getimagestats.php?id=xxx

GET /getimagestats.php?id=xxx

This endpoint retrieves the state of a queued imageupload. xxx is the queueid that was returned when uploading. The result is:

    
{
  "status": "string",
  "message": "string",
  "success": integer,
  "errors": integer,
  „errorlist“: "string"
}
    

GET /lockstatus.php

GET /lockstatus.php

Returns the lockstatus of the account.

    
{
  "status": "string",
  "reason": "string"
}

    

Auto-Upload-Tool

Auto-Upload-Tool

This interface uses the program cURL, whose license is found in the file curl.copying.txt. Curl is contained in this archive a 64-bit (curl-x64.exe) version for Windows. If you use Linux server-side, please use the binary of your distribution. Curl is contained in the package-management-systems of all major Linux-distributions (Redhat/Fedora, Debian, Ubuntu, Mint, Mandrake, SUSE/openSUSE, Slackware).

Configuration:

The Upload-Tools are split in 6 different areas:

• global (common, see below)
• forklift (forklifts)
• att (attachments)
• clean (cleaning technology)
• mast (lifting masts)
• platform (work platforms)
• battery (batteries)
• charger (battery chargers)

Files exist as shell-scripts (Linux/OSX) and as Windows batchfiles (CMD). You can choose whether you upload your machine-data all at once or split into the different machine types.

Images have to be uploaded for each machine type separately!

In the script-files you find the options to configure. Here enter your username on the second line and your upload-password in forklift-international.com on the third line. In the fourth line enter the filename (in upload.cmd the XML-filename, in imgupload.cmd the ZIP-filename with your images). By calling upload.cmd the update of your data is entered. Already existing images are reconnected to the machines according to their internalno. By calling imgupload.bat you can update or enter your machine images. This file just needs to contain the updated/new images, existing images are reused whenever possible.

Uploading images can take a lot of time, especially on ADSL-Lines (with a 6000 ADSL-Line you will be able to upload 2,5MB per minute, so keep your images small in resolution, 1920x1080 should be maximum). For initial loading or large uploads you can upload images in chunks, e.g. 1 upload for the first 50 or so images, then the next and so on. Please keep in mind, that the “old” Package has to be processed first and that the Filesize of the ZIP-file is limited to 500MB. Forklift will keep the already uploaded images.

There is a special version of the global upload-tool where the images are sent as URLs, see the file xmlimagedemo.xml and the appropriate upload-scripts in the uploadtool/global-folder.

Data Upload

Data Upload

You have different possibilities to upload your data.

• General Upload: Uploads your Forklift, Attachments, Cleaning machines, Access platforms, lifting masts and construction equipment in one step.
• Forklift only
• Attachments only
• Cleaning Machines only
• Access platforms only
• Lifting Masts only
• Batteries only
• Chargers only
• Spare Parts only
• Construction Equipment only

You get examples for automated uploading in the Auto-Upload-Tool archive.

Image Upload

Image Upload

To keep the upload of images simple, you have to follow a few steps.

• 1. The Images have to be in separate ZIP-files according to the machine type (Forklifts, Aerial Equipment, Cleaning Technology, Attachments, Lifting Masts)
• 2. The images have to be in the root-folder of the ZIP-File, Subdirectories won't work.
• 3. The image-name have to follow the following conventions: internalno-imageno.jpg
• 4. The image-number is a number from 1 to 20 (no leading zeroes!)
• 5. Internal Numbers shall not contain spaces or forward- or backward slashes (no / or \), and no special characters. They are case-sensitive.
• 6. Uploaded Images stay on the server as long as the machine does, you don't need to re-upload images that are already in the system.
• 7. To update images, the new image has to have a file date newer than the original file.

The images are placed in a queue. Processing takes place almost instantly, keep in mind that there might be other image uploads pending ahead of yours (first come, first serve). File size is restricted to 1GB.

The status is also returned as a JSON-Object.

    
{
  "status": "ok"|"error",
  "message": "queued",
  "queueid": 4534
}
    

Status can be “ok” or “error”. The message is a textual message describing the result (queued or the error that occurred). If status is ok, you also get a queueid which will help you with further processing as described in the next chapter.

Endpoints

Endpoints

You have different endpoints for each category.

Example for Forklifts would be: https://USERNAME:IMPORTPASSWORD@importapi.forklift-international.com/xmlstapler.php

Image endpoints for each category:

XML Export

XML Export

You also have the opportunity to get an XML export-file with all your machines. You can use this file for an offline-backup of your data or to import the data in your own website. Note that images are NOT exported. However there are

Changelog

Changelog

monthlyrentpr and weeklyrentpr.