SOFOS biedt de mogelijkheid om vanaf een andere applicatie gegevens over stoffen en/of artikelen op te halen. Hiertoe worden twee REST-endpoints aangeboden waarmee gegevens opgevraagd kunnen worden.

De API maakt gebruik van 'Basic authentication' en verwacht een gebruikersnaam en wachtwoord van een gebruiker in SOFOS in de header. In de body van het request kunnen zoekargumenten worden meegegeven als Json-string. Minimaal één argument moet gevuld worden. Via de API zullen stoffen en artikelen uiteindelijk gezocht worden op alle ingevulde argumenten. Indien een argument leeg is of is weggelaten zal deze niet worden meegenomen in de zoekactie.

Indien één stof of artikel gevonden wordt o.b.v. de meegegeven zoekargumenten zal in de response-body het resultaat al Json-string worden teruggegeven. Indien meerdere of geen enkele stof of artikel gevonden kan worden zal dit ook als Json-string  in de response-body worden teruggegeven. De basis-structuur van de response is bij correcte aanroep altijd hetzelfde:

{
     "StatusCode": int ,
     "Message": "string",
     "Result": {}          
}

Hierbij bevat 'Result' het resultaat van de zoekactie.

Bij een incorrect verzoek (bijvoorbeeld wanneer een incorrect zoekargument is meegegeven in de body) zal het resultaat ook nog een lijst met fouten bevatten:

{
  "Errors": [
    "string"
  ],
  "StatusCode": int,
  "Message": "string",
  "Result": {}
}

Er zijn twee endpoints beschikbaar

Stofinformatie

Met behulp van deze API kan bijvoorbeeld van een stof worden gevraagd of de stof op de lijst van SZW-stoffen staan of welke GHS-pictogrammen aan deze stof gekoppeld zijn.

Het adres van deze API is: https://<het adres van uw SOFOS-omgeving>/api/v1/GetInfo/GetSubstanceInfo

(Json in body)

GET  {
             "SubstanceId": string,
             "CasNumber": string,
             "SubstanceName": string,
             "ExternalAPI_ID": string
         }

 Antwoord (Json in body):

{
     "StatusCode": int,
     "Message": null,
     "Result": {
           "ID": string,
           "SubstanceName": string,
           "CasNumber": string,
           "IsCMR": bool,
           "IsSZW": bool,
           "IsZZS": bool,
           "IsPZZS": bool,
           "IsBALAnnex3": bool,
           "GHSImages": string,
           "ExternalAPI_ID": string
         }
    }

Voorbeeld aanroep en antwoord:

Aanroep:

{
     "SubstanceId": "df074de1-3b63-45e2-afb2-8cd58dea18e1",
     "CasNumber":"",
     "SubstanceName":"",
     "ExternalAPI_ID":""
}

 

Antwoord:

{
     "StatusCode": 200,
     "Message": null,
     "Result": {
           "ID": "df074de1-3b63-45e2-afb2-8cd58dea18e1",
           "SubstanceName": "1,2-dichloorethaan",
           "CasNumber": "107-06-2",
           "IsCMR": true,
           "IsSZW": true,
           "IsZZS": true,
           "IsPZZS": true,
           "IsBALAnnex3": bool,
           "GHSImages": "GHS02,GHS07,GHS08",
           "ExternalAPI_ID": null
         }
  }

 

Artikelinformatie

Met behulp van deze api kan informatie over een stof worden opgevraagd via een artikel.

Het adres van deze API is: https://<het adres van uw SOFOS-omgeving>/api/v1/GetInfo/GetArticleInfo

Aanroep:

GET {

(Json in body) {
   "ArticleId": string ,
   "ArticleCode": string,
   "OrderCode": string,
   "EAN_GTINCode": string
}

 Antwoord:

(Json in body)

{
"StatusCode": 200,
"Message": null,
"Result": {
            "ID": string,
            "ArticleCode": string,
            "OrderCode": null,
            "ArticleName": string,
            "EAN_GTINCode": string,
            "HasSubstance": true,
            "SubstanceName": string,
            "CasNumber": string,
            "GHSImages": string,
            "IsCMR": bool,
            "IsSZW": bool,
            "IsZZS": bool,
            "IsPZZS": bool,
            "IsBALAnnex3": bool,
            "ExternalAPI_IDSubstance": string
          }
}

Voorbeeld aanroep en antwoord:

Aanroep:

{
     "ArticleId": "",
     "ArticleCode":"1",
     "OrderCode":"",
     "EAN_GTINCode":""
 }

 

Antwoord:

{
 "StatusCode": 200,
 "Message": null,
 "Result": {
             "ID": "ad1ab488-02a5-4aeb-94da-169e05046444",
             "ArticleCode": "1",
             "OrderCode": null,
             "ArticleName": "BZ ; 3-chinuclidinylbenzilaat, 3-quinuclidinyl",
             "EAN_GTINCode": "566556776655",
             "HasSubstance": true,
             "SubstanceName": "3-CHINUCLIDINYLBENZILAAT",
             "CasNumber": "",
             "GHSImages": "",
             "IsCMR": false,
             "IsSZW": false,
             "IsZZS": false,
             "IsPZZS": false,
             "IsBALAnnex3": bool,
             "ExternalAPI_IDSubstance": null
           }
 }

 

Extra informatie is ook op te vragen via  https://<het adres van uw SOFOS-omgeving>/swagger/ui/index