Create a designation

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/designations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "designation": {
      "name": "Site Supervisor"
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.designations.createSettingsDesignation({designation: {name: 'Site Supervisor'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->designations->createSettingsDesignation([
    'designation' => ['name' => 'Site Supervisor'],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.designations().createSettingsDesignation(
        Map.of("designation", Map.of("name", "Site Supervisor")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Designations.CreateSettingsDesignationAsync(new Dictionary<string, object?>
{
    ["designation"] = new Dictionary<string, object?>
    {
        ["name"] = "Site Supervisor",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.designations.createSettingsDesignation({
  'designation': {'name': 'Site Supervisor'},
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Designations().CreateSettingsDesignation(context.Background(), map[string]any{
	"designation": map[string]any{"name": "Site Supervisor"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "designation": {
    "created_by": null,
    "created_on": "<string>",
    "description": null,
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": null,
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

POST

settings

designations

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/designations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "designation": {
      "name": "Site Supervisor"
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.designations.createSettingsDesignation({designation: {name: 'Site Supervisor'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->designations->createSettingsDesignation([
    'designation' => ['name' => 'Site Supervisor'],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.designations().createSettingsDesignation(
        Map.of("designation", Map.of("name", "Site Supervisor")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Designations.CreateSettingsDesignationAsync(new Dictionary<string, object?>
{
    ["designation"] = new Dictionary<string, object?>
    {
        ["name"] = "Site Supervisor",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.designations.createSettingsDesignation({
  'designation': {'name': 'Site Supervisor'},
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Designations().CreateSettingsDesignation(context.Background(), map[string]any{
	"designation": map[string]any{"name": "Site Supervisor"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "designation": {
    "created_by": null,
    "created_on": "<string>",
    "description": null,
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": null,
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

Send the new designation under designation. name is required. The new designation comes back under designation, with its des_ id.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Body

application/json

designation

object

required

Show child attributes

Response

201 - application/json

The new designation, under designation.

designation

object

Show child attributes

Guides

API reference

Authorizations

Body

Response