GPSS NTRIP API
Version: 1.0.0
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
Up
post /connection/ntrip-client
Add a new ntrip client connection (addNTRIPClientConnection)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Connection object
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
connectionResponse
405
Invalid input
Up
post /connection/ntrip-server
Add a new NTRIP Server connection (addNTRIPServerConnection)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Connection object
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
connectionResponse
405
Invalid input
Add a new TCP connection (addTCPConnection)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Connection object
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
connectionResponse
405
Invalid input
Up
delete /connection/{connection_id}
delete connection (connectionConnectionIdDelete)
Path parameters
connection_id (required)
Path Parameter — ID of connection
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}
Responses
200
successful operation
connectionResponse
405
Invalid input
Up
get /connection/{connection_id}
Query information about a specific connection (getConnection)
Path parameters
connection_id (required)
Path Parameter — ID of connection
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
connectionResponse
405
Invalid input
Get list of all connections (getConnections)
Return type
Example data
Content-Type: application/json
[ {
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
}, {
"password" : "password",
"port" : 2101,
"ip" : "rtgpsout.unavco.org",
"name" : "P041",
"x" : -1283634.29609,
"y" : -4726427.87686,
"z" : 4074798.00349,
"user" : "username",
"mountpoint" : "P041_RTCM3"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
405
Invalid input
List all users (usersGet)
Return type
Example data
Content-Type: application/json
{
"password" : "mypassword",
"name" : "myusername"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
userResponse
Add a new user (usersPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — User object
Return type
Example data
Content-Type: application/json
{
"password" : "mypassword",
"name" : "myusername"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
userResponse
Up
delete /users/{user_id}
Delete a specific user (usersUserIdDelete)
Path parameters
user_id (required)
Path Parameter — username
Return type
Example data
Content-Type: application/json
{
"password" : "mypassword",
"name" : "myusername"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
userResponse
Query a specific user (usersUserIdGet)
Path parameters
user_id (required)
Path Parameter — username
Return type
Example data
Content-Type: application/json
{
"password" : "mypassword",
"name" : "myusername"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
userResponse
[ Jump to Methods ]
Table of Contents
connectionResponse
-
ntripClientSchema
-
ntripServerSchema
-
tcpClientSchema
-
userResponse
-
userSchema
-
name (optional)
user (optional)
password (optional)
ip (optional)
port (optional)
mountpoint (optional)
x (optional)
y (optional)
z (optional)
name
user
password
ip
port
mountpoint
x
y
z
name
user (optional)
password
ip (optional)
port (optional)
mountpoint (optional)
x (optional)
y (optional)
z (optional)
name
ip
port
x (optional)
y (optional)
z (optional)
name (optional)
password (optional)