PUT api/Tenants/{id}/settings

Request change of Tenant setting for tenant provided in the id param. If a provider is null it will not be updated or deleted.To turn off a provider set the usages to null or any other value.Optionallly the TenantId to null.Authorisation(s) : Cliënt application (FiscaalGemak)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Tenant identification numbe

string

Required

Body Parameters

Connection And Usage setting of Tenant

TenantSettings
NameDescriptionTypeAdditional information
Ctrl

ExternalProviderSettings

None.

MijnKantorenApp

ExternalProviderSettings

None.

U4DocumentManager

ExternalProviderSettings

None.

U4Osw

UsernameProviderSettings

None.

Pinkweb

PinkwebProviderSettings

None.

CreAim

ExternalProviderSettings

None.

Reeleezee

ExternalProviderSettings

None.

Digipoort

UsernameProviderSettings

None.

AccountancySuite

UsernameProviderSettings

None.

MijnAccountantsPortal

MapProviderSettings

None.

SbrGateway

ExternalProviderSettings

None.

FiscaalGemak

ExternalProviderSettings

None.

METesttool

ExternalProviderSettings

None.

OSWLT

ExternalProviderSettings

None.

OSWTEST

ExternalProviderSettings

None.

Ffort

UsernameProviderSettings

None.

Brixxs

ExternalProviderSettings

None.

SecureLogin

ExternalProviderSettings

None.

Exact

ExternalProviderSettings

None.

Description

Human readable text ie tenant name

string

Max length: 255

Request Formats

application/json, text/json

Sample:
{
  "Ctrl": null,
  "MijnKantorenApp": null,
  "U4DocumentManager": {
    "Usages": [
      "Archiving"
    ],
    "TenantId": "MyId.Documentmanager.nl"
  },
  "U4Osw": {
    "Username": null,
    "Password": null,
    "Usages": [
      "Approval"
    ],
    "TenantId": "00000000-0000-0000-0000-000000000001"
  },
  "Pinkweb": null,
  "CreAim": null,
  "Reeleezee": null,
  "Digipoort": {
    "Username": null,
    "Password": null,
    "Usages": [
      "Sending"
    ],
    "TenantId": "42"
  },
  "AccountancySuite": null,
  "MijnAccountantsPortal": null,
  "SbrGateway": null,
  "FiscaalGemak": null,
  "METesttool": null,
  "OSWLT": null,
  "OSWTEST": null,
  "Ffort": null,
  "Brixxs": null,
  "SecureLogin": null,
  "Exact": null,
  "Description": "Unit4"
}

application/xml, text/xml

Sample:
<TenantSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MessageExpresse.Models">
  <AccountancySuite i:nil="true" />
  <Brixxs i:nil="true" />
  <CreAim i:nil="true" />
  <Ctrl i:nil="true" />
  <Description>Unit4</Description>
  <Digipoort>
    <TenantId>42</TenantId>
    <Usages>
      <ProviderUsages>Sending</ProviderUsages>
    </Usages>
    <Password i:nil="true" />
    <Username i:nil="true" />
  </Digipoort>
  <Exact i:nil="true" />
  <Ffort i:nil="true" />
  <FiscaalGemak i:nil="true" />
  <METesttool i:nil="true" />
  <MijnAccountantsPortal i:nil="true" />
  <MijnKantorenApp i:nil="true" />
  <OSWLT i:nil="true" />
  <OSWTEST i:nil="true" />
  <Pinkweb i:nil="true" />
  <Reeleezee i:nil="true" />
  <SbrGateway i:nil="true" />
  <SecureLogin i:nil="true" />
  <U4DocumentManager>
    <TenantId>MyId.Documentmanager.nl</TenantId>
    <Usages>
      <ProviderUsages>Archiving</ProviderUsages>
    </Usages>
  </U4DocumentManager>
  <U4Osw>
    <TenantId>00000000-0000-0000-0000-000000000001</TenantId>
    <Usages>
      <ProviderUsages>Approval</ProviderUsages>
    </Usages>
    <Password i:nil="true" />
    <Username i:nil="true" />
  </U4Osw>
