FUNCTION

get_datalist_scenes.php

Function description:

fetch list of scene information

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
skeys	string	0-1000 characters	Search keys. Separated by ";". Allowed values are: id; name; category_master; category; transname and whatever was added as custom values into our data_json field - please use the get_datalist_scenes_extinfo.php script to find available fields with extra info for your scenes. To search for extra info keys, use "extinfo_" as prefix for that field, e.g.: extinfo_brand
svals	string	0-1000 characters	Search values. Separated by ";". The same quantity (number of ";") and order as used in skeys are needed! Possible values can be found by using the get_datalist_searchvals.php script.
sorder	string	0-1000 characters	Sort order. Defaults to "sequence". Allowed values are: id; name; category_master; category and whatever was added as custom values into our data_json field - please use the get_datalist_scenes_extinfo.php script to find available fields with extra info for your scenes. To search for extra info keys, use "extinfo_" as prefix for that field, e.g.: extinfo_brand
frmt	string	0-10 characters	Return format. If "xml" is given, XML output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object

Try out in this jsfiddle:

See "in action" in this jsfiddle:

FUNCTION

get_datalist_scenes_extinfo.php

Function description:

fetch list of scene extra information

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
skeys	string	0-1000 characters	Search keys. Separated by ";". Allowed values are: id; name; category_master; category and whatever was added as custom values into our data_json field - please use this script with only the cnf parameter to find available fields with extra info for your scenes. To search for extra info keys, use "extinfo_" as prefix for that field, e.g.: extinfo_brand
svals	string	0-1000 characters	Search values. Separated by ";". The same quantity (number of ";") and order as used in skeys are needed!
frmt	string	0-10 characters	Return format. If "xml" is given, XML output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object

Try out in this jsfiddle:

FUNCTION

get_img_scene.php

Function description:

fetch image of empty scene

Input:

Variable	Type	Size	Description
cnf	string	0-100 characters	Your configuration name as given by active online GmbH
sid	string	1-100 characters	The ID of the scene you want the image of. These IDs can be found via the get_datalist_scenes script.
imgnam	string	4-150 characters	DEPRECATED - WILL BE REMOVED IN NEXT RELEASE! image name
view	integer	0-9	View number, defaults to first view = 0, usually most scenes have either 1 or 3 views, so numbers will range from 0 to 2 most of the time.
w	integer	16-512	Width of the image size you want returned. This and height have to be given together.
h	integer	16-512	Height of the image size you want returned. This and width have to be given together.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

Image from fileserver

Try out in this jsfiddle:

DEMONSTRATION

all scripts working together

Function description:

In this jsfiddle we show you all the scripts working together to build one (rudimentary) application.

See "in action" in this jsfiddle:

FUNCTION

get_img_object.php

Function description:

fetch an image identifying scene object

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
oid	string	0-100 characters	This is the ID of the object you want the image of. It can be found out via the get_datalist_objects.php script.
view	integer	0-9	View number, defaults to first view = 0, usually most scenes have either 1 or 3 views, so numbers will range from 0 to 2 most of the time.
w	integer	16-512	Width of the image size you want returned. This and height have to be given together.
h	integer	16-512	Height of the image size you want returned. This and width have to be given together.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

Image from fileserver

Try out in this jsfiddle:

FUNCTION

get_datalist_objects.php

Function description:

fetch list of scene objects

Input:

Variable	Type	Size	Description
sid	string	1-100 characters	The ID of the scene you want details to. These IDs can be found via the get_datalist_scenes.php script.
view	integer	0-9	View number, defaults to first view = 0, usually most scenes have either 1 or 3 views, so numbers will range from 0 to 2 most of the time.
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
frmt	string	0-10 characters	Return format. If "xml" is given, XML output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object

Try out in this jsfiddle:

FUNCTION

get_datalist_materials.php

Function description:

With this script you can fetch a list of all available materials or use search parameters to filter the list for needed materials only.

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
skeys	string	0-1000 characters	Search keys. Separated by ";". Allowed values are: id; category_master; category; unique_key; producer; collection; article_nr; search_code; info; subfolder; texture_filename; app_header; app_data; data_header; data_data; filename; uses; search_criteria_1 .. search_criteria_30 (will be extended up to search_criteria_40 in the near future)
svals	string	0-1000 characters	Search values. Separated by ";". The same quantity (number of ";") and order as used in skeys are needed! Possible values can be found by using the get_datalist_searchvals.php script.
sorder	string	0-1000 characters	Sort order. Defaults to "sequence" with "article_nr" fallback. Allowed values are: id; category_master; category; unique_key; producer; collection; article_nr; search_code; subfolder; texture_filename
cols	string	0-1000 characters	Columns from database, that should also be returned. Separated by ";". Allowed values are: id; category_master; category; unique_key; producer; collection; article_nr; search_code; info; subfolder; texture_filename; app_header; app_data; data_header; data_data; filename; uses; search_criteria_1 .. search_criteria_30 (will be extended up to search_criteria_40 in the near future)
page	integer	0-10.000	Page number to show. This of course depends on the number of results and the set limit.
limit	integer	0-2000	Limit to the number of returned results.
frmt	string	0-10 characters	Return format. If "xml" or "csv" is given, XML or CSV output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object
maximum of 2000 entries at once, paging needed if more

