{"id":4543,"date":"2017-04-21T08:16:21","date_gmt":"2017-04-21T08:16:21","guid":{"rendered":"http:\/\/www.fmsdocumentation.com\/history-api\/"},"modified":"2018-06-04T10:53:38","modified_gmt":"2018-06-04T10:53:38","slug":"history-api","status":"publish","type":"page","link":"https:\/\/www.fmsdocumentation.com\/pl\/apis\/history-api\/","title":{"rendered":"API historycznych wsp\u00f3\u0142p\u00f3\u0142rz\u0119z\u0119ddnych obiektu"},"content":{"rendered":"

G\u0142\u00f3wnym celem interfejsu API historycznych wsp\u00f3\u0142rz\u0119dnych obiektu (Object Coordinates History API) jest wyprowadzanie danych (wsp\u00f3\u0142rz\u0119dnych) historycznych dla obiekt\u00f3w klient\u00f3w. API historycznych wsp\u00f3\u0142rz\u0119dnych obiektu posiada dwa punkty ko\u0144cowe, dlatego obs\u0142uguje dwa typy \u017c\u0105da\u0144. Pierwszy typ \u017c\u0105dania dotyczy jednego obiektu oraz okre\u015blonej daty i godziny. Wy\u015bwietlane s\u0105 tutaj tylko dane zarejestrowane w okre\u015blonym dniu i czasie.<\/p>\n

Przyk\u0142ad \u017c\u0105dania dotycz\u0105cego okre\u015blonej daty:<\/p>\n

GET \/objects\/{object_id}\/coordinates\/{datetime}?version=1&api_key=<…>
\nHOST:api.fm-track.com
\nContent-Type:application\/json;charset=UTF-8<\/p>\n

W przypadku tego typu \u017c\u0105dania API, aby zapytanie by\u0142o efektywne, wymaga podania trzech parametr\u00f3w (nie licz\u0105c klucza API):<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t
Parameter<\/th>Type<\/th>Description<\/th>\n<\/tr>\n<\/thead>\n
object_id<\/td>String<\/td>External object ID<\/td>\n<\/tr>\n
datetime<\/td>Date time<\/td>Requested record for the specified date and time. Date and time format example: \u201c2017-04-13T06:58:48.090Z\u201d in accordance to the ISO-8601 standard<\/td>\n<\/tr>\n
version<\/td>String<\/td>Version of the API, currently only version=1 is available<\/td>\n<\/tr>\n
api_key<\/td>String<\/td>User identification key<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Uwaga
\nZaleca si\u0119 u\u017cywanie parametru \u201edatetime\u201d z drugiego punktu ko\u0144cowego interfejsu API historycznych wsp\u00f3\u0142rz\u0119dnych obiektu, poniewa\u017c parametr \u201edatetime\u201d jest okre\u015blony przez drugi, i system nie wyszukuje danych w okolicach okre\u015blonej daty.<\/p><\/p>\n

Je\u015bli wszystkie parametry zosta\u0142y uwzgl\u0119dnione, a klucz API_ jest poprawny, wy\u015bwietlany jest poni\u017cszy przyk\u0142ad odpowiedzi:<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<\/div><\/td>
{<\/span>
\n"object_id"<\/span> :<\/span> "abc123"<\/span>,<\/span>
\n"datetime"<\/span> :<\/span> "2017-04-13T06:58:48.090Z"<\/span>,<\/span>
\n"ignition_status"<\/span> :<\/span> "UNKNOWN"<\/span>,<\/span>
\n"position"<\/span> :<\/span> {<\/span>
\n"altitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"direction"<\/span> :<\/span> 0<\/span>,<\/span>
\n"latitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"longitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"satellites_count"<\/span> :<\/span> 0<\/span>,<\/span>
\n"speed"<\/span> :<\/span> 0<\/span>
\n}<\/span>,<\/span>
\n"device_inputs"<\/span> :<\/span> {<\/span>
\n"digital_input_1"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_2"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_3"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_4"<\/span> :<\/span> true<\/span>,<\/span>
\n"power_supply_voltage"<\/span> :<\/span> 0<\/span>,<\/span>
\n"ibutton"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"first_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"second_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>
\n}<\/span>,<\/span>
\n"calculated_inputs"<\/span>:<\/span>{<\/span>
\n"mileage"<\/span> :<\/span> 0<\/span>
\n}<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Je\u015bli parametr lub klucz API zosta\u0142 wprowadzony niepoprawnie, system wy\u015ble odpowied\u017a w postaci kodu b\u0142\u0119du \u2013 wszystkie mo\u017cliwe kody b\u0142\u0119d\u00f3w s\u0105 opisane w sekcji dotycz\u0105cej API. Parametry s\u0105 opisane na ko\u0144cu niniejszej sekcji.<\/p>\n

Drugi punkt ko\u0144cowy interfejsu \u201eHistory API\u201d wy\u015bwietla tablic\u0119 danych historycznych dla okre\u015blonego przedzia\u0142u czasowego. Ka\u017cdy zestaw danych ma okre\u015blon\u0105 dat\u0119 i godzin\u0119, kt\u00f3re mo\u017cna wykorzysta\u0107 podczas wysy\u0142ania \u017c\u0105dania interfejsu \u201eHistory API\u201d pierwszego typu .<\/p>\n

Przyk\u0142ad zapytania dotycz\u0105cego okre\u015blonego przedzia\u0142u dat:<\/p>\n

GET \/objects\/{object_id}\/coordinates?version=1{&from_datetime,to_datetime,continuation_token,limit}&api_key=<…>
\nHOST:api.fm-track.com
\nContent-Type:application\/json;charset=UTF-8<\/p>\n

W przypadku tego typu \u017c\u0105dania API, aby zapytanie by\u0142o efektywne, nale\u017cy poda\u0107 trzy parametry (nie licz\u0105c klucza API):<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t
Parameter<\/th>Type<\/th>Description<\/th>\n<\/tr>\n<\/thead>\n
objectId<\/td>String<\/td>External object ID<\/td>\n<\/tr>\n
fromDatetime<\/td>Date time<\/td>Find records starting from the specified date and time. Date and time format example: \u201c2017-04-13T06:58:48.090Z\u201d in accordance to the ISO-8601 standard<\/td>\n<\/tr>\n
version<\/td>String<\/td>Version of API<\/td>\n<\/tr>\n
api_key<\/td>String<\/td>User identification key<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Opcjonalne parametry, kt\u00f3re nie s\u0105 obowi\u0105zkowe, ale mo\u017cna je uwzgl\u0119dni\u0107 w \u017c\u0105daniu:<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t
Parameter<\/th>Type<\/th>Description<\/th>\n<\/tr>\n<\/thead>\n
toDatetime<\/td>Date time<\/td>Find records up until the specified date and time. If it is not specified, the system will search for records up until the current date until the limit of records is reached. Date and time format example: \u201c2017-04-13T06:58:48.090Z\u201d in accordance to the ISO-8601 standard<\/td>\n<\/tr>\n
continuationToken<\/td>Date time<\/td>Including a continuation token, will display the next set of records, after the previous limit of records was reached. <\/td>\n<\/tr>\n
limit<\/td>Integer<\/td>Limits records to the set count in the system response (default value \u2013 100 records, maximum value \u2013 1000)<\/td>\n<\/tr>\n
api_key<\/td>String<\/td>User identification code<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Poni\u017cej przedstawiono przyk\u0142ad odpowiedzi:<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<\/div><\/td>
{<\/span>
\n"continuation_token"<\/span>:<\/span> "2017-04-13T06:58:48.121Z"<\/span>,<\/span>
\n"items"<\/span>:<\/span> [<\/span>
\n{<\/span>
\n"object_id"<\/span> :<\/span> "abc123"<\/span>,<\/span>
\n"datetime"<\/span> :<\/span> "2017-04-13T06:58:48.090Z"<\/span>,<\/span>
\n"ignition_status"<\/span> :<\/span> "UNKNOWN"<\/span>,<\/span>
\n"position"<\/span> :<\/span> {<\/span>
\n"altitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"direction"<\/span> :<\/span> 0<\/span>,<\/span>
\n"latitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"longitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"satellites_count"<\/span> :<\/span> 0<\/span>,<\/span>
\n"speed"<\/span> :<\/span> 0<\/span>
\n}<\/span>,<\/span>
\n"device_inputs"<\/span> :<\/span> {<\/span>
\n"digital_input_1"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_2"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_3"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_4"<\/span> :<\/span> true<\/span>,<\/span>
\n"power_supply_voltage"<\/span> :<\/span> 0<\/span>,<\/span>
\n"ibutton"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"first_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"second_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>
\n}<\/span>,<\/span>
\n"calculated_inputs"<\/span>:<\/span>{<\/span>
\n"mileage"<\/span> :<\/span> 0<\/span>
\n}<\/span>
\n}<\/span>
\n]<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Poni\u017csza tabela przedstawia wszystkie pola odpowiedzi, kt\u00f3re mog\u0119 by\u0107 otrzymane dla ka\u017cdego rodzaju parametru:<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t
Name<\/th>Type<\/th>Description<\/th>Units<\/th>\n<\/tr>\n<\/thead>\n
continuation_token<\/td><\/td>Continuation token is received when requesting large amounts of records, for long periods, which exceeds the set records limit, the continuation token will be displayed at the end of the response. It can be used afterwards to display the next set of records for the selected period. If no more records are available after the token, the response will return empty.<\/td>Datetime<\/td>\n<\/tr>\n
device_inputs<\/td>Array<\/td>Container for parameters received from hardware<\/td><\/td>\n<\/tr>\n
calculated_inputs<\/td>Array<\/td>Container for parameters calculated in system from other parameters according to the configuration<\/td><\/td>\n<\/tr>\n
items<\/td>Array<\/td>Contains all parameters in accordance to the request<\/td><\/td>\n<\/tr>\n
object_id<\/td>String<\/td>Object identifier (external)<\/td>Text<\/td>\n<\/tr>\n
datetime<\/td>Date<\/td>Date and time point of coordinate generated in hardware
\nFormat: \"yyyy-mm-ddThh:mm:ss.sssZ\"
\n<\/td>		According ISO-8601<\/td>\n<\/tr>\n
longitude<\/td>Float<\/td>GPS coordinate - longitude value<\/td>Degrees<\/td>\n<\/tr>\n
latitude<\/td>Float<\/td>GPS coordinate - latitude value<\/td>Degrees<\/td>\n<\/tr>\n
altitude<\/td>Integer<\/td>GPS coordinate - altitude value<\/td>Number<\/td>\n<\/tr>\n
speed<\/td>Integer<\/td>Object moving speed<\/td>km\/h<\/td>\n<\/tr>\n
direction<\/td>Integer<\/td>Moving direction in degrees<\/td>0 = north, increasing clock-wise<\/td>\n<\/tr>\n
ignition_status<\/td>Enum<\/td>Indicating if object has ignition on.
\n\"ON\" - Ignition on
\n\"OFF\" - Ignition off
\n\"UNKNOWN\" - No data about ignition
\n<\/td>		ON- OFF <\/td>\n<\/tr>\n
digital_input_1<\/td>Boolean<\/td>Configurated object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_2<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_3<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_4<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
ibutton<\/td>String<\/td>iButton or RFID card code of a driver assigned to a vehicle<\/td>Text<\/td>\n<\/tr>\n
first_driver_id<\/td>String<\/td>TCO code of the first driver<\/td>Text<\/td>\n<\/tr>\n
second_driver_id<\/td>String<\/td>TCO code of the second driver<\/td>Text<\/td>\n<\/tr>\n
satellites_count<\/td>Integer<\/td>Number of visible GPS or GLONASS satellites(depends on device configuration) while generating record in device<\/td>Number<\/td>\n<\/tr>\n
mileage<\/td>Float<\/td>Object driven distance (depends on object configuration)<\/td>km<\/td>\n<\/tr>\n
power_supply_voltage<\/td>Integer<\/td>Object power supply voltage<\/td>mV<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Punkty ko\u0144cowe interfejsu API, parametry \u017c\u0105dania i komunikaty zwrotne mo\u017cna przegl\u0105da\u0107 przy pomocy edytora \u201eSwagger\u201d za po\u015brednictwem: https:\/\/api.fm-track.com<\/a><\/p>\n

\n

\u2039   <\/span> API <\/a><\/div>
API wsp\u00f3\u0142rz\u0119p\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym  \u203a <\/span> <\/a><\/div><\/p>\n","protected":false},"excerpt":{"rendered":"

G\u0142\u00f3wnym celem interfejsu API historycznych wsp\u00f3\u0142rz\u0119dnych obiektu (Object Coordinates History API) jest wyprowadzanie danych (wsp\u00f3\u0142rz\u0119dnych) historycznych dla obiekt\u00f3w klient\u00f3w. API historycznych wsp\u00f3\u0142rz\u0119dnych obiektu posiada dwa punkty ko\u0144cowe, dlatego obs\u0142uguje dwa typy \u017c\u0105da\u0144. Pierwszy typ \u017c\u0105dania dotyczy jednego obiektu oraz okre\u015blonej daty i godziny. Wy\u015bwietlane s\u0105 tutaj tylko dane zarejestrowane w okre\u015blonym dniu i czasie. Przyk\u0142ad … Czytaj dalej API historycznych wsp\u00f3\u0142p\u00f3\u0142rz\u0119z\u0119ddnych obiektu<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":4544,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-4543","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4543","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/comments?post=4543"}],"version-history":[{"count":2,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4543\/revisions"}],"predecessor-version":[{"id":5213,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4543\/revisions\/5213"}],"up":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4544"}],"wp:attachment":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/media?parent=4543"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}