UNICloudAPI - marXact Cloud

Please beware that the documentation is still in Alpha!

Survey

The survey endpoint can consist of a multitude of models.

Endpoints1linkGET        /v1/Survey/projects

2linkGET        /v1/Survey/projects/{projectId}

3linkPOST       /v1/Survey/projects

4linkGET        /v1/Survey/layers

5linkGET        /v1/Survey/layers/{layerId}

6linkPOST       /v1/Survey/layers

7linkGET        /v1/Survey/projectsettings

8linkGET        /v1/Survey/projectsettings/{projectSettingId}

9linkPOST       /v1/Survey/projectsettings

linkGET Retrieve all Projects.

ReadOnly

HTTP-Get handler that retrieves all projects of the user making the request.

Parameters

chevron_right

No parameters.

Returns

chevron_right

A list of all projects of the user.

Managers retrieves all projects under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/projects HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link[

4link  {

5link    "Id": "00000000-0000-0000-0000-000000000000",

6link    "Name": "Project 1",

7link    "Description": "String",

8link    "CoordinateReferenceSystem": "RDNAP2018",

9link    "ProjectSetting": {

10link      "Id": "00000000-0000-0000-0000-000000000000",

11link      "Name": "String",

12link      "PoleHeight": 0,

13link      "Adapter": false,

14link      "TotalHeight": 0,

15link      "MinAccuracy": 0,

16link      "MinAccuracyType": 0,

17link      "RecordTime": 0,

18link      "CreatedDate": "0001-01-01T00:00:00",

19link      "LastUpdated": "0001-01-01T00:00:00"

20link    },

21link    "CreatedDate": "0001-01-01T00:00:00",

22link    "LastUpdated": "0001-01-01T00:00:00",

23link    "ProjectDevices": null,

24link    "ProjectUsers": null

25link  },

26link  {

27link    "Id": "00000000-0000-0000-0000-000000000001",

28link    "Name": "Project 2",

29link    "Description": "String",

30link    "CoordinateReferenceSystem": "default",

31link    "ProjectSetting": {

32link      "Id": "00000000-0000-0000-0000-000000000000",

33link      "Name": "String",

34link      "PoleHeight": 0,

35link      "Adapter": false,

36link      "TotalHeight": 0,

37link      "MinAccuracy": 0,

38link      "MinAccuracyType": 0,

39link      "RecordTime": 0,

40link      "CreatedDate": "0001-01-01T00:00:00",

41link      "LastUpdated": "0001-01-01T00:00:00"

42link    },

43link    "CreatedDate": "0001-01-01T00:00:00",

44link    "LastUpdated": "0001-01-01T00:00:00",

45link    "ProjectDevices": null,

46link    "ProjectUsers": null

47link  }

48link]

linkGET Retrieve Project by ID

ReadOnly

Http-Get handler that retrieves a project of the user making the request with the corresponding identifier.

Parameters

chevron_right

projectIdGuid
The identifier of the project.

Returns

chevron_right

The given project with the corresponding identifier owned by the user making the request, or 404 when it doesn't exist.

Managers are capable or retrieving a project under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/projects/a9568d4d-581c-4ab6-9f45-e436772cfac2 HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "a9568d4d-581c-4ab6-9f45-e436772cfac2",

5link  "name": "Project 1",

6link  "description": "Project 1 description",

7link  "coordinateReferenceSystem": "RDNAP2018",

8link  "projectSetting": "<projectSetting>",

9link  "createdDate": "2021-08-04T08:49:25Z",

10link  "lastUpdated": "2021-08-04T09:49:25Z"

11link},

linkPOST Create a New Project

Admin

HTTP-Post handler that creates a new project.

Parameters

chevron_right

Namestring
The name of the project
Descriptionstring
The description of the project.
CoordinateReferenceSystemCRS
For a list of supported Coordinate Reference systems and their identifiers (i.e. for The Netherlands use ‘RDNAP2018’) please see the Supported CRS List
projectSettingProjectSetting
The setting for the project.
Show child parameters
chevron_right
projectSetting.Id
Valid Identifier of an existing ProjectSetting.
ProjectUsersProjectUser[]
The users of the project.
Show child parameters
chevron_right
projectUser.userId
Valid Identifier of an existing user.
ProjectDevicesProjectDevice[]
The devices of the project.
Show child parameters
chevron_right
projectDevices.deviceSerial
Valid serial number of an existing device.

Returns

chevron_right

The created project.

1linkPOST https://api.marxact.com/v1/Survey/projects HTTP/1.1

2linkAuthorization: Bearer {{token}}

3linkContent-Type: application/json

4link

5link{

6link  "coordinateReferenceSystem": "RDNAP2018",

7link  "name": "string",

8link  "description": "string",

9link  "projectSetting": {

10link    "id": "074d3211-8b83-4952-8a32-b442c802291b"

11link  },

12link  "projectUsers": [

13link    {

14link      "userId": "GUID"

15link    }

16link  ],

17link  "projectDevices": [

18link    {

19link      "deviceSerial": "string"

20link    }

21link  ]

22link}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "a755d3b0-aed5-11e9-a2a3-2a2ae2dbcce1",