</TenantSettings>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TenantSettings
NameDescriptionTypeAdditional information
Ctrl

ExternalProviderSettings

None.

MijnKantorenApp

ExternalProviderSettings

None.

U4DocumentManager

ExternalProviderSettings

None.

U4Osw

UsernameProviderSettings

None.

Pinkweb

PinkwebProviderSettings

None.

CreAim

ExternalProviderSettings

None.

Reeleezee

ExternalProviderSettings

None.

Digipoort

UsernameProviderSettings

None.

AccountancySuite

UsernameProviderSettings

None.

MijnAccountantsPortal

MapProviderSettings

None.

SbrGateway

ExternalProviderSettings

None.

FiscaalGemak

ExternalProviderSettings

None.

METesttool

ExternalProviderSettings

None.

OSWLT

ExternalProviderSettings

None.

OSWTEST

ExternalProviderSettings

None.

Ffort

UsernameProviderSettings

None.

Brixxs

ExternalProviderSettings

None.

SecureLogin

ExternalProviderSettings

None.

Exact

ExternalProviderSettings

None.

Description

Human readable text ie tenant name

string

Max length: 255

Response Formats

application/json, text/json

Sample:
{
  "Ctrl": null,
  "MijnKantorenApp": null,
  "U4DocumentManager": {
    "Usages": [
      "Archiving"
    ],
    "TenantId": "MyId.Documentmanager.nl"
  },
  "U4Osw": {
    "Username": null,
    "Password": null,
    "Usages": [
      "Approval"
    ],
    "TenantId": "00000000-0000-0000-0000-000000000001"
  },
  "Pinkweb": null,
  "CreAim": null,
  "Reeleezee": null,
  "Digipoort": {
    "Username": null,
    "Password": null,
    "Usages": [
      "Sending"
    ],
    "TenantId": "42"
  },
  "AccountancySuite": null,
  "MijnAccountantsPortal": null,
  "SbrGateway": null,
  "FiscaalGemak": null,
  "METesttool": null,
  "OSWLT": null,
  "OSWTEST": null,
  "Ffort": null,
  "Brixxs": null,
  "SecureLogin": null,
  "Exact": null,
  "Description": "Unit4"
}

application/xml, text/xml

Sample:
<TenantSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MessageExpresse.Models">
  <AccountancySuite i:nil="true" />
  <Brixxs i:nil="true" />
  <CreAim i:nil="true" />
  <Ctrl i:nil="true" />
  <Description>Unit4</Description>
  <Digipoort>
    <TenantId>42</TenantId>
    <Usages>
      <ProviderUsages>Sending</ProviderUsages>
    </Usages>
    <Password i:nil="true" />
    <Username i:nil="true" />
  </Digipoort>
  <Exact i:nil="true" />
  <Ffort i:nil="true" />
  <FiscaalGemak i:nil="true" />
  <METesttool i:nil="true" />
  <MijnAccountantsPortal i:nil="true" />
  <MijnKantorenApp i:nil="true" />
  <OSWLT i:nil="true" />
  <OSWTEST i:nil="true" />
  <Pinkweb i:nil="true" />
  <Reeleezee i:nil="true" />
  <SbrGateway i:nil="true" />
  <SecureLogin i:nil="true" />
  <U4DocumentManager>
    <TenantId>MyId.Documentmanager.nl</TenantId>
    <Usages>
      <ProviderUsages>Archiving</ProviderUsages>
    </Usages>
  </U4DocumentManager>
  <U4Osw>
    <TenantId>00000000-0000-0000-0000-000000000001</TenantId>
    <Usages>
      <ProviderUsages>Approval</ProviderUsages>
    </Usages>
    <Password i:nil="true" />
    <Username i:nil="true" />
  </U4Osw>
</TenantSettings>