Try out in this jsfiddle:

See "in action" in this jsfiddle:

FUNCTION

get_data_material_detail.php

Function description:

get detailed data for a single material

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
mid	string	1-100 characters	The material ID you want details to. These IDs can be found via the get_datalist_materials.php script.
artnr	string	0-255 characters	Article number. This can be given instead of mid. We suggest you use this in combination with the optional prod parameter, to ensure the correct material. Article number on its own might not be a unique information!
prod	string	0-255 characters	Name of the producer of the material. Though this parameter is optional, we strongly suggest you use it, if you decide to identify a material by its artnr.
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
frmt	string	0-10 characters	Return format. If "xml" is given, XML output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object

Try out in this jsfiddle:

FUNCTION

get_datalist_searchvals.php

Function description:

get detailed data for a single material

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
col	string	0-255 characters	This is the database column of which you want to get the searchvalues listed.
skeys	string	0-1000 characters	Search keys. Separated by ";". Allowed values are: id; category_master; category; unique_key; producer; collection; article_nr; search_code; subfolder; texture_filename; app_header; app_data; data_header; data_data; filename; uses; search_criteria_1 .. search_criteria_30 (will be extended up to search_criteria_40 in the near future)
svals	string	0-1000 characters	Search values. Separated by ";". The same quantity (number of ";") and order as used in skeys are needed!
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
frmt	string	0-10 characters	Return format. If "xml" is given, XML output will be generated instead of the default JSON.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

JSON object

Try out in this jsfiddle:

FUNCTION

get_img_material.php

Function description:

fetch image of material

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
mid	string	1-100 characters	The material ID you want the image of. These IDs can be found via the get_datalist_materials.php script.
artnr	string	0-255 characters	Article number. This can be given instead of mid. We suggest you use this in combination with the optional prod parameter, to ensure the correct material. Article number on its own might not be a unique information!
prod	string	0-255 characters	Name of the producer of the material. Though this parameter is optional, we strongly suggest you use it, if you decide to identify a material by its artnr.
w	integer	16-2048	Width of the image size you want returned. This and height have to be given together.
h	integer	16-2048	Height of the image size you want returned. This and width have to be given together.
show3d	integer	0-1	Show a 3D thumbnail if 1 is given. Show a 2D thumbnail otherwise.
halign	string	"left", "center" or "right"	Horizontal align of the image. Defaults to "center".
valign	string	"top", "center" or "bottom"	Vertical align of the image. Defaults to "center".
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

Image from fileserver

Try out in this jsfiddle:

FUNCTION

render_img_scene.php

Function description:

render complete scene

Input:

Variable	Type	Size	Description
cnf	string	1-100 characters	Your configuration name as given by active online GmbH
sid	string	1-100 characters	The ID of the scene you want details to. These IDs can be found via the get_datalist_scenes script.
snam	string	0-255	DEPRECATED - WILL BE REMOVED IN NEXT RELEASE! scene name, alternative to sid
mid	string	0-255 characters	The material IDs you want to map on the scene. Separate multiple by ";". These IDs can be found via the get_datalist_materials.php script.
artnr	string	0-255 characters	Article number. This can be given instead of mid. We suggest you use this in combination with the optional prod parameter, to ensure the correct material. Article number on its own might not be a unique information!
prod	string	0-255 characters	Name of the producer of the material. Though this parameter is optional, we strongly suggest you use it, if you decide to identify a material by its artnr.
pid	string	0-10 characters	Project ID. The alphanumerical ID of a saved project, used to render this project. This can be used instead of sid AND mid.
lng	string	2-3 characters	Language defaults to "EN" and falls back to "EN", if there is no value for the given language in our database. Our supported languages via their country code are: bg - bulgarian; cn - chinese; cz - czech; de - german; dk - dansk; en - english; es - spanish; fin - finnish; fr - french; gr - greek; hr - croatian; hu - hungarian; it - italian; nl - dutch; no - norwegian; pl - polish; pt - portuguese; ro - romanian; ru - russian; si - slovenian; rs - serbian; se - swedish; tr - turkish
view	integer	0-9	View number, defaults to first view = 0, usually most scenes have either 1 or 3 views, so numbers will range from 0 to 2 most of the time.
onam	string	0-255 characters	Object names. To map materials to objects in a scene, give them in the same order as the materials you want mapped on them, separated by ";"
rot	string	0-255 characters	Rotations. Set a ";" separated list with the same number as the materials in "mid" to rotate these materials for a given amount. For example: 45;90;0
ofit	integer	0-1	Set this to 1 if you want outer fit. This means the image will be scaled so it will fit the entire width and height you provided. If set to 0 or left out, the image will scale while keeping its aspect ratio to stay inside the width and height. It will probably bill smaller than one of the two dimensions you supplied.
overuse	integer	0-1	Override uses. This will map materials to objects regardless of if they are allowed there based on their uses.
overorder	integer	0-1	Override order. If set to 1 objects will be mapped in the order of the given materials instead of everywhere they are allowed via their uses.
w	integer	0-6000	Width of the image size you want returned. This and height have to be given together.
h	integer	0-6000	Height of the image size you want returned. This and width have to be given together.
dbg	integer	0-1	0 results in normal operation, 1 results in debug output instead.

Output:

Image from render server