externalapi_v1 v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Authentication

API Key (Auth Token)
- Parameter Name: SessionToken, in: cookie. Auth Token
API Key (Bearer)
- Parameter Name: Authorization, in: header. Auth Token
API Key (Tenant)
- Parameter Name: Tenant, in: header. Name of tenant

CategoriesExternal

Returns a list of Categories

Code samples

# You can also use wget
curl -X GET /app/usermanagement/categories \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/categories HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/categories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/categories', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/categories";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/categories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/categories

Parameters

Name	In	Type	Required	Description
onlyActive	query	boolean	false	Show only active records - true, show all records - false
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","positions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "positions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CategoryIEnumerableApiResponse

LocationsExternal

Send data to a location

Code samples

# You can also use wget
curl -X POST /app/usermanagement/locations \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/locations HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/locations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/locations";

      string json = @"{
  ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
  ""time"": ""2019-08-24T14:15:22Z"",
  ""name"": ""string"",
  ""state"": 0,
  ""description"": ""string"",
  ""type"": 0,
  ""licencePlate"": ""string"",
  ""imoNumber"": ""string"",
  ""mmsiNumber"": ""string"",
  ""globalId"": ""string"",
  ""routeId"": ""string"",
  ""locationPositions"": [
    {
      ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
      ""positionId"": ""da3402dc-13f8-45f9-83a6-bde06dd8eb35"",
      ""state"": 0
    }
  ],
  ""metaData"": [
    {
      ""name"": ""string"",
      ""value"": ""string"",
      ""type"": 0,
      ""dropdownTypeOptions"": [
        ""string""
      ]
    }
  ],
  ""primary"": true,
  ""timeZone"": ""string"",
  ""isVirtual"": true
}";
      Location content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(Location content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(Location content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/locations

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Location	false	Location object to create

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationApiResponse

Get data from all locations

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"primary":true,"metaData":{"property1":"string","property2":"string"}}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "type": 0,
      "licencePlate": "string",
      "imoNumber": "string",
      "mmsiNumber": "string",
      "globalId": "string",
      "routeId": "string",
      "locationPositions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
          "state": 0
        }
      ],
      "primary": true,
      "metaData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationForApiIEnumerableApiResponse

Updates the specified location

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/locations/{locationId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/locations/{locationId} HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/locations/{locationId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/locations/{locationId}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to update
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Location	false	Location object to update

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationApiResponse

Deletes a location

Code samples

# You can also use wget
curl -X DELETE /app/usermanagement/locations/{locationId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

DELETE /app/usermanagement/locations/{locationId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/app/usermanagement/locations/{locationId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/app/usermanagement/locations/{locationId}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /app/usermanagement/locations/{locationId}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to remove
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage

Return data from a specific location

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/{locationId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/{locationId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/{locationId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/{locationId}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/{locationId}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to get
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"primary":true,"metaData":{"property1":"string","property2":"string"}}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "primary": true,
    "metaData": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationForApiApiResponse

Return data form available location

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/available \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/available HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/available',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/available', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/available";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/available");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/available

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string","description":"string","type":0,"primary":true,"isVirtual":true}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": 0,
      "primary": true,
      "isVirtual": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationShortGeneralIEnumerableApiResponse

Return info about the current position

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/current \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/current HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/current',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/current', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/current";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/current");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/current

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string","description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": 0,
      "licencePlate": "string",
      "imoNumber": "string",
      "mmsiNumber": "string",
      "globalId": "string",
      "routeId": "string",
      "metaData": [
        {
          "name": "string",
          "value": "string",
          "type": 0,
          "dropdownTypeOptions": [
            "string"
          ]
        }
      ],
      "primary": true,
      "timeZone": "string",
      "isVirtual": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationGeneralIEnumerableApiResponse

Return info from fixed position

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/primary \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/primary HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/primary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/primary', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/primary";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/primary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/primary

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string","description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationGeneralApiResponse

Create info about multiple locations

Code samples

# You can also use wget
curl -X POST /app/usermanagement/locations/batch \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/locations/batch HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
]';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/batch',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/locations/batch', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/locations/batch";

      string json = @"[
  {
    ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
    ""time"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""state"": 0,
    ""description"": ""string"",
    ""type"": 0,
    ""licencePlate"": ""string"",
    ""imoNumber"": ""string"",
    ""mmsiNumber"": ""string"",
    ""globalId"": ""string"",
    ""routeId"": ""string"",
    ""locationPositions"": [
      {
        ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
        ""positionId"": ""da3402dc-13f8-45f9-83a6-bde06dd8eb35"",
        ""state"": 0
      }
    ],
    ""metaData"": [
      {
        ""name"": ""string"",
        ""value"": ""string"",
        ""type"": 0,
        ""dropdownTypeOptions"": [
          ""string""
        ]
      }
    ],
    ""primary"": true,
    ""timeZone"": ""string"",
    ""isVirtual"": true
  }
]";
      Location content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(Location content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(Location content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/batch");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/locations/batch

Body parameter

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
]

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Location	false	Array of location objects to create

Example responses

200 Response

{"data":{"items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true}],"errors":[{"item":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","type":0,"licencePlate":"string","imoNumber":"string","mmsiNumber":"string","globalId":"string","routeId":"string","locationPositions":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","state":0}],"metaData":[{"name":"string","value":"string","type":0,"dropdownTypeOptions":["string"]}],"primary":true,"timeZone":"string","isVirtual":true},"errorType":"string","errorMessage":"string"}]}}

{
  "data": {
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "type": 0,
        "licencePlate": "string",
        "imoNumber": "string",
        "mmsiNumber": "string",
        "globalId": "string",
        "routeId": "string",
        "locationPositions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
            "state": 0
          }
        ],
        "metaData": [
          {
            "name": "string",
            "value": "string",
            "type": 0,
            "dropdownTypeOptions": [
              "string"
            ]
          }
        ],
        "primary": true,
        "timeZone": "string",
        "isVirtual": true
      }
    ],
    "errors": [
      {
        "item": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "time": "2019-08-24T14:15:22Z",
          "timeString": "string",
          "name": "string",
          "state": 0,
          "description": "string",
          "type": 0,
          "licencePlate": "string",
          "imoNumber": "string",
          "mmsiNumber": "string",
          "globalId": "string",
          "routeId": "string",
          "locationPositions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
              "state": 0
            }
          ],
          "metaData": [
            {
              "name": "string",
              "value": "string",
              "type": 0,
              "dropdownTypeOptions": [
                "string"
              ]
            }
          ],
          "primary": true,
          "timeZone": "string",
          "isVirtual": true
        },
        "errorType": "string",
        "errorMessage": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LocationCreateManyItemsResponseApiResponse

Retrieves metadata from all locations

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/metadata \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/metadata HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/metadata',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/metadata', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/metadata";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/metadata

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"property1":{"property1":"string","property2":"string"},"property2":{"property1":"string","property2":"string"}}}

{
  "data": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	GuidStringStringDictionaryDictionaryApiResponse
404	Not Found	Not Found	ApiMessage

Retrieves metadata from a specific location

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/{locationId}/metadata \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/{locationId}/metadata HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/metadata',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/{locationId}/metadata', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/{locationId}/metadata";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/{locationId}/metadata

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to get metadata
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"property1":"string","property2":"string"}}

