API docs by Redocly

LdnApi (v2.00.0025.00)

Download OpenAPI specification:

Abonnement

Gets a specific subscription from a contact Subscriptions can be modules, permissions, applications

More info on subcriptions: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Subscriptions(Moduleaccessandpermissions) Supports the default ldn url parameters for fetching data

Possible expand values:

  • vned or edities
  • vnvcd or overige
  • vnad or contacten
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing subscription

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new subscription

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing subscription

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

AbonnementDefinition

Gets subscription-definitions

Supports the default ldn url parameters for fetching data

Possible expand values:

  • vned or edities
  • vnvcdvned or editiesOverige
  • vnvcd or Overige
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

AppSettings

Retrieve allowed environments

Query-parameters

  • contactiduser: userid
  • contactidcustomer: environment ownerid
  • allenvironments: fetch all environments for host
  • edition: edition linked to environment
  • group: id of the environmnet
  • includeinvalid: invalid: today is outside from - to date
  • includeinactive
  • validon: date in one of these formats "dd/MM/yyyy", "yyyy/MM/dd", "dd-MM-yyyy", "yyyy-MM-dd", "yyyyMMdd"
  • subscriptionid
  • includerecordsecurity

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163923/api+appsettings

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

CompanyScope

Fetches company-scope defined in a subscription

Query-parameters:

  • subscriptionId
  • activeenvironment
  • userid

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163951/api+companyscope

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Get Company-scope related contacts

Query-parameters:

  • contactid
  • companyscopemodule
  • activeenvironmentedition
  • includeCompanyScopeAll
  • namematch
  • havingpermission
  • havingpermissionedition

Supports the default ldn url parameters for fetching data

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Config

Fetches the version info

Responses

Response samples

Content type
{
  • "AppServerName": "string",
  • "NameServerHost": "string",
  • "NameServerPort": "string",
  • "FrontendVersion": {
    },
  • "BackendVersion": {
    }
}

Contact

Gets contacts

More info on contacts: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Companiesandusers Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnau or functies
  • vnvcd or overige
  • vnkl or commentaren
  • vnas or lidmaatschap
  • vnah or lidgelden
  • vnab or abonnementen
  • vnvcdvnab or abonnementenoverige
  • vnrl or relaties
  • disflmn or afbeeldingen
  • vngr or omgevingen
  • vnvcdvngr or omgevingenoverige
  • vngrproject or projecten
  • vnvdvngrproject or projectenoverige
  • vnauvngrproject or projectenfuncties

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163641/api+Contact

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update a contact

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a contact

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete a contact

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

ContactActie

Stops the membership of a contact

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Unlink a family member

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Stops a subscription

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Stops a mandate

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Update addresses by parent

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
parentId
integer <int32>
sameAddress
boolean
oldAddress
string
oldHouseNumber
string
oldBoxNumber
string
oldPostalCode
string
oldCity
string
oldCountry
string

Responses

Request samples

Content type
{
  • "parentId": 0,
  • "sameAddress": true,
  • "oldAddress": "string",
  • "oldHouseNumber": "string",
  • "oldBoxNumber": "string",
  • "oldPostalCode": "string",
  • "oldCity": "string",
  • "oldCountry": "string"
}

Response samples

Content type
{
  • "ids": "string",
  • "nrIdsRefused": 0,
  • "error": "string"
}

DataUri

Gets a datauri via the URL

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10162555/api+datauri

query Parameters
url
required
string

Encoded url

newWidth
integer <int32>

width in pixels

newHeight
integer <int32>

height in pixels

keepAspectRatio
boolean

Responses

Response samples

Content type
{ }

Gets a datauri via the disid

query Parameters
disId
required
string
newWidth
integer <int32>
newHeight
integer <int32>
keepAspectRatio
boolean

Responses

Response samples

Content type
{ }

Downloads an image via the disid

query Parameters
disId
required
string
newWidth
integer <int32>
newHeight
integer <int32>
keepAspectRatio
boolean

Responses

Response samples

Content type
{ }

Dis

Gets a DIS item

Supports the default ldn url parameters for fetching data

Possible expand values:

  • disflref or references
  • disfldt or dates

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163845/api+Dis

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing DIS item

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record Query-parameter addPermalink to create a permanent link

Authorizations:
pswAuthpswAuthQuery
query Parameters
addPermalink
boolean
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new DIS item

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Query-parameter addPermalink to create a permanent link

Authorizations:
pswAuthpswAuthQuery
query Parameters
addPermalink
boolean
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing DIS item

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
addPermalink
boolean
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

DisAction

Gets an image from DIS as download

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
query Parameters
newWidth
integer <int32>
newHeight
integer <int32>
keepAspectRatio
boolean

