50

Business Organisation API Guide

< Back to main

Get All Business Organisation Directories - Successfully

GET /v1/business-organisations

Query Parameters

Parameter Type Optional Description

searchCriteria

Array[String]

true

inSboids

Array[String]

true

validOn

String

true

statusChoices

Array[String]

true

Must be one of ["DRAFT","VALIDATED","IN_REVIEW","WITHDRAWN","REVOKED"]

page

Integer

true

size

Integer

true

sort

Array[String]

true

Example request

$ curl 'http://localhost:8080/v1/business-organisations' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1122

{
  "objects" : [ {
    "sboid" : "ch:1:sboid:1000000",
    "said" : "1000000",
    "descriptionDe" : "desc-de",
    "descriptionFr" : "desc-fr",
    "descriptionIt" : "desc-it",
    "descriptionEn" : "desc-en",
    "abbreviationDe" : "de",
    "abbreviationFr" : "fr",
    "abbreviationIt" : "it",
    "abbreviationEn" : "en",
    "organisationNumber" : 123,
    "contactEnterpriseEmail" : "mail@mail.ch",
    "status" : "VALIDATED",
    "businessTypes" : [ "SHIP", "AIR", "RAILROAD" ],
    "validFrom" : "2000-01-01",
    "validTo" : "2000-12-31"
  }, {
    "sboid" : "ch:1:sboid:1000001",
    "said" : "1000001",
    "descriptionDe" : "desc-de1",
    "descriptionFr" : "desc-fr1",
    "descriptionIt" : "desc-it1",
    "descriptionEn" : "desc-en1",
    "abbreviationDe" : "de1",
    "abbreviationFr" : "fr1",
    "abbreviationIt" : "it1",
    "abbreviationEn" : "en1",
    "organisationNumber" : 1234,
    "contactEnterpriseEmail" : "mail1@mail.ch",
    "status" : "VALIDATED",
    "businessTypes" : [ "SHIP", "AIR", "RAILROAD" ],
    "validFrom" : "2001-01-01",
    "validTo" : "2001-12-31"
  } ],
  "totalCount" : 2
}

Get Business Organisation Directories Versions - Successfully

GET /v1/business-organisations/versions

Query Parameters

Parameter Type Optional Description

searchCriteria

Array[String]

true

inSboids

Array[String]

true

statusChoices

Array[String]

true

Must be one of ["DRAFT","VALIDATED","IN_REVIEW","WITHDRAWN","REVOKED"]

createdAfter

String

true

modifiedAfter

String

true

validOn

String

true

fromDate

String

true

toDate

String

true

validToFromDate

String

true

page

Integer

true

size

Integer

true

sort

Array[String]

true

Example request

$ curl 'http://localhost:8080/v1/business-organisations/versions' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 770

{
  "objects" : [ {
    "creationDate" : "2025-09-15T13:51:28.883186",
    "creator" : "e123456",
    "editionDate" : "2025-09-15T13:51:28.883221",
    "editor" : "e123456",
    "status" : "VALIDATED",
    "id" : 1019,
    "sboid" : "ch:1:sboid:1000000",
    "said" : "1000000",
    "descriptionDe" : "desc-de",
    "descriptionFr" : "desc-fr",
    "descriptionIt" : "desc-it",
    "descriptionEn" : "desc-en",
    "abbreviationDe" : "de",
    "abbreviationFr" : "fr",
    "abbreviationIt" : "it",
    "abbreviationEn" : "en",
    "organisationNumber" : 123,
    "contactEnterpriseEmail" : "mail@mail.ch",
    "businessTypes" : [ "SHIP", "AIR", "RAILROAD" ],
    "validFrom" : "2000-01-01",
    "validTo" : "2000-12-31",
    "etagVersion" : 0
  } ],
  "totalCount" : 1
}

Get Business Organisation Directories Versions By SBOID - Successfully

GET /v1/business-organisations/versions/ch:1:sboid:1000001

Path Variables

Path Variable Type Optional Description

sboid

String

false

Example request

$ curl 'http://localhost:8080/v1/business-organisations/versions/ch:1:sboid:1000001' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1346

[ {
  "creationDate" : "2025-09-15T13:51:29.891336",
  "creator" : "e123456",
  "editionDate" : "2025-09-15T13:51:29.891377",
  "editor" : "e123456",
  "status" : "VALIDATED",
  "id" : 1023,
  "sboid" : "ch:1:sboid:1000001",
  "said" : "1000001",
  "descriptionDe" : "desc-de1",
  "descriptionFr" : "desc-fr1",
  "descriptionIt" : "desc-it1",
  "descriptionEn" : "desc-en1",
  "abbreviationDe" : "de1",
  "abbreviationFr" : "fr1",
  "abbreviationIt" : "it1",
  "abbreviationEn" : "en1",
  "organisationNumber" : 1234,
  "contactEnterpriseEmail" : "mail1@mail.ch",
  "businessTypes" : [ ],
  "validFrom" : "2001-01-01",
  "validTo" : "2001-12-31",
  "etagVersion" : 1
}, {
  "creationDate" : "2025-09-15T13:51:30.198221",
  "creator" : "e123456",
  "editionDate" : "2025-09-15T13:51:30.198253",
  "editor" : "e123456",
  "status" : "VALIDATED",
  "id" : 1024,
  "sboid" : "ch:1:sboid:1000001",
  "said" : "1000001",
  "descriptionDe" : "desc-de1-changed",
  "descriptionFr" : "desc-fr1",
  "descriptionIt" : "desc-it1",
  "descriptionEn" : "desc-en1",
  "abbreviationDe" : "de1",
  "abbreviationFr" : "fr1",
  "abbreviationIt" : "it1",
  "abbreviationEn" : "en1",
  "organisationNumber" : 1234,
  "contactEnterpriseEmail" : "mail1@mail.ch",
  "businessTypes" : [ ],
  "validFrom" : "2002-01-01",
  "validTo" : "2002-12-31",
  "etagVersion" : 1
} ]

Get Business Organisation Directories Versions- Unsuccessfully

GET /v1/business-organisations/versions/ch:1:sboid:110000112

Path Variables

Path Variable Type Optional Description

sboid

String

false

Example request

$ curl 'http://localhost:8080/v1/business-organisations/versions/ch:1:sboid:110000112' -i -X GET

Example response

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 427

{
  "status" : 404,
  "message" : "Entity not found",
  "error" : "Not found",
  "details" : [ {
    "message" : "Object with sboid ch:1:sboid:110000112 not found",
    "field" : "sboid",
    "displayInfo" : {
      "code" : "ERROR.ENTITY_NOT_FOUND",
      "parameters" : [ {
        "key" : "field",
        "value" : "sboid"
      }, {
        "key" : "value",
        "value" : "ch:1:sboid:110000112"
      } ]
    }
  } ]
}

< Back to main