{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	StringStringDictionaryApiResponse
404	Not Found	Not Found	ApiMessage

Create location specified metadata

Code samples

# You can also use wget
curl -X POST /app/usermanagement/locations/{locationId}/metadata \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/locations/{locationId}/metadata HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/metadata',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/locations/{locationId}/metadata', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/locations/{locationId}/metadata";

      string json = @"{
  ""metaData"": [
    {
      ""name"": ""string"",
      ""value"": ""string"",
      ""type"": 0,
      ""dropdownTypeOptions"": [
        ""string""
      ]
    }
  ]
}";
      CreateLocationMetaData content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(CreateLocationMetaData content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(CreateLocationMetaData content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/locations/{locationId}/metadata

Body parameter

{
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	none
api-version	query	string	false	none
api-version	header	string	false	none
body	body	CreateLocationMetaData	false	Metadata object to add

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage
404	Not Found	Not Found	ApiMessage

Update metadata on current location

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/locations/currentLocation/metadata \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/locations/currentLocation/metadata HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "metaData": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/currentLocation/metadata',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/locations/currentLocation/metadata', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/currentLocation/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/locations/currentLocation/metadata

Body parameter

{
  "metaData": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	UpdateLocationMetaData	false	Location metadata update model

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage
404	Not Found	Not Found	ApiMessage

Remove metadata from a specific location

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/locations/{locationId}/metadata/remove \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/locations/{locationId}/metadata/remove HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "metaDataNames": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/metadata/remove',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/locations/{locationId}/metadata/remove', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/metadata/remove");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/locations/{locationId}/metadata/remove

Body parameter

{
  "metaDataNames": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to remove metadata
api-version	query	string	false	none
api-version	header	string	false	none
body	body	RemovedLocationMetaData	false	Object with list of metadata to remove

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage
404	Not Found	Not Found	ApiMessage

Return the route to a specific location

Code samples

# You can also use wget
curl -X GET /app/usermanagement/locations/{locationId}/route \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/locations/{locationId}/route HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/route',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/locations/{locationId}/route', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/locations/{locationId}/route";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/route");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/locations/{locationId}/route

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to get route
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":"string"}

{
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	StringApiResponse

Create a route to a specific location

Code samples

# You can also use wget
curl -X POST /app/usermanagement/locations/{locationId}/route \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/locations/{locationId}/route HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "routeId": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/route',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/locations/{locationId}/route', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/locations/{locationId}/route";

      string json = @"{
  ""routeId"": ""string""
}";
      LocationRoute content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(LocationRoute content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(LocationRoute content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/route");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/locations/{locationId}/route

Body parameter

{
  "routeId": "string"
}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	none
api-version	query	string	false	none
api-version	header	string	false	none
body	body	LocationRoute	false	Route of location to create

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage

Delete route for a specific location

Code samples

# You can also use wget
curl -X DELETE /app/usermanagement/locations/{locationId}/route \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

DELETE /app/usermanagement/locations/{locationId}/route HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/locations/{locationId}/route',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/app/usermanagement/locations/{locationId}/route', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/app/usermanagement/locations/{locationId}/route";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/locations/{locationId}/route");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /app/usermanagement/locations/{locationId}/route

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to delete route
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage

OrganisationsExternal

Retrieve an organisation

Code samples

# You can also use wget
curl -X GET /app/usermanagement/organisations/{organisationId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/organisations/{organisationId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/organisations/{organisationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/organisations/{organisationId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/organisations/{organisationId}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/organisations/{organisationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/organisations/{organisationId}

Parameters

Name	In	Type	Required	Description
organisationId	path	string(uuid)	true	ID of organisation to get
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string"}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	OrganisationApiResponse

Retrieve a list of all organisations

Code samples

# You can also use wget
curl -X GET /app/usermanagement/organisations \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/organisations HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/organisations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/organisations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/organisations";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/organisations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/organisations

Parameters

Name	In	Type	Required	Description
onlyActive	query	boolean	false	Show only active records - true, show all records - false
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string"}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	OrganisationIEnumerableApiResponse

PersonsExternal

Retrieves a list of all persons

Code samples

# You can also use wget
curl -X GET /app/usermanagement/persons \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/persons HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/persons', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/persons";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/persons

Parameters

Name	In	Type	Required	Description
onlyActive	query	boolean	false	Show only active records - true, show all records - false
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"email":"string","fullName":"string","phoneNumber":"string","aliasNames":[{"name":"string","fullName":"string"}],"organisation":"a4b97354-4e56-4723-bc0e-1f22b5fcbed6","positionAssignments":[{"locationId":"1a5515a3-ba81-4a42-aee7-ad9ffc090a54","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","activelyAssigned":true,"assignedSince":"2019-08-24T14:15:22Z","activelyAssignedSince":"2019-08-24T14:15:22Z","handedOverBy":"879bf519-ed9f-438c-93e9-c426df595b6d","handedOverByName":"string","switchedBy":"b0416909-d866-4b69-87e1-50c567bb29d8","switchedByName":"string"}],"permissions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"lastActivity":{"position":"0e5919e5-e53d-46dc-8c08-74a8a4a272c7","location":"15f20760-76a7-41ee-b509-705d3ffd8eb5","time":"2019-08-24T14:15:22Z","hasActiveSessions":true,"timeDiff":"string"},"profileImageUrl":"string","associatedAccounts":[{"oAuthProviderId":"e022dc50-bbc1-400a-bece-2ec048d335a3","subjectId":"string"}],"passwordUpdateTime":"2019-08-24T14:15:22Z","defaultPassword":"string","resetPassword":{"resetLink":"string","initiatedBy":"7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6","validFor":"2019-08-24T14:15:22Z","lastResetDate":"2019-08-24T14:15:22Z","lastResetInitiatedBy":"7452ebfc-dad1-4b4b-a729-e8e2fa335444"}}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "email": "string",
      "fullName": "string",
      "phoneNumber": "string",
      "aliasNames": [
        {
          "name": "string",
          "fullName": "string"
        }
      ],
      "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
      "positionAssignments": [
        {
          "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
          "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
          "activelyAssigned": true,
          "assignedSince": "2019-08-24T14:15:22Z",
          "activelyAssignedSince": "2019-08-24T14:15:22Z",
          "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
          "handedOverByName": "string",
          "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
          "switchedByName": "string"
        }
      ],
      "permissions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "lastActivity": {
        "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
        "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
        "time": "2019-08-24T14:15:22Z",
        "hasActiveSessions": true,
        "timeDiff": "string"
      },
      "profileImageUrl": "string",
      "associatedAccounts": [
        {
          "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
          "subjectId": "string"
        }
      ],
      "passwordUpdateTime": "2019-08-24T14:15:22Z",
      "defaultPassword": "string",
      "resetPassword": {
        "resetLink": "string",
        "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
        "validFor": "2019-08-24T14:15:22Z",
        "lastResetDate": "2019-08-24T14:15:22Z",
        "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PersonIEnumerableApiResponse

Create a new person

Code samples

# You can also use wget
curl -X POST /app/usermanagement/persons \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/persons HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/persons', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/persons";

      string json = @"{
  ""name"": ""string"",
  ""fullName"": ""string"",
  ""phoneNumber"": ""string"",
  ""defaultPassword"": ""string"",
  ""state"": 0,
  ""email"": ""[email protected]"",
  ""organisation"": ""a4b97354-4e56-4723-bc0e-1f22b5fcbed6"",
  ""positionAssignments"": [
    {
      ""locationId"": ""1a5515a3-ba81-4a42-aee7-ad9ffc090a54"",
      ""positionId"": ""da3402dc-13f8-45f9-83a6-bde06dd8eb35""
    }
  ],
  ""aliasNames"": [
    {
      ""name"": ""string"",
      ""fullName"": ""string""
    }
  ]
}";
      CreatePerson content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(CreatePerson content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(CreatePerson content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/persons

Body parameter

{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	CreatePerson	false	Person object to create

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"email":"string","fullName":"string","phoneNumber":"string","aliasNames":[{"name":"string","fullName":"string"}],"organisation":"a4b97354-4e56-4723-bc0e-1f22b5fcbed6","positionAssignments":[{"locationId":"1a5515a3-ba81-4a42-aee7-ad9ffc090a54","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","activelyAssigned":true,"assignedSince":"2019-08-24T14:15:22Z","activelyAssignedSince":"2019-08-24T14:15:22Z","handedOverBy":"879bf519-ed9f-438c-93e9-c426df595b6d","handedOverByName":"string","switchedBy":"b0416909-d866-4b69-87e1-50c567bb29d8","switchedByName":"string"}],"permissions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"lastActivity":{"position":"0e5919e5-e53d-46dc-8c08-74a8a4a272c7","location":"15f20760-76a7-41ee-b509-705d3ffd8eb5","time":"2019-08-24T14:15:22Z","hasActiveSessions":true,"timeDiff":"string"},"profileImageUrl":"string","associatedAccounts":[{"oAuthProviderId":"e022dc50-bbc1-400a-bece-2ec048d335a3","subjectId":"string"}],"passwordUpdateTime":"2019-08-24T14:15:22Z","defaultPassword":"string","resetPassword":{"resetLink":"string","initiatedBy":"7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6","validFor":"2019-08-24T14:15:22Z","lastResetDate":"2019-08-24T14:15:22Z","lastResetInitiatedBy":"7452ebfc-dad1-4b4b-a729-e8e2fa335444"}}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "email": "string",
    "fullName": "string",
    "phoneNumber": "string",
    "aliasNames": [
      {
        "name": "string",
        "fullName": "string"
      }
    ],
    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
    "positionAssignments": [
      {
        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "activelyAssigned": true,
        "assignedSince": "2019-08-24T14:15:22Z",
        "activelyAssignedSince": "2019-08-24T14:15:22Z",
        "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
        "handedOverByName": "string",
        "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
        "switchedByName": "string"
      }
    ],
    "permissions": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "lastActivity": {
      "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
      "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
      "time": "2019-08-24T14:15:22Z",
      "hasActiveSessions": true,
      "timeDiff": "string"
    },
    "profileImageUrl": "string",
    "associatedAccounts": [
      {
        "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
        "subjectId": "string"
      }
    ],
    "passwordUpdateTime": "2019-08-24T14:15:22Z",
    "defaultPassword": "string",
    "resetPassword": {
      "resetLink": "string",
      "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
      "validFor": "2019-08-24T14:15:22Z",
      "lastResetDate": "2019-08-24T14:15:22Z",
      "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PersonApiResponse

Retrieves info from a specific person

Code samples

# You can also use wget
curl -X GET /app/usermanagement/persons/{personId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/persons/{personId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons/{personId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/persons/{personId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/persons/{personId}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons/{personId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/persons/{personId}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"email":"string","fullName":"string","phoneNumber":"string","aliasNames":[{"name":"string","fullName":"string"}],"organisation":"a4b97354-4e56-4723-bc0e-1f22b5fcbed6","positionAssignments":[{"locationId":"1a5515a3-ba81-4a42-aee7-ad9ffc090a54","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","activelyAssigned":true,"assignedSince":"2019-08-24T14:15:22Z","activelyAssignedSince":"2019-08-24T14:15:22Z","handedOverBy":"879bf519-ed9f-438c-93e9-c426df595b6d","handedOverByName":"string","switchedBy":"b0416909-d866-4b69-87e1-50c567bb29d8","switchedByName":"string"}],"permissions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"lastActivity":{"position":"0e5919e5-e53d-46dc-8c08-74a8a4a272c7","location":"15f20760-76a7-41ee-b509-705d3ffd8eb5","time":"2019-08-24T14:15:22Z","hasActiveSessions":true,"timeDiff":"string"},"profileImageUrl":"string","associatedAccounts":[{"oAuthProviderId":"e022dc50-bbc1-400a-bece-2ec048d335a3","subjectId":"string"}],"passwordUpdateTime":"2019-08-24T14:15:22Z","defaultPassword":"string","resetPassword":{"resetLink":"string","initiatedBy":"7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6","validFor":"2019-08-24T14:15:22Z","lastResetDate":"2019-08-24T14:15:22Z","lastResetInitiatedBy":"7452ebfc-dad1-4b4b-a729-e8e2fa335444"}}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "email": "string",
    "fullName": "string",
    "phoneNumber": "string",
    "aliasNames": [
      {
        "name": "string",
        "fullName": "string"
      }
    ],
    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
    "positionAssignments": [
      {
        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "activelyAssigned": true,
        "assignedSince": "2019-08-24T14:15:22Z",
        "activelyAssignedSince": "2019-08-24T14:15:22Z",
        "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
        "handedOverByName": "string",
        "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
        "switchedByName": "string"
      }
    ],
    "permissions": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "lastActivity": {
      "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
      "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
      "time": "2019-08-24T14:15:22Z",
      "hasActiveSessions": true,
      "timeDiff": "string"
    },
    "profileImageUrl": "string",
    "associatedAccounts": [
      {
        "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
        "subjectId": "string"
      }
    ],
    "passwordUpdateTime": "2019-08-24T14:15:22Z",
    "defaultPassword": "string",
    "resetPassword": {
      "resetLink": "string",
      "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
      "validFor": "2019-08-24T14:15:22Z",
      "lastResetDate": "2019-08-24T14:15:22Z",
      "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PersonApiResponse

Update info about a specific person

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/persons/{personId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/persons/{personId} HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons/{personId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/persons/{personId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons/{personId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/persons/{personId}

Body parameter

{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	ID of person to update
api-version	query	string	false	none
api-version	header	string	false	none
body	body	UpdatePerson	false	Person object to update

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"email":"string","fullName":"string","phoneNumber":"string","aliasNames":[{"name":"string","fullName":"string"}],"organisation":"a4b97354-4e56-4723-bc0e-1f22b5fcbed6","positionAssignments":[{"locationId":"1a5515a3-ba81-4a42-aee7-ad9ffc090a54","positionId":"da3402dc-13f8-45f9-83a6-bde06dd8eb35","activelyAssigned":true,"assignedSince":"2019-08-24T14:15:22Z","activelyAssignedSince":"2019-08-24T14:15:22Z","handedOverBy":"879bf519-ed9f-438c-93e9-c426df595b6d","handedOverByName":"string","switchedBy":"b0416909-d866-4b69-87e1-50c567bb29d8","switchedByName":"string"}],"permissions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"lastActivity":{"position":"0e5919e5-e53d-46dc-8c08-74a8a4a272c7","location":"15f20760-76a7-41ee-b509-705d3ffd8eb5","time":"2019-08-24T14:15:22Z","hasActiveSessions":true,"timeDiff":"string"},"profileImageUrl":"string","associatedAccounts":[{"oAuthProviderId":"e022dc50-bbc1-400a-bece-2ec048d335a3","subjectId":"string"}],"passwordUpdateTime":"2019-08-24T14:15:22Z","defaultPassword":"string","resetPassword":{"resetLink":"string","initiatedBy":"7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6","validFor":"2019-08-24T14:15:22Z","lastResetDate":"2019-08-24T14:15:22Z","lastResetInitiatedBy":"7452ebfc-dad1-4b4b-a729-e8e2fa335444"}}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "email": "string",
    "fullName": "string",
    "phoneNumber": "string",
    "aliasNames": [
      {
        "name": "string",
        "fullName": "string"
      }
    ],
    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
    "positionAssignments": [
      {
        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "activelyAssigned": true,
        "assignedSince": "2019-08-24T14:15:22Z",
        "activelyAssignedSince": "2019-08-24T14:15:22Z",
        "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
        "handedOverByName": "string",
        "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
        "switchedByName": "string"
      }
    ],
    "permissions": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "lastActivity": {
      "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
      "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
      "time": "2019-08-24T14:15:22Z",
      "hasActiveSessions": true,
      "timeDiff": "string"
    },
    "profileImageUrl": "string",
    "associatedAccounts": [
      {
        "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
        "subjectId": "string"
      }
    ],
    "passwordUpdateTime": "2019-08-24T14:15:22Z",
    "defaultPassword": "string",
    "resetPassword": {
      "resetLink": "string",
      "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
      "validFor": "2019-08-24T14:15:22Z",
      "lastResetDate": "2019-08-24T14:15:22Z",
      "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PersonApiResponse

Delete a specific person

Code samples

# You can also use wget
curl -X DELETE /app/usermanagement/persons/{personId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

DELETE /app/usermanagement/persons/{personId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons/{personId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/app/usermanagement/persons/{personId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/app/usermanagement/persons/{personId}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons/{personId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /app/usermanagement/persons/{personId}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	ApiMessage

Update position for a specific person

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/persons/{personId}/position \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/persons/{personId}/position HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/persons/{personId}/position',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/persons/{personId}/position', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/persons/{personId}/position");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/persons/{personId}/position

Body parameter

{
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	ID of person to set position
api-version	query	string	false	none
api-version	header	string	false	none
body	body	PersonPosition	false	Person position object

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage

PositionsExternal

Retrieves a list of all positions

Code samples

# You can also use wget
curl -X GET /app/usermanagement/positions \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/positions HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/positions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/positions";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/positions

Parameters

Name	In	Type	Required	Description
allLocations	query	boolean	false	Show only active records - true, show all records - false
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string"}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionGeneralIEnumerableApiResponse

Create a list of all positions

Code samples

# You can also use wget
curl -X POST /app/usermanagement/positions \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/positions HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "title": "string",
  "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
  "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
  "categories": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "shouldAlwaysBeAssigned": true,
  "allowMultipleActiveAssigns": true
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/positions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/positions";

      string json = @"{
  ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
  ""time"": ""2019-08-24T14:15:22Z"",
  ""name"": ""string"",
  ""state"": 0,
  ""description"": ""string"",
  ""title"": ""string"",
  ""permissionGroup"": ""a0ff8c0c-35e9-4086-abef-03d1c511f4e0"",
  ""permissionGroupWhenActivelyAssigned"": ""267d3047-eccd-4f37-b137-e7009e668846"",
  ""categories"": [
    ""497f6eca-6276-4993-bfeb-53cbbbba6f08""
  ],
  ""shouldAlwaysBeAssigned"": true,
  ""allowMultipleActiveAssigns"": true
}";
      Position content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(Position content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(Position content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/positions

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "title": "string",
  "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
  "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
  "categories": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "shouldAlwaysBeAssigned": true,
  "allowMultipleActiveAssigns": true
}

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Position	false	Position object to create

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","title":"string","permissionGroup":"a0ff8c0c-35e9-4086-abef-03d1c511f4e0","permissionGroupWhenActivelyAssigned":"267d3047-eccd-4f37-b137-e7009e668846","categories":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"shouldAlwaysBeAssigned":true,"allowMultipleActiveAssigns":true}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionApiResponse

Retrieves positions

Code samples

# You can also use wget
curl -X GET /app/usermanagement/positions/locations/{locationId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/positions/locations/{locationId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions/locations/{locationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/positions/locations/{locationId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/positions/locations/{locationId}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions/locations/{locationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/positions/locations/{locationId}

Parameters

Name	In	Type	Required	Description
locationId	path	string(uuid)	true	ID of location to get
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","title":"string","permissionGroup":"a0ff8c0c-35e9-4086-abef-03d1c511f4e0","permissionGroupWhenActivelyAssigned":"267d3047-eccd-4f37-b137-e7009e668846","categories":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"shouldAlwaysBeAssigned":true,"allowMultipleActiveAssigns":true}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "title": "string",
      "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
      "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
      "categories": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "shouldAlwaysBeAssigned": true,
      "allowMultipleActiveAssigns": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionIEnumerableApiResponse

Updates position

Code samples

# You can also use wget
curl -X PATCH /app/usermanagement/positions/{positionId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

PATCH /app/usermanagement/positions/{positionId} HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "title": "string",
  "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
  "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
  "categories": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "shouldAlwaysBeAssigned": true,
  "allowMultipleActiveAssigns": true
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions/{positionId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/app/usermanagement/positions/{positionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions/{positionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PATCH /app/usermanagement/positions/{positionId}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "name": "string",
  "state": 0,
  "description": "string",
  "title": "string",
  "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
  "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
  "categories": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "shouldAlwaysBeAssigned": true,
  "allowMultipleActiveAssigns": true
}

Parameters

Name	In	Type	Required	Description
positionId	path	string(uuid)	true	ID of position to update
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Position	false	Position object to create

Example responses

200 Response

{"data":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","title":"string","permissionGroup":"a0ff8c0c-35e9-4086-abef-03d1c511f4e0","permissionGroupWhenActivelyAssigned":"267d3047-eccd-4f37-b137-e7009e668846","categories":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"shouldAlwaysBeAssigned":true,"allowMultipleActiveAssigns":true}}

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionApiResponse

Delete a position

Code samples

# You can also use wget
curl -X DELETE /app/usermanagement/positions/{positionId} \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

DELETE /app/usermanagement/positions/{positionId} HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions/{positionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/app/usermanagement/positions/{positionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/app/usermanagement/positions/{positionId}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions/{positionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /app/usermanagement/positions/{positionId}

Parameters

Name	In	Type	Required	Description
positionId	path	string(uuid)	true	none
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

204 Response

{"message":"string"}

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	ApiMessage

Create a list of multiple positions

Code samples

# You can also use wget
curl -X POST /app/usermanagement/positions/batch \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

POST /app/usermanagement/positions/batch HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain
api-version: string

const inputBody = '[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  }
]';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positions/batch',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/app/usermanagement/positions/batch', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/app/usermanagement/positions/batch";

      string json = @"[
  {
    ""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
    ""time"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""state"": 0,
    ""description"": ""string"",
    ""title"": ""string"",
    ""permissionGroup"": ""a0ff8c0c-35e9-4086-abef-03d1c511f4e0"",
    ""permissionGroupWhenActivelyAssigned"": ""267d3047-eccd-4f37-b137-e7009e668846"",
    ""categories"": [
      ""497f6eca-6276-4993-bfeb-53cbbbba6f08""
    ],
    ""shouldAlwaysBeAssigned"": true,
    ""allowMultipleActiveAssigns"": true
  }
]";
      Position content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(Position content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(Position content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positions/batch");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /app/usermanagement/positions/batch

Body parameter

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  }
]

Parameters

Name	In	Type	Required	Description
api-version	query	string	false	none
api-version	header	string	false	none
body	body	Position	false	Array of positions to create

Example responses

200 Response

{"data":{"items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","title":"string","permissionGroup":"a0ff8c0c-35e9-4086-abef-03d1c511f4e0","permissionGroupWhenActivelyAssigned":"267d3047-eccd-4f37-b137-e7009e668846","categories":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"shouldAlwaysBeAssigned":true,"allowMultipleActiveAssigns":true}],"errors":[{"item":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","title":"string","permissionGroup":"a0ff8c0c-35e9-4086-abef-03d1c511f4e0","permissionGroupWhenActivelyAssigned":"267d3047-eccd-4f37-b137-e7009e668846","categories":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"shouldAlwaysBeAssigned":true,"allowMultipleActiveAssigns":true},"errorType":"string","errorMessage":"string"}]}}

{
  "data": {
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "title": "string",
        "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
        "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
        "categories": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "shouldAlwaysBeAssigned": true,
        "allowMultipleActiveAssigns": true
      }
    ],
    "errors": [
      {
        "item": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "time": "2019-08-24T14:15:22Z",
          "timeString": "string",
          "name": "string",
          "state": 0,
          "description": "string",
          "title": "string",
          "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
          "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
          "categories": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "shouldAlwaysBeAssigned": true,
          "allowMultipleActiveAssigns": true
        },
        "errorType": "string",
        "errorMessage": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionCreateManyItemsResponseApiResponse

PositionTeamsExternal

Retrieves a list of Position Teams

Code samples

# You can also use wget
curl -X GET /app/usermanagement/positionTeams \
  -H 'Accept: text/plain' \
  -H 'api-version: string' \
  -H 'Authorization: API_KEY' \
  -H 'Tenant: API_KEY'

GET /app/usermanagement/positionTeams HTTP/1.1

Accept: text/plain
api-version: string


const headers = {
  'Accept':'text/plain',
  'api-version':'string',
  'Authorization':'API_KEY',
  'Tenant':'API_KEY'
};

fetch('/app/usermanagement/positionTeams',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
    'Authorization' => 'API_KEY',
    'Tenant' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/app/usermanagement/positionTeams', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/app/usermanagement/positionTeams";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

URL obj = new URL("/app/usermanagement/positionTeams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /app/usermanagement/positionTeams

Parameters

Name	In	Type	Required	Description
onlyActive	query	boolean	false	Show only active records - true, show all records - false
api-version	query	string	false	none
api-version	header	string	false	none

Example responses

200 Response

{"data":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time":"2019-08-24T14:15:22Z","timeString":"string","name":"string","state":0,"description":"string","positions":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}]}

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "positions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	PositionTeamIEnumerableApiResponse

Schemas

AliasName

{
  "name": "string",
  "fullName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
fullName	string¦null	false	none	none

ApiMessage

{
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
message	string¦null	false	none	none

AssociatedAccount

{
  "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
  "subjectId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
oAuthProviderId	string(uuid)	false	none	none
subjectId	string¦null	false	none	none

CategoryIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "positions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[Category]¦null	false	none	none

CreateLocationMetaData

{
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
metaData	[LocationMetadata]¦null	false	none	none

CreatePerson

{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
fullName	string¦null	false	none	none
phoneNumber	string¦null	false	none	none
defaultPassword	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
email	string(email)¦null	false	none	none
organisation	string(uuid)	false	none	none
positionAssignments	[PositionAssignmentItem]¦null	false	none	none
aliasNames	[AliasName]¦null	false	none	none

GuidStringStringDictionaryDictionaryApiResponse

{
  "data": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	object¦null	false	none	none
» additionalProperties	object¦null	false	none	none
»» additionalProperties	string	false	none	none

Location

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
description	string¦null	false	none	none
type	LocationType	false	none	Office = 0 Vessel = 1 Truck = 2
licencePlate	string¦null	false	none	none
imoNumber	string¦null	false	none	none
mmsiNumber	string¦null	false	none	none
globalId	string¦null	false	none	none
routeId	string¦null	false	none	none
locationPositions	[LocationPosition]¦null	false	none	none
metaData	[LocationMetadata]¦null	false	none	none
primary	boolean	false	none	none
timeZone	string¦null	false	none	none
isVirtual	boolean	false	none	none

LocationApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	Location	false	none	none

LocationCreateManyItemsError

{
  "item": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  },
  "errorType": "string",
  "errorMessage": "string"
}

Properties

Name	Type	Required	Restrictions	Description
item	Location	false	none	none
errorType	string¦null	false	none	none
errorMessage	string¦null	false	none	none

LocationCreateManyItemsResponse

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "type": 0,
      "licencePlate": "string",
      "imoNumber": "string",
      "mmsiNumber": "string",
      "globalId": "string",
      "routeId": "string",
      "locationPositions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
          "state": 0
        }
      ],
      "metaData": [
        {
          "name": "string",
          "value": "string",
          "type": 0,
          "dropdownTypeOptions": [
            "string"
          ]
        }
      ],
      "primary": true,
      "timeZone": "string",
      "isVirtual": true
    }
  ],
  "errors": [
    {
      "item": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "type": 0,
        "licencePlate": "string",
        "imoNumber": "string",
        "mmsiNumber": "string",
        "globalId": "string",
        "routeId": "string",
        "locationPositions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
            "state": 0
          }
        ],
        "metaData": [
          {
            "name": "string",
            "value": "string",
            "type": 0,
            "dropdownTypeOptions": [
              "string"
            ]
          }
        ],
        "primary": true,
        "timeZone": "string",
        "isVirtual": true
      },
      "errorType": "string",
      "errorMessage": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[Location]¦null	false	read-only	none
errors	[LocationCreateManyItemsError]¦null	false	read-only	none

LocationCreateManyItemsResponseApiResponse

{
  "data": {
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "type": 0,
        "licencePlate": "string",
        "imoNumber": "string",
        "mmsiNumber": "string",
        "globalId": "string",
        "routeId": "string",
        "locationPositions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
            "state": 0
          }
        ],
        "metaData": [
          {
            "name": "string",
            "value": "string",
            "type": 0,
            "dropdownTypeOptions": [
              "string"
            ]
          }
        ],
        "primary": true,
        "timeZone": "string",
        "isVirtual": true
      }
    ],
    "errors": [
      {
        "item": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "time": "2019-08-24T14:15:22Z",
          "timeString": "string",
          "name": "string",
          "state": 0,
          "description": "string",
          "type": 0,
          "licencePlate": "string",
          "imoNumber": "string",
          "mmsiNumber": "string",
          "globalId": "string",
          "routeId": "string",
          "locationPositions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
              "state": 0
            }
          ],
          "metaData": [
            {
              "name": "string",
              "value": "string",
              "type": 0,
              "dropdownTypeOptions": [
                "string"
              ]
            }
          ],
          "primary": true,
          "timeZone": "string",
          "isVirtual": true
        },
        "errorType": "string",
        "errorMessage": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	LocationCreateManyItemsResponse	false	none	none

LocationForApi

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "locationPositions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "state": 0
    }
  ],
  "primary": true,
  "metaData": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
description	string¦null	false	none	none
type	LocationType	false	none	Office = 0 Vessel = 1 Truck = 2
licencePlate	string¦null	false	none	none
imoNumber	string¦null	false	none	none
mmsiNumber	string¦null	false	none	none
globalId	string¦null	false	none	none
routeId	string¦null	false	none	none
locationPositions	[LocationPosition]¦null	false	none	none
primary	boolean	false	none	none
metaData	object¦null	false	none	none
» additionalProperties	string¦null	false	none	none

LocationForApiApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "locationPositions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "state": 0
      }
    ],
    "primary": true,
    "metaData": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	LocationForApi	false	none	none

LocationForApiIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "type": 0,
      "licencePlate": "string",
      "imoNumber": "string",
      "mmsiNumber": "string",
      "globalId": "string",
      "routeId": "string",
      "locationPositions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
          "state": 0
        }
      ],
      "primary": true,
      "metaData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[LocationForApi]¦null	false	none	none

LocationGeneral

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": 0,
  "licencePlate": "string",
  "imoNumber": "string",
  "mmsiNumber": "string",
  "globalId": "string",
  "routeId": "string",
  "metaData": [
    {
      "name": "string",
      "value": "string",
      "type": 0,
      "dropdownTypeOptions": [
        "string"
      ]
    }
  ],
  "primary": true,
  "timeZone": "string",
  "isVirtual": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string¦null	false	none	none
description	string¦null	false	none	none
type	LocationType	false	none	Office = 0 Vessel = 1 Truck = 2
licencePlate	string¦null	false	none	none
imoNumber	string¦null	false	none	none
mmsiNumber	string¦null	false	none	none
globalId	string¦null	false	none	none
routeId	string¦null	false	none	none
metaData	[LocationMetadata]¦null	false	none	none
primary	boolean	false	none	none
timeZone	string¦null	false	none	none
isVirtual	boolean	false	none	none

LocationGeneralApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "type": 0,
    "licencePlate": "string",
    "imoNumber": "string",
    "mmsiNumber": "string",
    "globalId": "string",
    "routeId": "string",
    "metaData": [
      {
        "name": "string",
        "value": "string",
        "type": 0,
        "dropdownTypeOptions": [
          "string"
        ]
      }
    ],
    "primary": true,
    "timeZone": "string",
    "isVirtual": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	LocationGeneral	false	none	none

LocationGeneralIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": 0,
      "licencePlate": "string",
      "imoNumber": "string",
      "mmsiNumber": "string",
      "globalId": "string",
      "routeId": "string",
      "metaData": [
        {
          "name": "string",
          "value": "string",
          "type": 0,
          "dropdownTypeOptions": [
            "string"
          ]
        }
      ],
      "primary": true,
      "timeZone": "string",
      "isVirtual": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[LocationGeneral]¦null	false	none	none

LocationMetadata

{
  "name": "string",
  "value": "string",
  "type": 0,
  "dropdownTypeOptions": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
value	string¦null	false	none	none
type	MetaDataType	false	none	Defined = 0 Text = 1 Number = 2 Dropdown = 3 Date = 4 DateAndTime = 5
dropdownTypeOptions	[string]¦null	false	none	none

LocationPosition

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
  "state": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
positionId	string(uuid)	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2

LocationRoute

{
  "routeId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
routeId	string¦null	false	none	none

LocationShortGeneral

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": 0,
  "primary": true,
  "isVirtual": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string¦null	false	none	none
description	string¦null	false	none	none
type	LocationType	false	none	Office = 0 Vessel = 1 Truck = 2
primary	boolean	false	none	none
isVirtual	boolean	false	none	none

LocationShortGeneralIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": 0,
      "primary": true,
      "isVirtual": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[LocationShortGeneral]¦null	false	none	none

LocationType

Office = 0
Vessel = 1
Truck = 2

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	Office = 0 Vessel = 1 Truck = 2

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

MetaDataType

Defined = 0
Text = 1
Number = 2
Dropdown = 3
Date = 4
DateAndTime = 5

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	Defined = 0 Text = 1 Number = 2 Dropdown = 3 Date = 4 DateAndTime = 5

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

Organisation

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
description	string¦null	false	none	none

OrganisationApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	Organisation	false	none	none

OrganisationIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[Organisation]¦null	false	none	none

Person

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "email": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ],
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
      "activelyAssigned": true,
      "assignedSince": "2019-08-24T14:15:22Z",
      "activelyAssignedSince": "2019-08-24T14:15:22Z",
      "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
      "handedOverByName": "string",
      "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
      "switchedByName": "string"
    }
  ],
  "permissions": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "lastActivity": {
    "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
    "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
    "time": "2019-08-24T14:15:22Z",
    "hasActiveSessions": true,
    "timeDiff": "string"
  },
  "profileImageUrl": "string",
  "associatedAccounts": [
    {
      "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
      "subjectId": "string"
    }
  ],
  "passwordUpdateTime": "2019-08-24T14:15:22Z",
  "defaultPassword": "string",
  "resetPassword": {
    "resetLink": "string",
    "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
    "validFor": "2019-08-24T14:15:22Z",
    "lastResetDate": "2019-08-24T14:15:22Z",
    "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
email	string¦null	false	none	none
fullName	string¦null	false	none	none
phoneNumber	string¦null	false	none	none
aliasNames	[AliasName]¦null	false	none	none
organisation	string(uuid)	false	none	none
positionAssignments	[PositionAssignment]¦null	false	none	none
permissions	[string]¦null	false	none	none
lastActivity	PersonLastActivity	false	none	none
profileImageUrl	string¦null	false	none	none
associatedAccounts	[AssociatedAccount]¦null	false	none	none
passwordUpdateTime	string(date-time)	false	none	none
defaultPassword	string¦null	false	none	none
resetPassword	ResetPassword	false	none	none

PersonApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "email": "string",
    "fullName": "string",
    "phoneNumber": "string",
    "aliasNames": [
      {
        "name": "string",
        "fullName": "string"
      }
    ],
    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
    "positionAssignments": [
      {
        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
        "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
        "activelyAssigned": true,
        "assignedSince": "2019-08-24T14:15:22Z",
        "activelyAssignedSince": "2019-08-24T14:15:22Z",
        "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
        "handedOverByName": "string",
        "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
        "switchedByName": "string"
      }
    ],
    "permissions": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "lastActivity": {
      "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
      "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
      "time": "2019-08-24T14:15:22Z",
      "hasActiveSessions": true,
      "timeDiff": "string"
    },
    "profileImageUrl": "string",
    "associatedAccounts": [
      {
        "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
        "subjectId": "string"
      }
    ],
    "passwordUpdateTime": "2019-08-24T14:15:22Z",
    "defaultPassword": "string",
    "resetPassword": {
      "resetLink": "string",
      "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
      "validFor": "2019-08-24T14:15:22Z",
      "lastResetDate": "2019-08-24T14:15:22Z",
      "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	Person	false	none	none

PersonIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "email": "string",
      "fullName": "string",
      "phoneNumber": "string",
      "aliasNames": [
        {
          "name": "string",
          "fullName": "string"
        }
      ],
      "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
      "positionAssignments": [
        {
          "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
          "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
          "activelyAssigned": true,
          "assignedSince": "2019-08-24T14:15:22Z",
          "activelyAssignedSince": "2019-08-24T14:15:22Z",
          "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
          "handedOverByName": "string",
          "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
          "switchedByName": "string"
        }
      ],
      "permissions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "lastActivity": {
        "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
        "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
        "time": "2019-08-24T14:15:22Z",
        "hasActiveSessions": true,
        "timeDiff": "string"
      },
      "profileImageUrl": "string",
      "associatedAccounts": [
        {
          "oAuthProviderId": "e022dc50-bbc1-400a-bece-2ec048d335a3",
          "subjectId": "string"
        }
      ],
      "passwordUpdateTime": "2019-08-24T14:15:22Z",
      "defaultPassword": "string",
      "resetPassword": {
        "resetLink": "string",
        "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
        "validFor": "2019-08-24T14:15:22Z",
        "lastResetDate": "2019-08-24T14:15:22Z",
        "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[Person]¦null	false	none	none

PersonLastActivity

{
  "position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
  "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  "time": "2019-08-24T14:15:22Z",
  "hasActiveSessions": true,
  "timeDiff": "string"
}

Properties

Name	Type	Required	Restrictions	Description
position	string(uuid)	false	none	none
location	string(uuid)	false	none	none
time	string(date-time)¦null	false	none	none
hasActiveSessions	boolean	false	none	none
timeDiff	string¦null	false	read-only	none

PersonPosition

{
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
}

Properties

Name	Type	Required	Restrictions	Description
locationId	string(uuid)	false	none	none
positionId	string(uuid)	false	none	none

Position

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "description": "string",
  "title": "string",
  "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
  "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
  "categories": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "shouldAlwaysBeAssigned": true,
  "allowMultipleActiveAssigns": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
description	string¦null	false	none	none
title	string¦null	false	none	none
permissionGroup	string(uuid)	false	none	none
permissionGroupWhenActivelyAssigned	string(uuid)	false	none	none
categories	[string]¦null	false	none	none
shouldAlwaysBeAssigned	boolean	false	none	none
allowMultipleActiveAssigns	boolean	false	none	none

PositionApiResponse

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	Position	false	none	none

PositionAssignment

{
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
  "activelyAssigned": true,
  "assignedSince": "2019-08-24T14:15:22Z",
  "activelyAssignedSince": "2019-08-24T14:15:22Z",
  "handedOverBy": "879bf519-ed9f-438c-93e9-c426df595b6d",
  "handedOverByName": "string",
  "switchedBy": "b0416909-d866-4b69-87e1-50c567bb29d8",
  "switchedByName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
locationId	string(uuid)	false	none	none
positionId	string(uuid)	false	none	none
activelyAssigned	boolean	false	none	none
assignedSince	string(date-time)	false	none	none
activelyAssignedSince	string(date-time)¦null	false	none	none
handedOverBy	string(uuid)¦null	false	none	none
handedOverByName	string¦null	false	none	none
switchedBy	string(uuid)¦null	false	none	none
switchedByName	string¦null	false	none	none

PositionAssignmentItem

{
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
}

Properties

Name	Type	Required	Restrictions	Description
locationId	string(uuid)	false	none	none
positionId	string(uuid)	false	none	none

PositionCreateManyItemsError

{
  "item": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "time": "2019-08-24T14:15:22Z",
    "timeString": "string",
    "name": "string",
    "state": 0,
    "description": "string",
    "title": "string",
    "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
    "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
    "categories": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shouldAlwaysBeAssigned": true,
    "allowMultipleActiveAssigns": true
  },
  "errorType": "string",
  "errorMessage": "string"
}

Properties

Name	Type	Required	Restrictions	Description
item	Position	false	none	none
errorType	string¦null	false	none	none
errorMessage	string¦null	false	none	none

PositionCreateManyItemsResponse

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "title": "string",
      "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
      "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
      "categories": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "shouldAlwaysBeAssigned": true,
      "allowMultipleActiveAssigns": true
    }
  ],
  "errors": [
    {
      "item": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "title": "string",
        "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
        "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
        "categories": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "shouldAlwaysBeAssigned": true,
        "allowMultipleActiveAssigns": true
      },
      "errorType": "string",
      "errorMessage": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[Position]¦null	false	read-only	none
errors	[PositionCreateManyItemsError]¦null	false	read-only	none

PositionCreateManyItemsResponseApiResponse

{
  "data": {
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "time": "2019-08-24T14:15:22Z",
        "timeString": "string",
        "name": "string",
        "state": 0,
        "description": "string",
        "title": "string",
        "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
        "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
        "categories": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "shouldAlwaysBeAssigned": true,
        "allowMultipleActiveAssigns": true
      }
    ],
    "errors": [
      {
        "item": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "time": "2019-08-24T14:15:22Z",
          "timeString": "string",
          "name": "string",
          "state": 0,
          "description": "string",
          "title": "string",
          "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
          "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
          "categories": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "shouldAlwaysBeAssigned": true,
          "allowMultipleActiveAssigns": true
        },
        "errorType": "string",
        "errorMessage": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	PositionCreateManyItemsResponse	false	none	none

PositionGeneral

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string¦null	false	none	none

PositionGeneralIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[PositionGeneral]¦null	false	none	none

PositionIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "title": "string",
      "permissionGroup": "a0ff8c0c-35e9-4086-abef-03d1c511f4e0",
      "permissionGroupWhenActivelyAssigned": "267d3047-eccd-4f37-b137-e7009e668846",
      "categories": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "shouldAlwaysBeAssigned": true,
      "allowMultipleActiveAssigns": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[Position]¦null	false	none	none

PositionTeam

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time": "2019-08-24T14:15:22Z",
  "timeString": "string",
  "name": "string",
  "state": 0,
  "description": "string",
  "positions": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
time	string(date-time)	false	none	none
timeString	string¦null	false	read-only	none
name	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
description	string¦null	false	none	none
positions	[string]¦null	false	none	none

PositionTeamIEnumerableApiResponse

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "time": "2019-08-24T14:15:22Z",
      "timeString": "string",
      "name": "string",
      "state": 0,
      "description": "string",
      "positions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[PositionTeam]¦null	false	none	none

RemovedLocationMetaData

{
  "metaDataNames": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
metaDataNames	[string]¦null	false	none	none

ResetPassword

{
  "resetLink": "string",
  "initiatedBy": "7c3ed0e2-d24e-40a1-b1fe-f6a01ac857c6",
  "validFor": "2019-08-24T14:15:22Z",
  "lastResetDate": "2019-08-24T14:15:22Z",
  "lastResetInitiatedBy": "7452ebfc-dad1-4b4b-a729-e8e2fa335444"
}

Properties

Name	Type	Required	Restrictions	Description
resetLink	string¦null	false	none	none
initiatedBy	string(uuid)¦null	false	none	none
validFor	string(date-time)¦null	false	none	none
lastResetDate	string(date-time)¦null	false	none	none
lastResetInitiatedBy	string(uuid)¦null	false	none	none

State

Active = 0
Deactivated = 1
Removed = 2

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	Active = 0 Deactivated = 1 Removed = 2

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

StringApiResponse

{
  "data": "string"
}

Properties

Name	Type	Required	Restrictions	Description
data	string¦null	false	none	none

StringStringDictionaryApiResponse

{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	object¦null	false	none	none
» additionalProperties	string¦null	false	none	none

UpdateLocationMetaData

{
  "metaData": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
metaData	[UpdateMetadata]¦null	false	none	none

UpdateMetadata

{
  "name": "string",
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
value	string¦null	false	none	none

UpdatePerson

{
  "name": "string",
  "fullName": "string",
  "phoneNumber": "string",
  "defaultPassword": "string",
  "state": 0,
  "email": "[email protected]",
  "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  "positionAssignments": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35"
    }
  ],
  "aliasNames": [
    {
      "name": "string",
      "fullName": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
fullName	string¦null	false	none	none
phoneNumber	string¦null	false	none	none
defaultPassword	string¦null	false	none	none
state	State	false	none	Active = 0 Deactivated = 1 Removed = 2
email	string(email)¦null	false	none	none
organisation	string(uuid)	false	none	none
positionAssignments	[PositionAssignmentItem]¦null	false	none	none
aliasNames	[AliasName]¦null	false	none	none