Responses

Response samples

Content type
{ }

Gets an image from dis inline

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
query Parameters
newWidth
integer <int32>
newHeight
integer <int32>
keepAspectRatio
boolean

Responses

Response samples

Content type
{ }

Field

Checks a field value in a specific field

Query-parameters

  • tablename
  • fieldname
  • fieldvalue
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

Responses

Response samples

Content type
{ }

FileCache

Get a cacheitem object from a temporarily cached file

Cached item is delete after 60 seconds of inactivity

Authorizations:
pswAuthpswAuthQuery
query Parameters
id
string

Responses

Response samples

Content type
{ }

Get a temporarily cached file by its id

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
query Parameters
asAttachment
boolean

Responses

Response samples

Content type
{ }

Explicitly remove a cached item

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

Responses

Response samples

Content type
{ }

Temporarily cache a file

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
filename
string
mimetype
string
base64
string
guid
string

Responses

Request samples

Content type
{
  • "filename": "string",
  • "mimetype": "string",
  • "base64": "string",
  • "guid": "string"
}

Response samples

Content type
{ }

Functie

Gets a function for a specific user

More info on subcriptions: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Subscriptions(Moduleaccessandpermissions) Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnvcd or overige
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing function

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a function

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing function

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

FunctieDefinitie

Gets a function-definition

Supports the default ldn url parameters for fetching data

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Generic

Generic controller to fetch data from any table (only main level no expand) can only be used by users with a specific permission set

Specify db and table via query-parameters dbname and tablename

Supports the default ldn url parameters for fetching data

Authorizations:
pswAuthpswAuthQuery
query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

Responses

Response samples

Content type
{ }

Update any existing record can only be used by users with a specific permission set

Specify db and table via query-parameters or header dbname and tablename

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create any new record can only be used by users with a specific permission set

Specify db and table via query-parameters or header dbname and tablename

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete any existing record can only be used by users with a specific permission set

Specify db and table via query-parameters or header dbname and tablename

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

GenericBe

Generic controller to fetch data from any table and expandable data can only be used by users with a specific permission set

Specify db and table via query-parameters dbname and tablename

Supports the default ldn url parameters for fetching data

Possible expand values: depends on table

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update any record: never allowed

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create any record: never allowed

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete any record: never allowed

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Groepen

Gets groups Groups can represent project-groups or environments

More info on groups: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Groups(Environments) Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnas or leden
  • vnau or functies
  • vnvcd or overige
  • vngrsub or subgroep
  • vngrhoofd or hoofdgroep
  • vnkl or opmerkingen

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10162543/api+groepen

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing group

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new group

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing group

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Hlp

Gets Hlp

Supports the default ldn url parameters for fetching data

filter parameter can be used to search or use separate query-parameter:

  • formcode
  • rubriek
  • taal
  • code
  • fieldcode

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10162455/api+hlp

path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
formcode
string
rubriek
string
taal
string
code
string
fieldcode
integer
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update a hlp

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a hlp

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete a hlp

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Jira

Fetch a Jira-customer

Query-parameters

  • jiraklant
  • ldnklant
  • hoofdgroep
  • ldnklantid
  • onlyvalidprojects
  • onlyvalidcustomers
  • onlywithprojects

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/51544078/api+jira

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

Responses

Response samples

Content type
{ }

Fetches a Jira-reporter

Query-parameters:

  • jiraklant
  • ldnklantid
  • companyscopemodule
  • activeenvironmentedition
  • includeCompanyScopeAll
  • namematch

Supports the default ldn url parameters for fetching data

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string
query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

LDNEvent

Gets Ldn-events

More info on subcriptions: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Subscriptions(Moduleaccessandpermissions) Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnvcd or overige
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
event_id
string
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing ldn-event

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new ldn-event

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing ldn-event

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Log

Via deze calls kan de logfunctie van LDN web getest worden

path Parameters
id
required
integer <int32>
  • 1: info
  • 2: error
  • 3: warning

Responses

Response samples

Content type
{ }

Login

Validates a pswAuth token

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10162383/api+login

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Opmerking

Gets remark

Supports the default ldn url parameters for fetching data

path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update a remark

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a remark

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete a remark

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

OrNgToken

Fetches an OrNG token for authenticating in operational api

Query-parameters

  • applicationid
  • activeenvironment
  • actrivemodule
Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

OverigVeld

Gets an extra property extra properties can be linked to contact, subscriptions, groups, ...

More info on extra properties: https://organi.atlassian.net/wiki/spaces/BS/pages/3918476/Ldn+backend+data-structure+for+OrNg#Ldnbackenddata-structureforOrNg-Extraproperties Supports the default ldn url parameters for fetching data

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
module
string
kode
string
nummer
string
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing extra property

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new extra property

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing extra property

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

