Dart
Dart
Add a Path Substitution Parameter to a REST Request
See more REST Examples
Demonstrates Rest.AddPathParam, which adds or replaces a path-substitution parameter. Before a request is sent, each occurrence of the name in the URI path is replaced with its value.
Background. Path parameters keep a URI path template readable—placeholders such as
{userId} are substituted with concrete values just before the request is sent.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
final rest = CkRest();
// Connect to the REST server. The 3rd argument enables TLS (use true for HTTPS on port 443),
// and the 4th enables automatic reconnection if the connection is dropped between requests.
final bTls = true;
final bAutoReconnect = true;
try {
rest.connect('example.com', 443, bTls, bAutoReconnect);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Add path-substitution parameters. Before a request is sent, each occurrence of the name in the
// URI path is replaced with the value. This keeps the path template readable.
rest.addPathParam('{userId}', '12345');
rest.addPathParam('{orderId}', '98765');
// The placeholders in the path are replaced before the request is sent.
final String responseText;
try {
responseText = rest.fullRequestNoBody('GET', '/users/{userId}/orders/{orderId}');
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
print(responseText);
}