5link  "name": "New Project",

6link  "description": "null",

7link  "coordinateReferenceSystem": "default",

8link  "projectSetting": "<projectSetting>",

9link  "createdDate": "2023-04-30T16:02:55Z",

10link  "lastUpdated": "2023-04-30T17:02:55Z"

11link}

linkGET Get Layers

ReadOnly

HTTP-Get handler that retrieves all layers of the user making the request.

Parameters

chevron_right

No parameters.

Returns

chevron_right

A list of all layers of the user.

Managers retrieves all layers under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/layers HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link[

4link  {

5link    "id": "5f8b3ad2-37f7-43ba-b6ec-4ca01ef803f2",

6link    "name": "Layer 1",

7link    "description": "Layer 1 description",

8link    "color": "#30ab38",

9link    "attributes": [],

10link    "createdDate": "2021-03-22T12:24:50Z",

11link    "lastUpdated": "2021-07-12T15:45:32Z"

12link  },

13link  {

14link    "id": "53d873fa-06ae-4fbb-a532-e17da07fe8ec",

15link    "name": "Layer 2",

16link    "description": "Layer 2 description",

17link    "attributes": [

18link      {

19link        "id": "6c4321e6-21e4-4048-90cb-4c40140161df",

20link        "name": "Dikte",

21link        "type": "text",

22link        "required": true,

23link        "values": [

24link          null

25link        ],

26link        "createdDate": "2021-03-17T11:12:09Z",

27link        "lastUpdated": "2022-11-01T13:26:58Z"

28link      }

29link    ],

30link    "color": "#ff0000",

31link    "createdDate": "2021-04-13T10:14:45Z",

32link    "lastUpdated": "2021-07-26T15:22:54Z"

33link  }

34link]

linkGET Get Layer

ReadOnly

Http-Get handler that retrieves a layer of the user making the request with the corresponding identifier.

Parameters

chevron_right

layerIdGuid
The identifier of the layer.

Returns

chevron_right

The given layer with the corresponding identifier owned by the user making the request, or 404 when it doesn't exist.

Managers are capable or retrieving a layer under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/layers/53d873fa-06ae-4fbb-a532-e17da07fe8ec HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "53d873fa-06ae-4fbb-a532-e17da07fe8ec",

5link  "name": "Layer 2",

6link  "description": "Layer 2 description",

7link  "attributes": [

8link    {

9link      "id": "6c4321e6-21e4-4048-90cb-4c40140161df",

10link      "name": "Dikte",

11link      "type": "text",

12link      "required": true,

13link      "values": [

14link        null

15link      ],

16link      "createdDate": "2021-03-17T11:12:09Z",

17link      "lastUpdated": "2022-11-01T13:26:58Z"

18link    }

19link  ],

20link  "color": "#ff0000",

21link  "createdDate": "2021-04-13T10:14:45Z",

22link  "lastUpdated": "2021-07-26T15:22:54Z"

23link}

linkPOST Post Layers

Admin

HTTP-Post handler that creates a new layer.

Parameters

chevron_right

Namestring
The name of the layer.
Descriptionstring
The description of the layer.
Colorstring
for example: #ff0000
AttributesAttribute[]
The field 'attributes' represent a List where each element (or attributeValue) of the list takes 3 arguments, of which 'name' and 'type' are required. 'values' is required only if type is 'options'. If the layer does not have any attribute then leave the List relative to 'attributes' empty
Show child parameters
chevron_right
Namestring
The name of the attribute.
Typestring
The type of the attribute.
Requiredboolean
Whether the attribute is required.
Valuesstring[]
The values of the attribute.

Returns

chevron_right

The newly created layer.

1linkPOST https://api.marxact.com/v1/Survey/layers HTTP/1.1

2linkAuthorization: Bearer {{token}}

3linkContent-Type: application/json

4link

5link{

6link  "name": "Example of Layer name",

7link  "description": "This is an example of a description",

8link  "color": "#ff0000",

9link  "attributes": [

10link    {

11link      "name": "Example of Attribute name",

12link      "type": "String (none, text, options)",

13link      "values": [

14link        {

15link          "name1": "AttributeValue1",

16link          "name2": "AttributeValue2",

17link          "name3": "AttributeValue3"

18link        }

19link      ]

20link    }

21link  ]

22link}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "53d873fa-06ae-4fbb-a532-e17da07fe8ec",

5link  "name": "Example of Layer name",

6link  "description": "This is an example of a description",

7link  "attributes": [

8link    {

9link      "id": "6c4321e6-21e4-4048-90cb-4c40140161df",

10link      "name": "Example of Attribute name",

11link      "type": "text",

12link      "required": true,

13link      "values": [

14link        null

15link      ],

16link      "createdDate": "2023-03-17T11:12:09Z",

17link      "lastUpdated": "2023-11-01T13:26:58Z"

18link    }

19link  ],

20link  "color": "#ff0000",

21link  "createdDate": "2023-04-13T10:14:45Z",

22link  "lastUpdated": "2023-07-26T15:22:54Z"

23link}

linkGET Get Project Settings

ReadOnly

