inventory/get_profiles.php

author	version	line-number	content
		1	(% class="box" %)
		2	(((
		3	Table of Contents
		4	)))
		5
		6	{{toc/}}
		7
		8	Return the item profiles including assigned detail values.
		9
		10	= Description =
		11
		12	(% class="green mark" %)GET(%%)///inventory/get_profiles.php?company=RTI_COMPANYKEY&import=IMPORTKEY//
		13
		14	= Parameter =
		15
		16	\|=Parameter\|=Descriptions\|=Type\|=Hint\|=Mandatory
		17	\|company\|RTI company key\|string\| \|yes
		18	\|import\|RTI import key\|string\| \|yes
		19	\|offset\| \|unsigned int\|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.\|no
		20	\|profiles[]\|profiles UUID\|[] string\|optional limitation to a list of given profiles\|no
		21	\|objects[]\|objects UUID\|[] string\|optional limitaiton to a list of given items\|no
		22	\|groups[]\|group UUID\|[] string\|optional limitiation to a list of given object groups\|no
		23
		24	= Return value =
		25
		26	On success you will receive the result as json. On missing parameters or errors you will receive "(% class="error" %)ERROR:description(%%)".
		27
		28	== Possible error values ==
		29
		30	\|=Fehler\|=Beschreibung
		31	\|ERROR_MAINTENANCE\|Your company is under maintenance, no RTI request are possible at the moment.
		32	\|INVALID_COMPANY\|Company not found. Company key or import key might be faulty.
		33	\|INVENTORY_NOT_ACTIVATED\|Inventory management is not activated for your company.
		34	\|MISSING_COMPANY\|Company key is missing.
		35	\|MISSING_IMPORT\|Import key is missing.
		36	\|INVALID_FORMAT_OFFSET\|Offset value faulty
		37
		38	= JSON =
		39
		40	You can access the specification as a JSON Schema file [[here>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
		41
		42	Output example
		43
		44	{{code language="js"}}
		45	{
		46	"_date": "2025-02-26T10:26:09+01:00",
		47	"_links": {
		48	"next": {
		49	"href": null
		50	}
		51	},
		52	"profiles": [
		53	{
		54	"uuid": "37550737-e840-e655-a229-0fbdfa84cfb2",
		55	"name": "Standardprofil",
		56	"profileGroup": "",
		57	"details": [
		58	{
		59	"title": "Status",
		60	"dataType": "enum",
		61	"mandantory": false,
		62	"availableAtDisplay": true,
		63	"valueUnit": "default",
		64	"values": [
		65	"Abgesetzt",
		66	"Aufgenommen"
		67	]
		68	}
		69	]
		70	},
		71	{
		72	"uuid": "1190caa5-33f5-5019-260f-0cae3d4f5277",
		73	"name": "Leasing",
		74	"profileGroup": "Finanzen",
		75	"details": [
		76	{
		77	"title": "Anzahlung",
		78	"dataType": "float",
		79	"mandantory": true,
		80	"availableAtDisplay": false,
		81	"valueUnit": "EUR",
		82	"values": []
		83	},
		84	{
		85	"title": "Rate",
		86	"dataType": "float",
		87	"mandantory": true,
		88	"availableAtDisplay": false,
		89	"valueUnit": "EUR",
		90	"values": []
		91	},
		92	{
		93	"title": "Abschlußrate",
		94	"dataType": "float",
		95	"mandantory": true,
		96	"availableAtDisplay": false,
		97	"valueUnit": "EUR",
		98	"values": []
		99	},
		100	{
		101	"title": "Vertragsbeginn",
		102	"dataType": "date",
		103	"mandantory": false,
		104	"availableAtDisplay": false,
		105	"valueUnit": null,
		106	"values": []
		107	},
		108	{
		109	"title": "Vertragsende",
		110	"dataType": "date",
		111	"mandantory": false,
		112	"availableAtDisplay": false,
		113	"valueUnit": null,
		114	"values": []
		115	},
		116	{
		117	"title": "Leasinggeber",
		118	"dataType": "text",
		119	"mandantory": false,
		120	"availableAtDisplay": false,
		121	"valueUnit": null,
		122	"values": []
		123	}
		124	]
		125	}
		126	]
		127	}
		128	{{/code}}
		129
		130	= Example calls =
		131
		132	{{code language="java"}}
		133	https://map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
		134	{{/code}}

Wiki source code of inventory/get_profiles.php