Authorization User Roles HTTP Methods Real-Time Data Streaming Status Codes Content Types Errors Pagination Rate Limiting Versioning
Please beware that the documentation is still in Alpha!
To receive profiles, you can get a Profile
object.
1linkGET /v1/Profiles
2linkPOST /v1/Profiles
3linkPUT /v1/Profiles/default/{id}
4linkGET /v1/Profiles/{id}
5linkPUT /v1/Profiles/{id}
6linkDELETE /v1/Profiles/{id}
7linkPOST /v1/Profiles/link/users
8linkPOST /v1/Profiles/nstrip/mountpoints
9linkGET /v1/Profiles/user/{id}/details
1link{
2link "name": "string",
3link "description": "string",
4link "isActive": true,
5link "mode": {
6link "name": "string",
7link "tag": "string",
8link "id": "string",
9link "createdDate": "2023-01-04T15:00:18.804Z",
10link "lastUpdated": "2023-01-04T15:00:18.804Z"
11link },
12link "positioningMode": "string",
13link "ntripClient": {
14link "profileId": "string",
15link "manual": true,
16link "address": "string",
17link "port": 0,
18link "username": "string",
19link "password": "string",
20link "mountPoint": "string",
21link "sendNmeaGga": true
22link },
23link "output": {
24link "name": "string",
25link "outputOptions": [
26link {
27link "name": "string",
28link "required": true,
29link "outputType": "string"
30link }
31link ],
32link "optionValues": [
33link {
34link "id": "string",
35link "name": "string",
36link "value": "string"
37link }
38link ],
39link "id": "string",
40link "createdDate": "2023-01-04T15:00:18.804Z",
41link "lastUpdated": "2023-01-04T15:00:18.804Z"
42link },
43link "format": {
44link "id": "string",
45link "name": "string",
46link "nmea": {
47link "id": "string",
48link "talker": "string",
49link "options": [
50link {
51link "id": "string",
52link "name": "string",
53link "enabled": true,
54link "hertz": 0
55link }
56link ]
57link }
58link },
59link "profileUsers": [
60link {
61link "profileId": "string",
62link "userId": "string",
63link "isDefault": true
64link }
65link ],
66link "id": "string",
67link "createdDate": "2023-01-04T15:00:18.804Z",
68link "lastUpdated": "2023-01-04T15:00:18.804Z"
69link }
1linkexport interface Profile {
2link id: string;
3link name: string;
4link description: string;
5link isActive: boolean;
6link mode: Mode;
7link positioningMode: string;
8link ntripClient: NtripClient;
9link output: Output;
10link format: Format;
11link profileUsers: ProfileUser[];
12link createdDate: Date;
13link lastUpdated: Date;
14link}
15link
16linkexport interface Mode {
17link id: string;
18link name: string;
19link tag: string;
20link createdDate: Date;
21link lastUpdated: Date;
22link}
23link
24linkexport interface NtripClient {
25link profileId: string;
26link manual: boolean;
27link address: string;
28link port: number;
29link username: string;
30link password: string;
31link mountPoint: string;
32link sendNmeaGga: boolean;
33link}
34link
35linkexport interface OutputOption {
36link name: string;
37link required: boolean;
38link outputType: string;
39link}
40link
41linkexport interface OptionValue {
42link id: string;
43link name: string;
44link value: string;
45link}
46link
47linkexport interface Output {
48link id: string;
49link name: string;
50link outputOptions: OutputOption[];
51link optionValues: OptionValue[];
52link createdDate: Date;
53link lastUpdated: Date;
54link}
55link
56linkexport interface Option {
57link id: string;
58link name: string;
59link enabled: boolean;
60link hertz: number;
61link}
62link
63linkexport interface Nmea {
64link id: string;
65link talker: string;
66link options: Option[];
67link}
68link
69linkexport interface Format {
70link id: string;
71link name: string;
72link nmea: Nmea;
73link}
74link
75linkexport interface ProfileUser {
76link profileId: string;
77link userId: string;
78link isDefault: boolean;
79link}
1linkpublic class Profile
2link{
3link public Guid Id { get; set; }
4link public string Name { get; set; }
5link public string Description { get; set; }
6link public bool IsActive { get; set; }
7link public Mode Mode { get; set; }
8link public string PositioningMode { get; set; }
9link public NtripClient NtripClient { get; set; }
10link public Output Output { get; set; }
11link public Format Format { get; set; }
12link public ICollection<ProfileUser> ProfileUsers { get; set; }
13link public DateTime CreatedDate { get; set; }
14link public DateTime LastUpdated { get; set; }
15link}
16link
17linkpublic class Format
18link{
19link public Guid Id { get; set; }
20link public string Name { get; set; }
21link public Nmea Nmea { get; set; }
22link}
23link
24linkpublic class Mode
25link{
26link public Guid Id { get; set; }
27link public string Name { get; set; }
28link public string Tag { get; set; }
29link public DateTime CreatedDate { get; set; }
30link public DateTime LastUpdated { get; set; }
31link}
32link
33linkpublic class Nmea
34link{
35link public Guid Id { get; set; }
36link public string Talker { get; set; }
37link public ICollection<Option> Options { get; set; }
38link}
39link
40linkpublic class NtripClient
41link{
42link public Guid ProfileId { get; set; }
43link public bool Manual { get; set; }
44link public string Address { get; set; }
45link public int Port { get; set; }
46link public string Username { get; set; }
47link public string Password { get; set; }
48link public string MountPoint { get; set; }
49link public bool SendNmeaGga { get; set; }
50link}
51link
52linkpublic class Option
53link{
54link public Guid Id { get; set; }
55link public string Name { get; set; }
56link public bool Enabled { get; set; }
57link public int Hertz { get; set; }
58link}
59link
60linkpublic class OptionValue
61link{
62link public Guid Id { get; set; }
63link public string Name { get; set; }
64link public string Value { get; set; }
65link}
66link
67linkpublic class Output
68link{
69link public Guid Id { get; set; }
70link public string Name { get; set; }
71link public ICollection<OutputOption> UutputOptions { get; set; }
72link public ICollection<OptionValue> OptionValues { get; set; }
73link public DateTime CreatedDate { get; set; }
74link public DateTime LastUpdated { get; set; }
75link}
76link
77linkpublic class OutputOption
78link{
79link public string Name { get; set; }
80link public bool Required { get; set; }
81link public string OutputType { get; set; }
82link}
83link
84linkpublic class ProfileUser
85link{
86link public Guid ProfileId { get; set; }
87link public Guid UserId { get; set; }
88link public bool IsDefault { get; set; }
89link}
ReadOnly
HTTP-Get handler that retrieves all profiles of the user making the request.
A list of all profiles of the user.
Managers retrieves all profiles under the user's tenant.
1linkGET https://api.marxact.com/v1/Profiles HTTP/1.1
2linkAuthorization: Bearer {{token}}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link[
4link { Profile_1 },
5link ...
6link { Profile_n },
7link]
Admin
Creates a new Base Profile.
The newly created profile.
1linkPOST https://api.marxact.com/v1/Profiles HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link "name": "Example Base",
7link "description": "Example Description",
8link "mode": {
9link "name": "Base",
10link "name": "Base"
11link }
12link}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link NewProfile,
5link}
Admin
Creates a new Standalone Rover Profile.
At the time of writing, there are three types of outputs, (1) Bluetooth, (2) USBOTG1, and (3) SerialPort. Each interface requires a different model.
This attribute can be one of the following string values, 4800
, 9600
, 14400
, 19200
, 28800
, 38400
, 56000
, 57600
, 115200
, 128000
, 153600
, 230400
, 256000
, and 460800
.
Each of the following values will need a separate option, gga
, gsv
, gst
, hdt
, rmc
, vtg
, and zda
.
The newly created profile.
1linkPOST https://api.marxact.com/v1/Profiles HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link "name": "Example Rover (Standalone)",
7link "description": "Example Description",
8link "positioningMode": "Standalone",
9link "mode": {
10link "name": "Rover",
11link "tag": "Rover"
12link },
13link "output": {
14link "name": "SerialPort",
15link "outputOptions": [
16link {
17link "name": "BaudRate",
18link "required": true,
19link "outputType": "SerialPort"
20link }
21link ],
22link "optionValues": [
23link {
24link "name": "BaudRate",
25link "value": "9600"
26link }
27link ]
28link },
29link "format": {
30link "name": "NMEA",
31link "nmea": {
32link "talker": "AUTO",
33link "options": [
34link {
35link "name": "gga",
36link "enabled": true,
37link "hertz": 1
38link },
39link {
40link "name": "gsa",
41link "enabled": true,
42link "hertz": 1
43link },
44link {
45link "name": "gsv",
46link "enabled": true,
47link "hertz": 1
48link },
49link {
50link "name": "gst",
51link "enabled": true,
52link "hertz": 1
53link },
54link {
55link "name": "hdt",
56link "enabled": true,
57link "hertz": 1
58link },
59link {
60link "name": "rmc",
61link "enabled": true,
62link "hertz": 20
63link },
64link {
65link "name": "vtg",
66link "enabled": false,
67link "hertz": 10
68link },
69link {
70link "name": "zda",
71link "enabled": true,
72link "hertz": 1
73link },
74link ]
75link }
76link }
77link}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link NewProfile,
5link}
Admin
Creates a new DGPS or RTK Rover Profile.
Each of the following values will need a separate option, gga
, gsa
, gsv
, gst
, hdt
, rmc
, vtg
and zda
.
The newly created profile.
1linkPOST https://api.marxact.com/v1/Profiles HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link "name": "Example Rover (DGPS or RTK)",
7link "description": "Example Description",
8link "positioningMode": "DGPS",
9link "mode" {
10link "name": "Rover",
11link "tag": "Rover"
12link },
13link "ntripClient" {
14link "address": "ntrip.example.com",
15link "port": "2101",
16link "username": "example",
17link "password": "12345",
18link "mountPoint": "VRS01",
19link "sendNmeaGga": true
20link },
21link "format": {
22link "name": "NMEA",
23link "nmea": {
24link "talker": "AUTO",
25link "options": [
26link {
27link "name": "gga",
28link "enabled": true,
29link "hertz": 1
30link },
31link {
32link "name": "gsa",
33link "enabled": true,
34link "hertz": 1
35link },
36link {
37link "name": "gsv",
38link "enabled": true,
39link "hertz": 1
40link },
41link {
42link "name": "gst",
43link "enabled": true,
44link "hertz": 1
45link },
46link {
47link "name": "hdt",
48link "enabled": true,
49link "hertz": 1
50link },
51link {
52link "name": "rmc",
53link "enabled": true,
54link "hertz": 20
55link },
56link {
57link "name": "vtg",
58link "enabled": false,
59link "hertz": 10
60link },
61link {
62link "name": "zda",
63link "enabled": true,
64link "hertz": 1
65link },
66link ]
67link }
68link }
69link}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link NewProfile,
5link}
User
HTTP-Put handler that sets a profile as the default profile for the user.
The new default profile when succesful.
1linkPUT https://api.marxact.com/v1/Profiles/default/{id} HTTP/1.1
2linkAuthorization: Bearer {{token}}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link DefaultProfile,
5link}
ReadOnly
HTTP-Get handler that retrieves a profile with the corresponding identifier.
The profile when succesful.
1linkGET https://api.marxact.com/v1/Profiles/{id} HTTP/1.1
2linkAuthorization: Bearer {{token}}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link Profile,
5link}
Admin
HTTP-Put handler that updates a profile with the corresponding identifier.
The updated profile when succesful.
1linkPUT https://api.marxact.com/v1/Profiles/{id} HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link{
5link Profile
6link}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link UpdatedProfile,
5link}
Admin
HTTP-Delete handler that deletes a profile with the corresponding identifier.
The deleted profile when succesful.
1linkDELETE https://api.marxact.com/v1/Profiles/{id} HTTP/1.1
2linkAuthorization: Bearer {{token}}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link{
4link DeletedProfile
5link}
Admin
Override all users from a profile with a new list of users.
Note that this will unlink all the old users from the profile, and link the newly given users to the profile.
Please beware that it is not allowed to send duplicate userIds, or mixed profileIds, depending on the link.
Thus, it is only allowed to link many users to one profile, or one user to many profiles.
Before making this call, be sure that at the end every user that has a linked profile, has exactly one being set as default.
Returns a success response when the request was successful.
1linkPOST https://api.marxact.com/v1/Profiles/link/users HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link {
7link "link": "profile",
8link "profileUsers": [
9link {
10link "profileId": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",
11link "userId": "2d426e7e-869e-45e2-927f-78660cad8795",
12link "isDefault": false
13link },
14link {
15link "profileId": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",
16link "userId": "9e9e870d-e7b2-4078-8904-1ff4d733e6cc",
17link "isDefault": true
18link }
19link ]
20link }
21link}
1linkHTTP/1.1 200 OK
1linkPOST https://api.marxact.com/v1/Profiles/link/users HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link {
7link "link": "user",
8link "profileUsers": [
9link {
10link "profileId": "9e9e870d-e7b2-4078-8904-1ff4d733e6cc",
11link "userId": "2d426e7e-869e-45e2-927f-78660cad8795",
12link "isDefault": false
13link },
14link {
15link "profileId": "9e9e870d-e7b2-4078-8904-1ff4d733e6cc",
16link "userId": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",
17link "isDefault": true
18link }
19link ]
20link }
21link}
1linkHTTP/1.1 200 OK
Admin
Unlinks all users from a profile, or unlink all profiles from a user.
Set the attribute link
as profile
, when you would like to unlink all users from a profile.
Set the attribute link
as user
, when you would like to unlink all profiles from a user.
Returns a success response when the request was successful.
1linkPOST https://api.marxact.com/v1/Profiles/link/users HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link {
7link "link": "profile",
8link "profileId": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb"
9link }
10link}
1linkHTTP/1.1 200 OK
1linkPOST https://api.marxact.com/v1/Profiles/link/users HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link {
7link "link": "user",
8link "userId": "2d426e7e-869e-45e2-927f-78660cad8795"
9link }
10link}
1linkHTTP/1.1 200 OK
Admin
HTTP-Post handler that retrieves the mount points by a NTRIPClientValidator a new mount.
A list of all mount points.
1linkPOST https://api.marxact.com/v1/Profiles/ntrip/mountpoints HTTP/1.1
2linkAuthorization: Bearer {{token}}
3linkContent-Type: application/json
4link
5link{
6link "address": "string",
7link "port": 0
8link}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link[
4link {
5link "mountpoint": "string"
6link }
7link]
ReadOnly
HTTP-Get handler that returns all the linked profiles (along with their details) for a given user ID.
A list of all linked profile, along with their details.
1linkGET https://api.marxact.com/v1/Profiles/user/{id}/details HTTP/1.1
2linkAuthorization: Bearer {{token}}
1linkHTTP/1.1 200 OK
2linkContent-Type: application/json
3link[
4link { Profile_1 },
5link ...
6link { Profile_n },
7link]