Changes for page address_management/set_area.php

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,17 +1,22 @@
1	1	(% class="box" %)
2		-(((Table of Contents)))
	2	+(((
	3	+Table of Contents
	4	+)))
	5	+
3	3	{{toc/}}
4	4
5	5	This function allows you to create, update and delete server-based territories.
	9	+
6	6	= Description =
7		-//**(% class="blue mark" %)POST(%%) **///**address_management**/**set_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&type**=square**&coordinates**=[{"lat":13.33889,"lon":50.89091}]**&name**=name**&costCenter**=kosten**&useInTimeRecording**=0**&useInMap**=0**&mode**=create**&category**=passive
	11	+
	12	+(% class="blue mark" %)//**POST**//(%%)//** **///**address_management**/**set_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&type**=square**&coordinates**=[{"lat":13.33889,"lon":50.89091}]**&name**=name**&costCenter**=kosten**&useInTimeRecording**=0**&useInMap**=0**&mode**=create**&category**=passive
	13	+
8	8	= Parameter =
9	9
10	10	|=Parameter|=Description|=Type|=Note|=Obligation
11		-|company|RTI Company key|string||yes
12		-|import|RTI Import key|string||yes
13		-|mode|Distinguishing between the different actions|string|Parameter
14		-(((
	17	+|company|RTI Company key|string| |yes
	18	+|import|RTI Import key|string| |yes
	19	+|mode|Distinguishing between the different actions|string|Parameter(((
15	15	* create = Create new area
16	16	* update =Update area
17	17	* delete = Delete area
...	...	@@ -18,28 +18,24 @@
18	18	)))|yes
19	19	|category|Area category|string|is currently always 'passive|yes
20	20	|uuid|For the unique identification of the area|string|Mandatory for update and delete mode|yes
21		-|type|Type of area|string|Optional parameter
22		-(((
	26	+|type|Type of area|string|Optional parameter(((
23	23	* polygon
24	24	* polyline
25	25	* square
26	26	)))|yes(1)
27	27	|coordinates|Latitude/Longitude
28		-Example:[{"lat":13.33889,"lon":50.89091},{"lat":13.32491,"lon":50.89091},{"lat":13.32491,"lon":50.89989},{"lat":13.33889,"lon":50.89989}]|string|Coordinates for the area type:
29		-(((
	32	+Example:[{"lat":13.33889,"lon":50.89091},{"lat":13.32491,"lon":50.89091},{"lat":13.32491,"lon":50.89989},{"lat":13.33889,"lon":50.89989}]|string|Coordinates for the area type:(((
30	30	* polygon = minimum 3
31	31	* polyline = minimum 2
32	32	* square  = Exactly one coordinate
33	33	)))|yes(1)(2)
34	34	|name|Area name|string|max. 50 Characters|yes(1)(2)
35		-|costCenter|Cost centre|integer||no
36		-|useInTimeRecording|Should the area be displayed in the time recording?|integer|Optional Parameter
37		-(((
	38	+|costCenter|Cost centre|integer| |no
	39	+|useInTimeRecording|Should the area be displayed in the time recording?|integer|Optional Parameter(((
38	38	* 0 (Standard) =Do not show area in time recording
39	39	* 1 = Show area in time recording
40	40	)))|no
41		-|useInMap|Should the area be displayed on the map?|integer|Optional Parameter
42		-(((
	43	+|useInMap|Should the area be displayed on the map?|integer|Optional Parameter(((
43	43	* 0 (Standard) =Do not show area on map
44	44	* 1 = Show area in map
45	45	)))|no
...	...	@@ -48,22 +48,26 @@
48	48
49	49	Notes:
50	50	1) Mandatory in 'create' mode
51		-2)  Optional in 'update' mode//
52		-//
	52	+2)  Optional in 'update' mode
53	53
54	54	= Return =
	55	+
55	55	A string is returned. Otherwise a "(% class="error" %)**ERROR:Description**(%%)" returned
56		-=== Parameter ===
	57	+
	58	+== Parameter ==
	59	+
57	57	|=Parameter|=Description|=Type
58	58	|uuid|To clearly identify the area|string
59	59	|status|Outputs OK if the action performed was successful|string
60	60
61		-=== JSON Format ===
	64	+== JSON Format ==
62	62
63		-{{code language="java"}} {
	66	+{{code language="java"}}
	67	+ {
64	64	"uuid": "ABC-123-DEF",
65	65	"status": "OK"
66		- }{{/code}}
	70	+ }
	71	+{{/code}}
67	67
68	68	= Examples =
69	69