Page Comparison

End point:

https://gps.freetrack.com.ua/api/

...

• create-geozones- створення множини геозон

• update-geozones- оновлення множини геозон

Приклади використання

_{*червоні параметри є обов'язковими}

Кожен об'єкт даних для створення геозони, може містити наступні елементи в самому запиті:

"externalID" - це не обов'язковий атрибут (зовнішій ID геозони у Вашій системі), буде повернуто для спрощення ідентифікації даних.

_*"name" - назва бажаної геозони, в нашій системі, вона унікальна в рамках компанії. Кожна новостворена геозона буде додана до поточної компанії користувача, що виконав запит.

_*"geozoneID" - наш внутрішній ID геозони, це поле використовується тільки під час оновлення геозони.

_*"data" - координати полігональної геозони, мінімальна кількість 3 одиниці.

_*"latitude, longitude" - координати центру радіальної геозони.

_*"radius" - радіус радіальної геозони (мінімальне значення - 1, значення вказується в метрах).

_*"type" - тип геозони в нашій системі, обов'язкове поле, як для створення так і для оновлення, бо при оновлені можна змінити тип геозони - [circle або polygon].

...

"specialTypeExtend" - описує розширені характеристики для “extended“ геозон.

Приклад правильного запиту для створення геозон:

[{
    "name":"test-1",
    "type":"polygon",
    "externalID":475214,
    "data":[
        ["49.108622", "25.3085"],
        ["49.109584511", "25.3085060"],
        ["49.104454", "25.309"]
        ]
    },
    {"name":"test-2",
     "type":"circle",
     "externalID": 75112,
     "latitude": "49.82646690800183",
     "longitude": "23.95317792892456",
     "radius": 17,
     "specialType" : "special"
    },
    {"name":"test-3",
    "type":"polygon",
    "data":[
        ["49.10", "28.3085"],
        ["49.1095", "28.3085060"],
        ["49.107", "28.309"]
        ],
    "specialType" : "extended",
    "specialTypeExtend":{
		"multi":{
			"mixed":1,
			"paper":2,
			"plastic":3,
			"glass":4
		}
     }
   }
]

Приклад правильного запиту для оновлення геозон:

[{
    "name":"test-6",
    "type":"polygon",
    "geozoneID":777,
    "externalID":475214,
    "data":[
        ["49.108622", "25.3085"],
        ["49.109584511", "25.3085060"],
        ["49.104454", "25.309"]
    ]
    },
    {
    "name":"test-7",
    "type":"circle",
    "geozoneID": 555,
    "latitude": "50.8264669",
    "longitude": "25.95922456",
    "radius": 17,
    "specialType" : "extended",
    "specialTypeExtend":{"private":5}
    }
    ]

Приклад правильної відповіді

{
    "result": "ok",
    "response": [
        {
            "result": true,
            "name": "test-1",
            "externalID": 475214,
            "geozoneID": 10288
        },
        {
            "result": true,
            "name": "test-2",
            "externalID": 75112,
            "geozoneID": 10289
        },
        {
            "result": true,
            "name": "test-3",
            "geozoneID": 10290
        }
    ]

Приклад неправильних відповідей

{
    "result": "ok",
    "response": [
        {
            "result": false,
            "name": "test-1",
            "externalID": 475214,
            "errorMessage": "The name of geozone should be unique!"
        }
    ]
}

...

Це пов'язано з тим, що якусь кількість геозон може бути все таки створено/оновлено. Результат кожної операції слід перевіряти на значення "result" в кожному повернутому елементі. Також в кожному елементі може бути властивість з ключем -"errorMessage" , це - опис помилки, якщо "result" = false.

Типи можливих помилок

...