Post Country

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/List/Country/Items");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"CountryId\": 123,\n  \"Name\": \"<string>\",\n  \"CurrencyId\": 123,\n  \"EnglishName\": \"<string>\",\n  \"TwoLetterISOCountry\": \"<string>\",\n  \"ThreeLetterISOCountry\": \"<string>\",\n  \"ImageDescription\": \"<string>\",\n  \"OrgNrText\": \"<string>\",\n  \"InterAreaPrefix\": \"<string>\",\n  \"DialInPrefix\": \"<string>\",\n  \"ZipPrefix\": \"<string>\",\n  \"DomainName\": \"<string>\",\n  \"AddressLayoutId\": 123,\n  \"DomesticAddressLayoutId\": 123,\n  \"ForeignAddressLayoutId\": 123,\n  \"Rank\": 123,\n  \"Tooltip\": \"<string>\",\n  \"Deleted\": true,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CountryId: 123,
    Name: '<string>',
    CurrencyId: 123,
    EnglishName: '<string>',
    TwoLetterISOCountry: '<string>',
    ThreeLetterISOCountry: '<string>',
    ImageDescription: '<string>',
    OrgNrText: '<string>',
    InterAreaPrefix: '<string>',
    DialInPrefix: '<string>',
    ZipPrefix: '<string>',
    DomainName: '<string>',
    AddressLayoutId: 123,
    DomesticAddressLayoutId: 123,
    ForeignAddressLayoutId: 123,
    Rank: 123,
    Tooltip: '<string>',
    Deleted: true,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/List/Country/Items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/List/Country/Items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'CountryId' => 123,
    'Name' => '<string>',
    'CurrencyId' => 123,
    'EnglishName' => '<string>',
    'TwoLetterISOCountry' => '<string>',
    'ThreeLetterISOCountry' => '<string>',
    'ImageDescription' => '<string>',
    'OrgNrText' => '<string>',
    'InterAreaPrefix' => '<string>',
    'DialInPrefix' => '<string>',
    'ZipPrefix' => '<string>',
    'DomainName' => '<string>',
    'AddressLayoutId' => 123,
    'DomesticAddressLayoutId' => 123,
    'ForeignAddressLayoutId' => 123,
    'Rank' => 123,
    'Tooltip' => '<string>',
    'Deleted' => true,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/List/Country/Items"

