Skip to main content
Sign in

API Reports Manual

Marisa Potgieter
  • Updated

API reports manual

Rapporthåndtering

Reports API består af 3 funktioner:

  • Api/Reports/listReports - få ID-er af dine rapporter
  • Api/Reports/getReportConf - få rapportdetaljer: understøttede parametre, parameterformatering, andre tilgængelige formateringsmuligheder
  • Api/Reports/getReport - få faktiske rapportdata

Prerequisites

  • Organisationen har rapportmodulet aktiveret
  • API-bruger  - brugerrollen skal have tilladelse til at få adgang til rapportmodulet såvel som individuelle rapporter.

Api/Reports/listReports

Brødteksten i anmodningen kræver ikke yderligere parametre

Eksempel API-kald:

app.ecofleet.com/seeme/Api/Reports/listReports?key=API_KEY

Svar XML:

    0                         NewDayReport -- unique report ID (to be used  as parameter  in getConfReport call )             Day report -- report name in language, which is set in API user preferences                             newTasksReport             Tasks report             -- element is ONLY visible for User Defined reports                                     9b7a907f-3f90-412c-9abf-93f28fad385c -- stateId value for getReport                     User defined report -- name of custom report                                                         booking             Booking report                

Svar JSON:

{ "status":0, "response":{   "NewDayReport":{     "id":"NewDayReport",     "title":"Day report"   },   "NewPeriodReport":{     "id":" newTasksReport",     "title":"Period report",     "states":[{         "id":”9b7a907f-3f90-412c-9abf-93f28fad385c”,         "title":" User defined report "       }]

},   "booking":{     "id":"booking",     "title":"Booking report"   } } }

Fejlfinding

Her er løsninger på nogle problemer.

  • Fejlmeddelelse "ingen tilladelse": Der er ikke tildelt noget rapportmodul til API-brugeren. Tilføj det venligst via roller. Hvis din organisation ikke har et rapportmodul, så spørg det via salgschef eller teknisk support.
  • tomt svar: Der er intet rapportmodul delt ud til API-brugere via roller.
  • din rapport er ikke på listen: Del den pågældende rapport med API-brugeren via roller. Hvis en rapport stadig ikke er tilgængelig, er den muligvis ikke aktiveret for din organisation. Kontakt venligst din salgsrepræsentant eller kundesupport.

Api/Reports/getReportConf

Brødteksten i anmodningen kræver ID-parameter, som kan tages fra getReports … node

Eksempel API-kald:

app.ecofleet.com/seeme/Api/Reports/getReportConf?id=newTasksReport&proto=&key=API_KEY

Svar XML:

    0                 newTasksReport         Tasks report                                     begTimestamp                 date                 Y-m-d                                                                                                                                 1                                                                             …                                                     ID                 string                                                 taskId                                                                                                                                                 Task id                                                                        

Parametersektion

Dette er en liste over -elementer, der viser tilgængelige parametre for getReport , såsom periodes begyndelses- og sluttidsstempel, liste over objekter, grupperbar kolonne osv.

Parametre har følgende elementer:

  • name - parameternavn eller identifikator. Dette er, hvad du bruger i getReport kommandoen
  • type - type værdi for parameter. Nogle af de mulige værdier:
  • integer - numrene 0-9
  • array_of_int: kommasepareret liste over heltal
  • datetime, date, dateortime: parameter skal indeholde dato eller klokkeslæt. Det nøjagtige format vises i format element
  • object: sjældent brugt
  • string: enhver tekst
  • format - hvordan parameter skal formateres. Brug normalt datetime-parametre. Mulige værdier kan være: Å-m-d 00:00:00, Å-m, Å-m-d H:i:s osv.
  • allowNull - hvis ikke nul, er denne parameter ikke obligatorisk, hvilket betyder, at parameter kan springes over
  • defaultValue - hvis denne parameter ikke er inkluderet, bruges standardværdien i stedet
  • displayFormat, includeNullOption- formål ikke kendt
  • allowTags, inputFormat, map, validate, value- i øjeblikket ikke i brug

Output sektion

Indeholder kolonner, der er tilgængelige for rapporten, og indeholder detaljerede formateringsoplysninger.

  • data - unikke ID for den kolonne
  • title - menneskelæsbart navn for den kolonne, på API-brugerens lokaliserede sprog

  • type – type data i kolonne

  • boolean - 0 eller 1

  • data - brugt meget sjældent
  • date - indeholder dato uden tid
  • datetime - indeholder dato- og tidsværdi
  • decimal - flydenummer med cifre
  • float - samme som decimal, men kommer med formatparameter, hvad der normalt viser, hvor mange cifre der er efter komma
  • integer - numrene 0-9
  • interval - tidsværdi, der angiver, hvor længe en periode varede. Ikke det samme som dato og klokkeslæt
  • mixed - sjældent brugt
  • string - enhver tekst
  • time - indeholder kun tid

  • format - hvordan kolonnen er formateret.

  • for dato- og tidstyper viser den, hvordan output er sammensat, som Y-m-d H:i:s

  • for flydende type er der tal, hvad der viser talcifrene efter decimal
  • default - hvis den ikke er valgt i kolonnelisten, tilføjes denne kolonne som standard til rapporten
  • description – beskrivelse af data i kolonnen
  • filterBy - det er muligt at filtrere data ved hjælp af den kolonne
  • hide - standard er denne kolonne skjult
  • showZeros - hvis værdien af ​​kolonnen er nul, er den ikke skjult, men vist som nul

  • summaryType - hvordan kolonnen er opsummeret. Der er flere muligheder, men der er nogle hovedvalg:

  • sum - tilføjer tal

  • max - finde størst ud fra værdier
  • nonNullAverage - bruges mest til brændstofberegninger. Beregner gennemsnit kun ud fra de værdier, der er udfyldt
  • weightedAvg - vægtet aritmetisk gennemsnit. Denne gennemsnitsmetode bruger en anden kolonne "vægt". Jo større vægtværdi - jo mere giver denne værdi til slutresultatet.
  • refuelingDifferenceAvg, fuelPer100, fuelPerHour, estFuelCost, relationBetweenSums - ikke dækket af denne manual
  • unit – enhedstype
  • decimalSeparator - hvilket tegn der bruges som decimal. Dette kommer fra sprogpræferencer for API-brugeren.
  • align – viser, hvordan data er justeret i rapporten. Mulige værdier alignL og alignR.
  • check - hvad du skal tjekke for den kolonne. Dette er markør for rapportgenerator.
  • dataOnly, sortData - formål ikke kendt.
  • thousandSeparator - ikke I brug.

Fejlfinding

Du kan møde følgende fejl:

  • Fejl 7 "ingen tilladelser": API-bruger har ikke rapportmodul
  • Fejl 8 "Ingen rettigheder til denne rapport": API-bruger har ikke adgang til denne rapport, eller en sådan rapport findes ikke. Eller id-parameteren er tom. Sørg for, at id-værdien er angivet i kommandoen listReports.

Api/Reports/GetReports

Brødteksten i anmodningen kræver parametre hentet fra getReportConf

  • ID
  • BegTimestamp
  • EndTimestamp
  • objectIds all vehicles  (if applicable)
  • groupBy date
  • sortBy don't specify
  • sortDir don't specify

Example API call:

app.ecofleet.com/seeme/Api/Reports/getReport?key=API_KEY&id=newTasksReport&begTimeStamp=2024-04-18&endTimeStamp=2024-04-18&format=XML&stateID=9b7a907f-3f90-412c-9abf-93f28fad385c

Related articles

Powered by Zendesk