Sonderzeichen in der URL

Die URL setzt sich aus folgenden Elementen zusammen:

    https://API-Adresse:443/Articles/123456?additionalFields=4
    \_____/\___________/\_/\______________/ \________________/
       A         B       C        D                 E

        A: Protokoll     
        B: Host    
        C: Port     
        D: Pfad         
        E: Abfrage
            

Abfrage

Für die Abfrage erfolgt bereits die Encodierung. Diese übernimmt im Normalfall der Client selbst, sodass man hier nichts selbst encodieren muss. Mit folgender Abfrage kann die Suche, z.B. nach Artikeln, eingeschränkt werden.

In der folgenden Abfrage wird der Slash '/' mit % 2F encodiert.
GET /Articles/Stock?searchTerm=123/456

Diese Abfrage wird zu:
GET /Articles/Stock?searchTerm=123%2F456

Pfad

Im 'Pfad' werden Sonderzeichen von der API dekodiert, jedoch nicht encodiert. Dieses muss vom Aufrufer manuell erfolgen!
Das bedeutet, dass zum Beispiel für die folgenden Route der, zwischen den Ziffern befindliche, Slash '/' nicht encodiert wird.
GET /Articles/123/456

Dieses löst unter anderem eine Exception aus, weil der Slash '/' als Teil des Pfades interpretiert wird.

Damit auch der URL Pfad encodiert wird, muss der Aufrufer selbst die Zeichen encodieren.
Dazu werden in der SelectLine API sämtliche Parameter, die direkt in der URL angegeben werden können, decodiert.
Die Encodierung macht aus '123/456' den Wert '123~2F456'. Die Decodierung wandelt diesen Wert wieder zurück.

Im Gegensatz zu der erwähnten Abfrage werden die Parameter hierfür nicht mit dem Prozentzeichen encodiert, sondern mit der Tilde '~'.
Der Grund dafür ist, dass man in der Route der HTTP Anfrage kein Prozent angeben darf.

Im folgenden Pfad einer URL wird der Slash '/' mit ~2F encodiert.
GET /Articles/123/456

Dieser Pfad wird zu:
GET /Articles/123~2F456

Um ein nicht erlaubtes Zeichen für die SelectLine API korrekt zu encodieren, müssen folgende Schritte abgearbeitet werden:

1. Der hexadezimale Wert des nicht erlaubten Zeichens muss aus der ASCII Tabelle ermittelt werden.
   Zum Beispiel: Der hexadezimale Wert für Slash '/' ist 2F
2. Dem ermittelten hexadezimalen Wert die Tilde '~' voranstellen.
   Zum Beispiel: ~2F
3. Das nicht erlaubte Zeichen durch die gebildete neue Zeichenkette ersetzen.
   Zum Beispiel: 123~2F456

Die Tilde '~' darf daher nicht als Zeichen in Datensatzschlüsseln verwendet werden, wenn die Datensatzschlüssel über die API zum Einsatz kommen sollen.
Zu beachten ist, dass andere Sonderzeichen wie z.B. Prozent '%' ohne Encodierung und Decodierung ein ungewünschtes Verhalten auslösen.
Diese Sonderzeichen könnten z.B. als Teil der URL eingestuft werden.

Folgende Zeichen werden derzeit in der API decodiert: