CountryRegion

the Region inside a Country e.g. Bundesländer

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get

/cmn/country-region/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/country-region/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:39:06.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:39:06.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text",
    "label": "text"
  },
  "active": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

Bundesland bzw. Regions-Verwaltung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Label

abbreviationstringOptional

Abkürzung

regionalCodestringOptional

Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)

iso3166_2Codestring · min: 4 · max: 6Optional

ISO 3166-2 Code für die Region

activebooleanRead-onlyOptional

is active

Default: true

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/country-region/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/country-region/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:39:06.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:39:06.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text",
    "label": "text"
  },
  "active": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

/cmn/country-region/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/country-region/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/country-region/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/country-region/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:39:06.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:39:06.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text",
    "label": "text"
  },
  "active": true
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/country-region/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/cmn/country-region/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:39:06.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:39:06.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text",
    "label": "text"
  },
  "active": true
}

Create new Resource

post

Body

application/json

Bundesland bzw. Regions-Verwaltung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Label

abbreviationstringOptional

Abkürzung

regionalCodestringOptional

Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)

iso3166_2Codestring · min: 4 · max: 6Optional

ISO 3166-2 Code für die Region

activebooleanRead-onlyOptional

is active

Default: true

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

post

/cmn/country-region

HTTPcURLJavaScriptPython

POST /api/cmn/country-region HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:39:06.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:39:06.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "abbreviation": "text",
  "regionalCode": "text",
  "iso3166_2Code": "text",
  "countryCode": {
    "id": 1,
    "isoAlpha2": "text",
    "label": "text"
  },
  "active": true
}