OverigVeldDefinition

Gets extra property definitions

Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnzpv or zoekvelden
  • vnzp or zoekprogrammas
  • hlp or helpteksten
Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
module
string
kode
string
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

OverigVeldInherited

Gets inherited extra proprties

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163829/api+OverigVeldInherited

Authorizations:
pswAuthpswAuthQuery
query Parameters
company
integer <int32>
userid
integer <int32>

the id of the contact

abon
string

the id of the subscription

editie
string

the edition of the subscription

vnvcdModule
string

the extra property module

vnvcdKode
integer <int32>

the extra property code

lookInUser
boolean

Look for properties in contact

lookInParent
boolean

Look for properties inherited from contacts parent

lookInEnvironment
boolean

Look for properties inherited from the subscriptions environment

Responses

Response samples

Content type
{ }

OverigVeldSearch

Search for extra property values for a specific subscription with userrole and userroleaccount

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/671612929/api+OverigVeld+search

Authorizations:
pswAuthpswAuthQuery
query Parameters
company
integer <int32>
abon
string
editie
string
vnvcdmodule
string
vnvcdkode
integer <int32>
userRole
string
userRoleAccount
string

Responses

Response samples

Content type
{ }

Parameter

Get a recent or default parameter

Authorizations:
pswAuthpswAuthQuery
query Parameters
program
string
editie
string
paramsoort
string
subFunctie
string
userName
string
firstVisit
boolean

Responses

Response samples

Content type
{ }

Get a parameter

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163883/api+parameter

Authorizations:
pswAuthpswAuthQuery
query Parameters
programma
string
functie
string
subfunctie
string
paramsoort
string
volgnr
integer <int32>
currentUser
boolean

Responses

Response samples

Content type
{ }

Update a parameter

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a parameter

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete a parameter

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

RecordSecurity

Check record-security of a contact-record

Query-parameters:

  • action: C, R, U, D
  • subaction
  • company
  • contactid
  • contacttype: O or P
  • parentid
  • onlycompanyscope

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/563380225/api+RecordSecurity

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Check record-security of a subscription-record

Query-parameters:

  • action: C, R, U, D
  • subaction
  • company
  • contactid
  • subscriptionid
  • edition
  • from
Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Check record-security of a group-record

Query-parameters:

  • action: C, R, U, D
  • subaction
  • company
  • group
  • ownerid
  • grouptype
Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Check record-security of an extra property record

Query-parameters:

  • action: C, R, U, D
  • company
  • key
  • module
  • code
Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

RemoteApi

Gets content from Jira

See https://organi.atlassian.net/wiki/spaces/LDN/pages/10163797/api+remoteApi

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Execute a transition on an issue

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Get grouped issue-data

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Get attachments linked to an issue

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Add an attachment to an issue

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Create a new issue

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Edit an issue

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Get the clientId of an issue

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

lookup the optionId (client) and id of a jira project group by the groupId in the context of the customer/project field

query Parameters
groupId
required
string

The groupId whose ids should be looked up

forceRefresh
boolean

force lookup ids even when ids already exist in extra field

jiraDestination
required
string
Default: "cloud"

cloud

apiVersion
integer
Default: 2

2 or 3

Responses

Response samples

Content type
{ }

Trigger synchronisation of jira customer-projects from LDN for a specific jira project

Limitations:

  • a maximum of 1 request within 3 minutes
  • a maximum of 18 requests within 6 hours

https://documentation.codefortynine.com/external-data-for-jira-fields/field-trigger-field-option-sync

query Parameters
groupId
required
string

The groupId we want to sync

jiraDestination
required
string
Default: "cloud"

cloud

apiVersion
integer
Default: 2

2 or 3

Responses

Response samples

Content type
{ }

creates for customer project

Authorizations:
pswAuthpswAuthQuery
query Parameters
groupId
required
string

The groupId for which the issues should be created

simulate
boolean

if true only simulate config, don't actually create issues

onlyExtraFieldCode
integer

Only create issues for this extrafieldcode

jiraDestination
required
string
Default: "cloud"

cloud

apiVersion
integer
Default: 2

2 or 3

Responses

Response samples

Content type
{ }

Get the jira status mappings

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Get a version-config from a remote installation

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

SelfRegistration

Gets parent by email in self-registration

query Parameters
email
string

Responses

Response samples

Content type
{ }

Gets user by email

query Parameters
email
string
checktype
boolean

Responses

Response samples

Content type
{ }

Gets admin contact for parentid

query Parameters
parentId
integer <int32>
edition
string
subscriptionId
string

Responses

Response samples

