POSitive Anywhere
Web Service Documentation
Service: api
Method: station_list
Retrieve list of Stations and their settings
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Group: request
localstationid
(string[60])
stationid
(long integer)
This parameter is Optional
Possible Return Data
List: ErrorQueue
ErrorNumber
(long integer)
ErrorPosition
(string[255])
ErrorRecordId
(string[255])
ErrorDescription
(string[255])
ErrorRecommendation
(string[255])
List: stations
id
(long integer)
name
(string[20])
JSON POST (JSON Response)
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
jsondata
result
Example Request
POST /station_list HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"localstationid" : "value",
"stationid" : value
}
}
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"localstationid" : "value",
"stationid" : value
}
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Example Code - JavaScript
function station_list_jsonpost(host,jsondata,username,password,result){
fetch(host + "/station_list", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/json",
"Accept": "application/json;",
},
body: jsondata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://localhost:2293"
fetch(host + "/station_list", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/json",
"Accept": "application/json;",
},
body: jsondata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @jsonDataFile.json https://localhost:2293/station_list
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/station_list',jsonData)
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/station_list',jsonData)
Try It - Live
User Name
Password
result
HTTP GET (JSON Response)
The following is a sample JSON GET request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
GET /station_list?request-localstationid=value&request-stationid=value HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Example Code - JavaScript
function station_list_getjson(host,urldata,username,password,result){
fetch(host + "/station_list" +"?" + urldata, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
fetch(host + "/station_list" +"?" + urldata, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Accept: application/json" --get --data "request-localstationid=value&request-stationid=value" https://localhost:2293/station_list
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/station_list?request-localstationid=value&request-stationid=value')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/station_list?request-localstationid=value&request-stationid=value')
Try It - Live
User Name
Password
request-localstationid
request-stationid
result
REST GET (JSON Response)
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
GET /api/station_list? HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"station_list_response" : {
"stations" : [
{
"id" : value,
"name" : "value"
}
]
}
}
Example Code - JavaScript
function station_list_restjson(host,id,username,password,result){
fetch(host + "/api/station_list/" + id, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
fetch(host + "/api/station_list/" + id, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Accept: application/json" https://localhost:2293/api/station_list/5
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/station_list/5')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/station_list/5')
Try It - Live
User Name
Password
id
result
Copyright 2024 POSitive Software Company All Rights Reserved