Schedulazione

2 min

Available reports for scheduling

Get the list of available reports for scheduling

GET

https://api.fsflt.net/report/traffic_reports/schedule/available

Header Parameters

X-API-KEYstringrequired
Description
API Key for authorization

Body Parameters

customer_codeNumberrequired
Description
Customer code
langString
Description
EN | IT | DE | ES

curl

curl --location --request GET 'https://api.fsflt.net/report/traffic_reports/schedule/available' \
--header 'X-API-KEY: string' \
--data '{"customer_code":"Number","lang":"String"}'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://api.fsflt.net/report/traffic_reports/schedule/available',
   'headers': {
      'X-API-KEY': 'string'
   },
   body: '{"customer_code":"Number","lang":"String"}'

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("X-API-KEY", "string");

var raw = "{\"customer_code\":\"Number\",\"lang\":\"String\"}";

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.fsflt.net/report/traffic_reports/schedule/available", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://api.fsflt.net/report/traffic_reports/schedule/available"

payload = "{\"customer_code\":\"Number\",\"lang\":\"String\"}"
headers = {
   'X-API-KEY': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://api.fsflt.net/report/traffic_reports/schedule/available")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = "string"
request.body = "{\"customer_code\":\"Number\",\"lang\":\"String\"}"

response = https.request(request)
puts response.read_body

200

[
    {
        "id": 28,
        "description": "Blocked by category"
    },
    {
        "id": 29,
        "description": "Blocked for macrocategory"
    }
]

401

{
    "code": 401,
    "message": "Missing API Key"
}

422

{
    "code": 422,
    "message": "Validation error",
    "content": {
        "lang": [
            "validation.in"
        ]
    }
}

List active scheduling on customer

Gets the currently active reports schedule of a given customer

GET

https://api.fsflt.net/report/traffic_reports/schedule/list

Header Parameters

X-API-KEYstringrequired
Description
API Key for authorization

Body Parameters

customer_codeNumberrequired
Description
Customer code
langString
Description
EN | IT | DE | ES

curl

curl --location --request GET 'https://api.fsflt.net/report/traffic_reports/schedule/list' \
--header 'X-API-KEY: string' \
--data '{"customer_code":"Number","lang":"String"}'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://api.fsflt.net/report/traffic_reports/schedule/list',
   'headers': {
      'X-API-KEY': 'string'
   },
   body: '{"customer_code":"Number","lang":"String"}'

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("X-API-KEY", "string");

var raw = "{\"customer_code\":\"Number\",\"lang\":\"String\"}";

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.fsflt.net/report/traffic_reports/schedule/list", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://api.fsflt.net/report/traffic_reports/schedule/list"

payload = "{\"customer_code\":\"Number\",\"lang\":\"String\"}"
headers = {
   'X-API-KEY': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://api.fsflt.net/report/traffic_reports/schedule/list")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = "string"
request.body = "{\"customer_code\":\"Number\",\"lang\":\"String\"}"

response = https.request(request)
puts response.read_body

200

[
    {
        "id": "886.2",
        "reports_id": [
            8,
            28,
            60
        ],
        "recivers": [
            "[email protected]"
        ],
        "days": [
            "0",
            "1",
            "2",
            "3",
            "4",
            "5",
            "6"
        ],
        "hours": [
            "00",
            "23"
        ],
        "interval": 7,
        "profile_name": "Default"
    },
    {
        "id": "997.2",
        "reports_id": [
            87
        ],
        "recivers": [
            "[email protected]"
        ],
        "days": [
            "1"
        ],
        "hours": [
            "00",
            "23"
        ],
        "interval": 7,
        "profile_name": "New 1"
    }
]

401

{
    "code": 401,
    "message": "Missing API Key"
}

422

{
    "code": 422,
    "message": "Validation error",
    "content": {
        "lang": [
            "validation.in"
        ]
    }
}

Add a report schedule

Add a new schedule report on a specified customer

POST

https://api.fsflt.net/report/traffic_reports/schedule/add

Header Parameters

X-API-KEYstringrequired
Description
API Key for authorization

Body Parameters

customer_codeNumberrequired
Description
Customer code
reports_idArrayrequired
Description
Array of reports id to add in the schedule
reciversArrayrequired
Description
Array of emails to send the reports: max 3
daysArrayrequired
Description
Array of integer of days of the week to be included in the report. 0 stands for monday ... 6 for sunday
hoursstringrequired
Description
Array of indeger of size 2 to specify the interval of the report. e.g [00,23] stands for all day
intervalNumberrequired
Description
How often send the reports 1 for once a day 7 for once a week
all_profilesBooleanrequired
Description
True for generate reports for all profiles
profile_codeInteger
Description
If all_profiles is false, specify a profile to generate the reports

curl

curl --location 'https://api.fsflt.net/report/traffic_reports/schedule/add' \
--header 'X-API-KEY: string' \
--data '{"customer_code":"Number","reports_id":"Array","recivers":"Array","days":"Array","hours":"String","interval":"Number","all_profiles":"Boolean","profile_code":"Integer"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.fsflt.net/report/traffic_reports/schedule/add',
   'headers': {
      'X-API-KEY': 'string'
   },
   body: '{"customer_code":"Number","reports_id":"Array","recivers":"Array","days":"Array","hours":"String","interval":"Number","all_profiles":"Boolean","profile_code":"Integer"}'

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("X-API-KEY", "string");

var raw = "{\"customer_code\":\"Number\",\"reports_id\":\"Array\",\"recivers\":\"Array\",\"days\":\"Array\",\"hours\":\"String\",\"interval\":\"Number\",\"all_profiles\":\"Boolean\",\"profile_code\":\"Integer\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.fsflt.net/report/traffic_reports/schedule/add", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://api.fsflt.net/report/traffic_reports/schedule/add"

payload = "{\"customer_code\":\"Number\",\"reports_id\":\"Array\",\"recivers\":\"Array\",\"days\":\"Array\",\"hours\":\"String\",\"interval\":\"Number\",\"all_profiles\":\"Boolean\",\"profile_code\":\"Integer\"}"
headers = {
   'X-API-KEY': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://api.fsflt.net/report/traffic_reports/schedule/add")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = "string"
request.body = "{\"customer_code\":\"Number\",\"reports_id\":\"Array\",\"recivers\":\"Array\",\"days\":\"Array\",\"hours\":\"String\",\"interval\":\"Number\",\"all_profiles\":\"Boolean\",\"profile_code\":\"Integer\"}"

response = https.request(request)
puts response.read_body

200

{
    "id": "1195.2",
    "message": "Schedule added successfully"
}

401

{
    "code": 401,
    "message": "Missing API Key"
}

422

{
    "code": 422,
    "message": "Validation error",
    "content": {
        "lang": [
            "validation.in"
        ]
    }
}

Remove a report schedule

Remove a report scheduling from a customer

POST

https://api.fsflt.net/report/traffic_reports/schedule/remove

Header Parameters

X-API-KEYstringrequired
Description
API Key for authorization

Body Parameters

customer_codeNumberrequired
Description
Customer code
idStringrequired
Description
Id of the schedule report to remove

curl

curl --location 'https://api.fsflt.net/report/traffic_reports/schedule/remove' \
--header 'X-API-KEY: string' \
--data '{"customer_code":"Number","id":"String"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.fsflt.net/report/traffic_reports/schedule/remove',
   'headers': {
      'X-API-KEY': 'string'
   },
   body: '{"customer_code":"Number","id":"String"}'

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("X-API-KEY", "string");

var raw = "{\"customer_code\":\"Number\",\"id\":\"String\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.fsflt.net/report/traffic_reports/schedule/remove", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://api.fsflt.net/report/traffic_reports/schedule/remove"

payload = "{\"customer_code\":\"Number\",\"id\":\"String\"}"
headers = {
   'X-API-KEY': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://api.fsflt.net/report/traffic_reports/schedule/remove")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = "string"
request.body = "{\"customer_code\":\"Number\",\"id\":\"String\"}"

response = https.request(request)
puts response.read_body

200

{
    "message": "Schedule removed successfully"
}

401

{
    "code": 401,
    "message": "Missing API Key"
}

422

{
    "code": 422,
    "message": "Validation error",
    "content": {
        "lang": [
            "validation.in"
        ]
    }
}