payload = {
    "CountryId": 123,
    "Name": "<string>",
    "CurrencyId": 123,
    "EnglishName": "<string>",
    "TwoLetterISOCountry": "<string>",
    "ThreeLetterISOCountry": "<string>",
    "ImageDescription": "<string>",
    "OrgNrText": "<string>",
    "InterAreaPrefix": "<string>",
    "DialInPrefix": "<string>",
    "ZipPrefix": "<string>",
    "DomainName": "<string>",
    "AddressLayoutId": 123,
    "DomesticAddressLayoutId": 123,
    "ForeignAddressLayoutId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Deleted": True,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CountryId: 123,
    Name: '<string>',
    CurrencyId: 123,
    EnglishName: '<string>',
    TwoLetterISOCountry: '<string>',
    ThreeLetterISOCountry: '<string>',
    ImageDescription: '<string>',
    OrgNrText: '<string>',
    InterAreaPrefix: '<string>',
    DialInPrefix: '<string>',
    ZipPrefix: '<string>',
    DomainName: '<string>',
    AddressLayoutId: 123,
    DomesticAddressLayoutId: 123,
    ForeignAddressLayoutId: 123,
    Rank: 123,
    Tooltip: '<string>',
    Deleted: true,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/List/Country/Items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CountryId": 123,
  "Name": "<string>",
  "CurrencyId": 123,
  "EnglishName": "<string>",
  "TwoLetterISOCountry": "<string>",
  "ThreeLetterISOCountry": "<string>",
  "ImageDescription": "<string>",
  "OrgNrText": "<string>",
  "InterAreaPrefix": "<string>",
  "DialInPrefix": "<string>",
  "ZipPrefix": "<string>",
  "DomainName": "<string>",
  "AddressLayoutId": 123,
  "DomesticAddressLayoutId": 123,
  "ForeignAddressLayoutId": 123,
  "Rank": 123,
  "Tooltip": "<string>",
  "Deleted": true,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Post Country

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/List/Country/Items");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"CountryId\": 123,\n  \"Name\": \"<string>\",\n  \"CurrencyId\": 123,\n  \"EnglishName\": \"<string>\",\n  \"TwoLetterISOCountry\": \"<string>\",\n  \"ThreeLetterISOCountry\": \"<string>\",\n  \"ImageDescription\": \"<string>\",\n  \"OrgNrText\": \"<string>\",\n  \"InterAreaPrefix\": \"<string>\",\n  \"DialInPrefix\": \"<string>\",\n  \"ZipPrefix\": \"<string>\",\n  \"DomainName\": \"<string>\",\n  \"AddressLayoutId\": 123,\n  \"DomesticAddressLayoutId\": 123,\n  \"ForeignAddressLayoutId\": 123,\n  \"Rank\": 123,\n  \"Tooltip\": \"<string>\",\n  \"Deleted\": true,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CountryId: 123,
    Name: '<string>',
    CurrencyId: 123,
    EnglishName: '<string>',
    TwoLetterISOCountry: '<string>',
    ThreeLetterISOCountry: '<string>',
    ImageDescription: '<string>',
    OrgNrText: '<string>',
    InterAreaPrefix: '<string>',
    DialInPrefix: '<string>',
    ZipPrefix: '<string>',
    DomainName: '<string>',
    AddressLayoutId: 123,
    DomesticAddressLayoutId: 123,
    ForeignAddressLayoutId: 123,
    Rank: 123,
    Tooltip: '<string>',
    Deleted: true,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/List/Country/Items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/List/Country/Items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'CountryId' => 123,
    'Name' => '<string>',
    'CurrencyId' => 123,
    'EnglishName' => '<string>',
    'TwoLetterISOCountry' => '<string>',
    'ThreeLetterISOCountry' => '<string>',
    'ImageDescription' => '<string>',
    'OrgNrText' => '<string>',
    'InterAreaPrefix' => '<string>',
    'DialInPrefix' => '<string>',
    'ZipPrefix' => '<string>',
    'DomainName' => '<string>',
    'AddressLayoutId' => 123,
    'DomesticAddressLayoutId' => 123,
    'ForeignAddressLayoutId' => 123,
    'Rank' => 123,
    'Tooltip' => '<string>',
    'Deleted' => true,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/List/Country/Items"

payload = {
    "CountryId": 123,
    "Name": "<string>",
    "CurrencyId": 123,
    "EnglishName": "<string>",
    "TwoLetterISOCountry": "<string>",
    "ThreeLetterISOCountry": "<string>",
    "ImageDescription": "<string>",
    "OrgNrText": "<string>",
    "InterAreaPrefix": "<string>",
    "DialInPrefix": "<string>",
    "ZipPrefix": "<string>",
    "DomainName": "<string>",
    "AddressLayoutId": 123,
    "DomesticAddressLayoutId": 123,
    "ForeignAddressLayoutId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Deleted": True,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CountryId: 123,
    Name: '<string>',
    CurrencyId: 123,
    EnglishName: '<string>',
    TwoLetterISOCountry: '<string>',
    ThreeLetterISOCountry: '<string>',
    ImageDescription: '<string>',
    OrgNrText: '<string>',
    InterAreaPrefix: '<string>',
    DialInPrefix: '<string>',
    ZipPrefix: '<string>',
    DomainName: '<string>',
    AddressLayoutId: 123,
    DomesticAddressLayoutId: 123,
    ForeignAddressLayoutId: 123,
    Rank: 123,
    Tooltip: '<string>',
    Deleted: true,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/List/Country/Items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CountryId": 123,
  "Name": "<string>",
  "CurrencyId": 123,
  "EnglishName": "<string>",
  "TwoLetterISOCountry": "<string>",
  "ThreeLetterISOCountry": "<string>",
  "ImageDescription": "<string>",
  "OrgNrText": "<string>",
  "InterAreaPrefix": "<string>",
  "DialInPrefix": "<string>",
  "ZipPrefix": "<string>",
  "DomainName": "<string>",
  "AddressLayoutId": 123,
  "DomesticAddressLayoutId": 123,
  "ForeignAddressLayoutId": 123,
  "Rank": 123,
  "Tooltip": "<string>",
  "Deleted": true,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Body

The Country to be created.

Carrier object for Country. Services for the Country Carrier is available from the List Agent.

CountryId

integer<int32>

Primary key

Name

string

Name of country in installed language

CurrencyId

integer<int32>

Default currency for this country

EnglishName

string

Name of country in english

TwoLetterISOCountry

string

Two-letter country-code according to ISO3166

ThreeLetterISOCountry

string

Three-letter country-code according to ISO3166

ImageDescription

string

Description of the country's flag image. (This is the country flag that is displayed in the CRM client)

OrgNrText

string

Lead text for organisation field

InterAreaPrefix

string

International prefix

DialInPrefix

string

Dial in prefix

ZipPrefix

string

Post prefix

DomainName

string

Domain name of the country

AddressLayoutId

integer<int32>

Address layout of the country

DomesticAddressLayoutId

integer<int32>

Domestic address layout of the country

ForeignAddressLayoutId

integer<int32>

Foreign address layout of the country

Rank

integer<int32>

The rank of the country

The tooltip of the country

Deleted

boolean

true if the country is deleted

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

Carrier object for Country. Services for the Country Carrier is available from the List Agent.

CountryId

integer<int32>

Primary key

Name

string

Name of country in installed language

CurrencyId

integer<int32>

Default currency for this country

EnglishName

string

Name of country in english

TwoLetterISOCountry

string

Two-letter country-code according to ISO3166

ThreeLetterISOCountry

string

Three-letter country-code according to ISO3166

ImageDescription

string

Description of the country's flag image. (This is the country flag that is displayed in the CRM client)

OrgNrText

string

Lead text for organisation field

InterAreaPrefix

string

International prefix

DialInPrefix

string

Dial in prefix

ZipPrefix

string

Post prefix

DomainName

string

Domain name of the country

AddressLayoutId

integer<int32>

Address layout of the country

DomesticAddressLayoutId

integer<int32>

Domestic address layout of the country

ForeignAddressLayoutId

integer<int32>

Foreign address layout of the country

Rank

integer<int32>

The rank of the country

The tooltip of the country

Deleted

boolean

true if the country is deleted

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes