Parameters on REST Service connections
- Last Updated: August 31, 2022
- 2 minute read
- Corticon
- Documentation
- URL
- Path
- Post
You can specify as many of these parameters on a connection in no particular order. Each requires a name and should have a default value.
URL type
A URL parameter can specify the procedure code in the REST URL:https://TestURL?procedureCode=B5120ZZwith
the results:
{"results":[{"procedureCode":"B5120ZZ","rates":
[{"startDate":"2017-1-1","endDate":"2017-6-1","rate":0.85},
{"startDate":"2017-6-2","endDate":"2017-12-31","rate":0.83}]}]}
The API Gateway entry point is: ReimbursementRate-API You
can manually add more URL types. Path type
A path parameter can specify the procedure code in the REST URL:https://TestURL/0313090with
the results: {"results":[{"procedureCode":"0313090","rates":
You can manually add more Path types.
[{"startDate":"2017-1-1","endDate":"2017-12-31","rate":0.82
Post type
A Post request does not include parameters as part of the URL, instead the parameters are passed in the request body in the format:
{
"name1" : value1,
"name2" : value2
}
The POST service called must accept parameters in this format, there is no means to choose an alternate format. Many existing POST services require the parameters to passed in a format specific to the service such as
{
"order": {
"name1" : value1,
"name2" : value2
}
}
Corticon does not provide support for using an alternate format for passing POST parameters. As such, the POST service must comply with format passed by Corticon.
Selecting POST parameter type changes how the REST connector makes its requests to the endpoint, so it is possible that any specified URL parameters will be ignored.