HTTP-Get handler that retrieves all project settings of the user making the request.

Parameters

chevron_right

No parameters.

Returns

chevron_right

A list of all project settings of the user.

Managers retrieves all project settings under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/projectsettings HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link[

4link  {

5link    "id": "315cd8ce-976e-4b9a-a5e3-cbb6fdec354d",

6link    "name": "Project Setting 1",

7link    "poleHeight": 200,

8link    "adapter": true,

9link    "totalHeight": 2.09476,

10link    "minAccuracy": 10,

11link    "minAccuracyType": 0,

12link    "recordTime": 1,

13link    "createdDate": "2021-04-30T16:02:55Z",

14link    "lastUpdated": "2021-04-30T16:02:55Z"

15link  },

16link  {

17link    "id": "315cd8ce-976e-4b9a-a5e3-cbb6fdec354d",

18link    "name": "Project Setting 2",

19link    "poleHeight": 220,

20link    "adapter": false,

21link    "totalHeight": 2.73476,

22link    "minAccuracy": 10,

23link    "minAccuracyType": 0,

24link    "recordTime": 1,

25link    "createdDate": "2021-04-30T16:02:55Z",

26link    "lastUpdated": "2021-04-30T16:02:55Z"

27link  }

28link]

linkGET Get Project Setting

ReadOnly

Http-Get handler that retrieves a project setting of the user making the request with the corresponding identifier.

Parameters

chevron_right

settingIdGuid
The identifier of the project setting.

Returns

chevron_right

The given project setting with the corresponding identifier owned by the user making the request, or 404 when it doesn't exist.

Managers are capable or retrieving a project setting under the user's tenant.

1linkGET https://api.marxact.com/v1/Survey/projectsettings/315cd8ce-976e-4b9a-a5e3-cbb6fdec354d HTTP/1.1

2linkAuthorization: Bearer {{token}}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "315cd8ce-976e-4b9a-a5e3-cbb6fdec354d",

5link  "name": "Project Setting 1",

6link  "poleHeight": 200,

7link  "adapter": true,

8link  "totalHeight": 2.09476,

9link  "minAccuracy": 10,

10link  "minAccuracyType": 0,

11link  "recordTime": 1,

12link  "createdDate": "2021-04-30T16:02:55Z",

13link  "lastUpdated": "2021-04-30T16:02:55Z"

14link},

linkPOST Create Project Settings

Admin

HTTP-Post handler that creates a new project setting.

Parameters

chevron_right

NameString
The name of the project setting
PoleHeightDecimal
A Decimal floating point representing the centimers of the height of the pole in use. Marxact pole is 200 cm.
AdapterBoolean
Whether there is an addapter.
MinAccuracyInt16
A Short that represent the minimum accuracy for your project settings. For example 10 cm
MinAccuracyTypeInt16
A Short that can take one of three values. Either 0
RecordTimeInt16
it means that the point measured would be an average of the positions during these 10 seconds. We suggest to use 1 second.

Returns

chevron_right

The created project setting.

1linkPOST https://api.marxact.com/v1/Survey/projectsettings HTTP/1.1

2linkAuthorization: Bearer {{token}}

3linkContent-Type: application/json

4link

5link{

6link  "name": "Project Setting",

7link  "poleHeight": 200,

8link  "adapter": true,

9link  "minAccuracy": 10,

10link  "minAccuracyType": 0,

11link  "recordTime": 1

12link}

1linkHTTP/1.1 200 Ok

2linkContent-Type: application/json

3link{

4link  "id": "315cd8ce-976e-4b9a-a5e3-cbb6fdec354d",

5link  "name": "Project Setting",

6link  "poleHeight": 200,

7link  "adapter": true,

8link  "totalHeight": 2.09476,

9link  "minAccuracy": 10,

10link  "minAccuracyType": 0,

11link  "recordTime": 1,

12link  "createdDate": "2023-04-30T16:02:55Z",

13link  "lastUpdated": "2023-04-30T16:02:55Z"

14link},

Survey

linkGET Retrieve all Projects.

Parameters

Returns

linkGET Retrieve Project by ID

Parameters

projectIdGuid

Returns

linkPOST Create a New Project

Parameters

Namestring

Descriptionstring

CoordinateReferenceSystemCRS

projectSettingProjectSetting

Show child parameters

projectSetting.Id

ProjectUsersProjectUser[]

Show child parameters

projectUser.userId

ProjectDevicesProjectDevice[]

Show child parameters

projectDevices.deviceSerial

Returns

linkGET Get Layers

Parameters

Returns

linkGET Get Layer

Parameters

layerIdGuid

Returns

linkPOST Post Layers

Parameters

Namestring

Descriptionstring

Colorstring

AttributesAttribute[]

Show child parameters

Namestring

Typestring

Requiredboolean

Valuesstring[]

Returns

linkGET Get Project Settings

Parameters

Returns

linkGET Get Project Setting

Parameters

settingIdGuid

Returns

linkPOST Create Project Settings

Parameters

NameString

PoleHeightDecimal

AdapterBoolean

MinAccuracyInt16

MinAccuracyTypeInt16

RecordTimeInt16

Returns