Content type
{ }

Generate a password

query Parameters
length
integer <int32>
useLowerCase
boolean
useUpperCase
boolean
useDigits
boolean
useSpecialChars
boolean

Responses

Response samples

Content type
{ }

Get info for a self-registration configuration

query Parameters
selfRegistrationId
required
string

Responses

Response samples

Content type
{ }

Get module descriptions

query Parameters
firmanr
required
integer <int32>
abons
required
string

Responses

Response samples

Content type
{ }

Get extra data definitions

query Parameters
firmanr
required
integer <int32>
codes
required
string

Responses

Response samples

Content type
{ }

Register a new company or user

Headers:

  • SelfRegistrationId
  • IsParent
  • IsAdmin
  • IsExistingUser
  • IsPrivateUser
  • SendActivation
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Saves extra data

Headers:

  • SelfRegistrationId
  • TacoId
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Request an activation mail

Headers:

  • SelfRegistrationId
  • IsPasswordReset
  • Email
  • Taal
  • ContactId

Responses

Response samples

Content type
{ }

Request access granted mail

Headers:

  • SelfRegistrationId
  • Email
  • Taal
  • Contactid

Responses

Response samples

Content type
{ }

Activate users

Headers:

  • ActivationId
  • ContactId
  • NewPass

Responses

Response samples

Content type
{ }

Settings

Get a setting

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{
  • "Environment": "string",
  • "ScreenName": "string",
  • "User": "string",
  • "Key": "string",
  • "Value": "string",
  • "IsDefault": true,
  • "SettingExists": true
}

Update a setting

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
Environment
string
ScreenName
string
User
string
Key
string
Value
string
IsDefault
boolean
SettingExists
boolean

Responses

Request samples

Content type
{
  • "Environment": "string",
  • "ScreenName": "string",
  • "User": "string",
  • "Key": "string",
  • "Value": "string",
  • "IsDefault": true,
  • "SettingExists": true
}

Response samples

Content type
{ }

Add a setting

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
Environment
string
ScreenName
string
User
string
Key
string
Value
string
IsDefault
boolean
SettingExists
boolean

Responses

Request samples

Content type
{
  • "Environment": "string",
  • "ScreenName": "string",
  • "User": "string",
  • "Key": "string",
  • "Value": "string",
  • "IsDefault": true,
  • "SettingExists": true
}

Response samples

Content type
{ }

Delete a setting

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
Environment
string
ScreenName
string
User
string
Key
string
Value
string
IsDefault
boolean
SettingExists
boolean

Responses

Request samples

Content type
{
  • "Environment": "string",
  • "ScreenName": "string",
  • "User": "string",
  • "Key": "string",
  • "Value": "string",
  • "IsDefault": true,
  • "SettingExists": true
}

Response samples

Content type
{ }

SubmitForm

Submit a frevvo form

Authorizations:
pswAuthpswAuthQuery

Responses

Response samples

Content type
{ }

Submit a form

path Parameters
id
required
string

Responses

Response samples

Content type
{ }

Taken

Gets a task

Supports the default ldn url parameters for fetching data

Possible expand values:

  • vnvcd or overige
  • vnkl or opmerkingen
  • disflmn or dis
  • ldnevent or events

see also: https://organi.atlassian.net/wiki/spaces/LDN/pages/10163651/api+Taken

Authorizations:
pswAuthpswAuthQuery
path Parameters
id
required
string

the pkey to filter on (can be empty)

query Parameters
filter
string

filter the data

orderby
string

sort the data

select
string

fields to fetch

top
integer

get this number of results

skip
integer

skip this number of results

expand
string

expand the data

expandoptions (stringified json)
string

Responses

Response samples

Content type
{ }

Update an existing task

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Create a new task

IncludeFields or Excludefields can be added using a query-parameter or a request-header: https://organi.atlassian.net/wiki/x/OwD3QQ

Authorizations:
pswAuthpswAuthQuery
query Parameters
includefields
string

fields to write

excludefields
string

fields not to write

header Parameters
includefields
string

fields to write

excludefields
string

fields not to write

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Delete an existing task

Body should contain pk-fields to be able to retrieve the record

Authorizations:
pswAuthpswAuthQuery
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

TestApi

Test a long api-call

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
{ }

Test an erroreous api-call

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
{ }

Test a successful call

Responses

Response samples

Content type
{ }

VatFormatValidator

Validate a European VAT numbers format

query Parameters
vatNumber
string

Responses

Response samples

Content type
{ }

Vies

Validate a European VAT number agains VIES

query Parameters
countryCode
string
vatNumber
string

Responses

Response samples

Content type
{ }

WebReport

Get allowed webreports

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get a webreport

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
{ }