GPSS NTRIP API

Contact Info: henry.berglund@gps-solutions.com
Version: 1.0.0

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Connection

Users

Connection

Up
post /connection/ntrip-client
Add a new ntrip client connection (addNTRIPClientConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ntripClientSchema (required)
Body Parameter — Connection object

Return type

connectionResponse

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body ntripServerSchema (required)
Body Parameter — Connection object

Return type

connectionResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

connectionResponse

405

Invalid input

Up
post /connection/tcp
Add a new TCP connection (addTCPConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body tcpClientSchema (required)
Body Parameter — Connection object

Return type

connectionResponse

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 Accept request header; the media type will be conveyed by the Content-Type 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

connectionResponse

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

connectionResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation connectionResponse

405

Invalid input

Up
get /connection
Get list of all connections (getConnections)

Return type

array[connectionResponse]

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

405

Invalid input

Users

Up
get /users
List all users (usersGet)

Return type

userResponse

Example data

Content-Type: application/json
{
  "password" : "mypassword",
  "name" : "myusername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

userResponse

Up
post /users
Add a new user (usersPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body userSchema (required)
Body Parameter — User object

Return type

userResponse

Example data

Content-Type: application/json
{
  "password" : "mypassword",
  "name" : "myusername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

userResponse

Example data

Content-Type: application/json
{
  "password" : "mypassword",
  "name" : "myusername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

userResponse

Up
get /users/{user_id}
Query a specific user (usersUserIdGet)

Path parameters

user_id (required)
Path Parameter — username

Return type

userResponse

Example data

Content-Type: application/json
{
  "password" : "mypassword",
  "name" : "myusername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

userResponse

Models

[ Jump to Methods ]

Table of Contents

  1. connectionResponse -
  2. ntripClientSchema -
  3. ntripServerSchema -
  4. tcpClientSchema -
  5. userResponse -
  6. userSchema -

connectionResponse - Up

name (optional)
user (optional)
password (optional)
ip (optional)
port (optional)
mountpoint (optional)
x (optional)
BigDecimal format: float64
y (optional)
BigDecimal format: float64
z (optional)
BigDecimal format: float64

ntripClientSchema - Up

name
user
password
ip
port
mountpoint
x
BigDecimal format: float64
y
BigDecimal format: float64
z
BigDecimal format: float64

ntripServerSchema - Up

name
user (optional)
password
ip (optional)
port (optional)
mountpoint (optional)
x (optional)
BigDecimal format: float64
y (optional)
BigDecimal format: float64
z (optional)
BigDecimal format: float64

tcpClientSchema - Up

name
ip
port
x (optional)
BigDecimal format: float64
y (optional)
BigDecimal format: float64
z (optional)
BigDecimal format: float64

userResponse - Up

name (optional)
password (optional)

userSchema - Up

username
password