-
Notifications
You must be signed in to change notification settings - Fork 11
REST Gateway 0.0.4
Petteri Kivimäki edited this page Feb 22, 2015
·
24 revisions
This is the third version of REST Gateway component that sits between X-Road security server and a REST service (diagram). The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:
-
Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
- Supported HTTP verbs:
GET,POST,PUTandDELETE - WSDL must be created manually
- REST response can be wrapped in SOAP body or SOAP attachment
- X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
- Supported HTTP verbs:
-
Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
- full support for services published through Provider Gateway
- limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are
requestelement's children) - Supported HTTP verbs:
GET,POST,PUTandDELETE - response's content type is given using Accept header (
text/xml,application/json)- if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
- X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
- Support for browser-based access
- Service id and X-Road SOAP headers can be given as URL parameters
- reformatting of resource links
- Automatic conversions: JSON -> XML, XML -> JSON
- New REST services can be added through configuration - no coding needed
Consumer Gateway accepts HTTP GET requests, and it translates them to SOAP messages following the X-Road v6 SOAP profile. For example:
[GET] http://www.example.com/rest-gateway-0.0.4/Consumer/www.restservice.com/id?param1=value1¶m2=value2
<request>
<resourceId>id</resourceId>
<param1>value1</param1>
<param2>value2</param2>
</request>
Consumer Gateway receives HTTP GET request from information system, converts the request to SOAP message, send the SOAP message to the Security Server, receives the SOAP response from the security server, converts the response according to the value of the request's Accept header and returns the response to the information system. User id and message id that are required by X-Road are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId). If X-XRd-UserId header is missing from the request, "anonymous" is set as user id. If X-XRd-MessageId is missing from the request, unique id is generated automatically. Both headers are included in the response message.
Provider Gateway accepts SOAP messages following the X-Road v6 SOAP profile. It translates XML request parameters to REST service request URI. For example:
<request>
<resourceId>id</resourceId>
<param1>value1</param1>
<param2>value2</param2>
</request>
[GET] http://www.restservice.com/id?param1=value1¶m2=value2
Provider Gateway receives SOAP request from Security Server, translates the request to REST service's request URI, sends the request to the REST service, converts the response to XML (if needed), wraps the response in SOAP message and returns the SOAP response to the security server. X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId).
- Java 6 or later
- Tomcat 6 or later
- Download the
rest-gateway-0.0.4.warfile. - Copy the file
tomcat.home/webappsfolder. - Start/restart Tomcat. The application is now accessible at:
http://localhost:8080/rest-gateway-0.0.4/Consumer
http://localhost:8080/rest-gateway-0.0.4/Provider
The WSDL description is accessible at:
http://localhost:8080/rest-gateway-0.0.4/Provider?wsdl
General settings are configured through WEB-INF/classes/consumer-gateway.properties configuration file. All the general properties are mandatory.
| Property | Required | Default | Description |
|---|---|---|---|
| id.client | * | - | Identifier of the X-Road client that initiates the service call: instance.memberClass.memberId.subsystem Can be overridden for each service. |
| ss.url | * | - | URL or IP address of the security server. The URL of Provider Gateway can be used for testing purposes. |
| namespace.serialize | * | - | Namespace that's used for serializing outgoing SOAP requests. Can be overridden for each service. |
| namespace.prefix.serialize | * | - | Namespace prefix that's used for serializing outgoing SOAP requests. Can be overridden for each service. |
Individual services are configured through WEB-INF/classes/consumers.properties configuration file. Each service has 8 properties of which 3 are mandatory. Each property must be prefixed with the number of the service, e.g. 0.id, 0.path, 0.verb. The numbering starts from zero.
| Property | Required | Default | Description |
|---|---|---|---|
| id | * | - | Identifier of the X-Road service that's called : instance.memberClass.memberId.subsystem.service.version |
| path | * | - | Path is the part after Consumer Gateway base URL that identifies a single service. Path may contain a resource id's that's marked with {resourceId}. If the service response contains links to other resources it's recommended that the path matches with the real URL of the service. |
| verb | * | - | HTTP verb that is supported by the service. The service identifier is a combination of path and verb properties, so the same path can be used multiple times with different verbs. |
| id.client | - | Identifier of the X-Road client that initiates the service call: instance.memberClass.memberId.subsystem If not defined, default value from consumser-gateway.propertiesis used. |
|
| response.modurl | false | Boolean value that indicates if Consumer Gateway should try to reformat links to other resources found in the response message. It's recommended to keep this property as false, if the response message doesn't contain links to other resources. | |
| namespace.deserialize | - | Namespace that's used for deserializing incoming SOAP responses. If not defined, default value from consumser-gateway.properties is used. | |
| namespace.serialize | - | Namespace that's used for serializing outgoing SOAP requests. If not defined, default value from consumser-gateway.properties is used. | |
| namespace.prefix.serialize | - | Namespace prefix that's used for serializing outgoing SOAP requests. If not defined, default value from consumser-gateway.properties is used. |
If the response message contains links to other resources, the links are reformatted to point the consumer gateway. However, only links which beginning matches with the resource path used in Consumer Gateway are reformatted. For example:
Resource path:
/avoindata.prh.fi/opendata/bis/v1/
Full URL of the resource path on Consumer Gateway:
http://localhost:8080/rest-gateway-0.0.4/Consumer/avoindata.prh.fi/opendata/bis/v1/
Link to another resource:
http://avoindata.prh.fi/opendata/bis/v1/2659636-7
Reformatted link:
http://localhost:8080/rest-gateway-0.0.4/Consumer/avoindata.prh.fi/opendata/bis/v1/2659636-7
This link wouldn't be reformatted as its beginning doesn't match with the resource path:
http://anotherapi.prh.fi/opendata/bis/v1/2659636-7
General settings are configured through WEB-INF/classes/provider-gateway.properties configuration file. All the general properties are mandatory.
| Property | Required | Default | Description |
|---|---|---|---|
| wsdl.path | * | - | Path or filename of the WSDL file. If only filename is given, the file must be located in WEB-INF/classes folder. |
| namespace.deserialize | - | Namespace that's used for deserializing incoming SOAP requests. If not defined, default value from provider-gateway.properties is used. | |
| namespace.serialize | - | Namespace that's used for serializing outgoing SOAP responses. If not defined, default value from provider-gateway.properties is used. | |
| namespace.prefix.serialize | - | Namespace prefix that's used for serializing outgoing SOAP responses. If not defined, default value from provider-gateway.properties is used. |
REST services are configured through WEB-INF/classes/providers.properties configuration file. Each service has 12 properties of which 2 are mandatory. Each property must be prefixed with the number of the service, e.g. 0.id, 0.url. The numbering starts from zero.
| Property | Required | Default | Description |
|---|---|---|---|
| id | * | - | Identifier of the X-Road service : instance.memberClass.memberId.subsystem.service.version |
| url | * | - | URL of the REST service. |
| verb | GET | HTTP verb that's used in the service call. Only GET is currently supported. | |
| contenttype | Not used | Content-type HTTP header that's used in the service call. | |
| accept | Not used | Accept HTTP header that's used in the service call. | |
| objecttag | result | Wrapped element for a single JSON object. | |
| arraytag | results | Wrapped element for a JSON array. | |
| response.attachment | false | Return REST response as SOAP attachment. If response is returned as SOAP attachment, Consumer Gateway ignores the value of HTTP Accept header and returns the response in the original format. | |
| request.xrdheaders | true | Pass X-Road SOAP headers to REST service via HTTP headers. | |
| namespace.deserialize | - | Namespace that's used for deserializing incoming SOAP requests. If not defined, default value from provider-gateway.properties is used. | |
| namespace.serialize | - | Namespace that's used for serializing outgoing SOAP responses. If not defined, default value from provider-gateway.properties is used. | |
| namespace.prefix.serialize | - | Namespace prefix that's used for serializing outgoing SOAP responses. If not defined, default value from provider-gateway.properties is used. |
REST Gateway 0.0.4 is shipped with configuration that includes 6 ready-to-use REST services. By default Consumer Gateway is configured to call Provider Gateway directly, and both Gateways have the same services configured. In this way it's possible to test both Gateways without access to X-Road.
Consumer Gateway services must be called using HTTP GET and Accept header can be set to text/xml or application/json. Provider Gateway services must be called using HTTP POST and Content-Type must be set to text/xml.REST Client plugin for Firefox can be used for testing purposes.
API documentation: http://www.hel.fi/palvelukarttaws/rest/ver2_en.html
Configuration:
0.id=FI_PILOT.GOV.1019125-0.Demo2Service.getOrganizationList.v1
0.path=/www.hel.fi/palvelukarttaws/rest/v2/organization/
0.verb=get
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/www.hel.fi/palvelukarttaws/rest/v2/organization/
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.getOrganizationList.v1/?X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks&Accept=application/json
Configuration:
0.id=FI_PILOT.GOV.1019125-0.Demo2Service.getOrganizationList.v1
0.url=http://www.hel.fi/palvelukarttaws/rest/v2/organization/
Service request:
- Method:
POST - Content-Type:
text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getOrganizationList</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:getOrganizationList xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request/>
</test:getOrganizationList>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API response URL: http://www.hel.fi/palvelukarttaws/rest/v2/organization/
REST Gateway response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getOrganizationList</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:getOrganizationListResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request/>
<ts1:response>
<ts1:results>
<ts1:result>
<ts1:id>49</ts1:id>
<ts1:name_en>City of Espoo</ts1:name_en>
<ts1:name_sv>Esbo stad</ts1:name_sv>
<ts1:data_source_url>www.espoo.fi</ts1:data_source_url>
<ts1:name_fi>Espoon kaupunki</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>91</ts1:id>
<ts1:name_en>City of Helsinki</ts1:name_en>
<ts1:name_sv>Helsingfors stad</ts1:name_sv>
<ts1:data_source_url>www.hel.fi</ts1:data_source_url>
<ts1:name_fi>Helsingin kaupunki</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>92</ts1:id>
<ts1:name_en>City of Vantaa</ts1:name_en>
<ts1:name_sv>Vanda stad</ts1:name_sv>
<ts1:data_source_url>www.vantaa.fi</ts1:data_source_url>
<ts1:name_fi>Vantaan kaupunki</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>235</ts1:id>
<ts1:name_en>City of Kauniainen</ts1:name_en>
<ts1:name_sv>Grankulla stad</ts1:name_sv>
<ts1:data_source_url>www.kauniainen.fi</ts1:data_source_url>
<ts1:name_fi>Kauniaisten kaupunki</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1000</ts1:id>
<ts1:name_en>State IT Service Centre, Suomi.fi editorial team</ts1:name_en>
<ts1:name_sv>Statens IT-servicecentral, Suomi.fi-redaktionen</ts1:name_sv>
<ts1:data_source_url>www.suomi.fi</ts1:data_source_url>
<ts1:name_fi>Valtion IT-palvelukeskus, Suomi.fi-toimitus</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1001</ts1:id>
<ts1:name_en>HUS Hospital District</ts1:name_en>
<ts1:name_sv>Samkommunen HNS</ts1:name_sv>
<ts1:data_source_url>www.hus.fi</ts1:data_source_url>
<ts1:name_fi>HUS-kuntayhtymä</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1002</ts1:id>
<ts1:name_en>Helsinki Marketing Ltd</ts1:name_en>
<ts1:name_sv>Helsinki Marketing Ltd</ts1:name_sv>
<ts1:data_source_url>www.visithelsinki.fi</ts1:data_source_url>
<ts1:name_fi>Helsingin markkinointi Oy</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1004</ts1:id>
<ts1:name_en>Helsinki Region Environmental Services Authority HSY</ts1:name_en>
<ts1:name_sv>Helsingforsregionens miljötjänster HRM</ts1:name_sv>
<ts1:data_source_url>www.hsy.fi</ts1:data_source_url>
<ts1:name_fi>Helsingin seudun ympäristöpalvelut HSY</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1005</ts1:id>
<ts1:name_en>Service Map editorial team</ts1:name_en>
<ts1:name_sv>Servicekartans redaktion</ts1:name_sv>
<ts1:data_source_url>www.hel.fi/palvelukartta</ts1:data_source_url>
<ts1:name_fi>Palvelukartan toimitus</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1007</ts1:id>
<ts1:name_en>JLY - Finnish Solid Waste Association</ts1:name_en>
<ts1:name_sv>JLY - Avfallsverksföreningen rf</ts1:name_sv>
<ts1:data_source_url>www.jly.fi</ts1:data_source_url>
<ts1:name_fi>JLY Jätelaitosyhdistys ry</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1008</ts1:id>
<ts1:name_en>The Norwegian Electric Vehicle Association</ts1:name_en>
<ts1:name_sv>Norsk Elbilforening</ts1:name_sv>
<ts1:data_source_url>NOBIL.no</ts1:data_source_url>
<ts1:name_fi>Norsk Elbilforening, sähköautojen latauspisteet</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1009</ts1:id>
<ts1:name_en>External service point register user society</ts1:name_en>
<ts1:name_sv>Gemenskapen bakom externa serviceregister</ts1:name_sv>
<ts1:data_source_url>asiointi.hel.fi/tprulkoinen</ts1:data_source_url>
<ts1:name_fi>Ulkoisen toimipisterekisterin käyttäjäyhteisö</ts1:name_fi>
</ts1:result>
<ts1:result>
<ts1:id>1010</ts1:id>
<ts1:name_en>University of Jyväskylä, LIPAS Liikuntapaikat.fi</ts1:name_en>
<ts1:name_sv>Jyväskylä universitet, LIPAS Liikuntapaikat.fi</ts1:name_sv>
<ts1:data_source_url>www.liikuntapaikat.fi</ts1:data_source_url>
<ts1:name_fi>Jyväskylän yliopisto, LIPAS Liikuntapaikat.fi</ts1:name_fi>
</ts1:result>
</ts1:results>
</ts1:response>
</ts1:getOrganizationListResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API documentation: http://www.hel.fi/palvelukarttaws/rest/ver2_en.html
Configuration:
1.id=FI_PILOT.GOV.1019125-0.Demo2Service.getOrganization.v1
1.path=/www.hel.fi/palvelukarttaws/rest/v2/organization/{resourceId}
1.verb=get
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/www.hel.fi/palvelukarttaws/rest/v2/organization/49
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.getOrganizationList.v1/49?X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks&Accept=application/json
Configuration:
1.id=FI_PILOT.GOV.1019125-0.Demo2Service.getOrganization.v1
1.url=http://www.hel.fi/palvelukarttaws/rest/v2/organization/
Service request:
- Method:
POST - Content-Type:
text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getOrganization</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:getOrganization xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request>
<resourceId>49</resourceId>
</test:request>
</test:getOrganization>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API response URL: http://www.hel.fi/palvelukarttaws/rest/v2/organization/49
REST Gateway response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getOrganization</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:getOrganizationResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request>
<ts1:resourceId>49</ts1:resourceId>
</ts1:request>
<ts1:response>
<ts1:result>
<ts1:id>49</ts1:id>
<ts1:name_en>City of Espoo</ts1:name_en>
<ts1:name_sv>Esbo stad</ts1:name_sv>
<ts1:data_source_url>www.espoo.fi</ts1:data_source_url>
<ts1:name_fi>Espoon kaupunki</ts1:name_fi>
</ts1:result>
</ts1:response>
</ts1:getOrganizationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API documentation: http://openweathermap.org/current
Configuration:
2.id=FI_PILOT.GOV.1019125-0.Demo2Service.getWeather.v1
2.path=/api.openweathermap.org/data/2.5/weather/
2.verb=get
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/api.openweathermap.org/data/2.5/weather/?q=Helsinki
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.getWeather.v1/?q=Helsinki&X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks&Accept=application/json
Configuration:
2.id=FI_PILOT.GOV.1019125-0.Demo2Service.getWeather.v1
2.url=http://api.openweathermap.org/data/2.5/weather?mode=xml
2.response.convert=false
Service request:
Method: POST
Content-Type: text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getWeather</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:getWeather xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request>
<test:q>Helsinki</test:q>
</test:request>
</test:getWeather>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API response URL: http://api.openweathermap.org/data/2.5/weather?mode=xml&q=Helsinki
REST Gateway response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getWeather</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:getWeatherResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request>
<ts1:q>Helsinki</ts1:q>
</ts1:request>
<ts1:response>
<ts1:current>
<ts1:city id="658225" name="Helsinki">
<ts1:coord lat="60.17" lon="24.94"/>
<ts1:country>FI</ts1:country>
<ts1:sun rise="2015-01-10T07:15:39" set="2015-01-10T13:40:00"/>
</ts1:city>
<ts1:temperature max="270.55" min="270.55" unit="kelvin" value="270.55"/>
<ts1:humidity unit="%" value="94"/>
<ts1:pressure unit="hPa" value="988.069"/>
<ts1:wind>
<ts1:speed name="Moderate breeze" value="6.71"/>
<ts1:direction code="NW" name="Northwest" value="304"/>
</ts1:wind>
<ts1:clouds name="scattered clouds" value="32"/>
<ts1:visibility/>
<ts1:precipitation mode="no"/>
<ts1:weather icon="03d" number="802" value="scattered clouds"/>
<ts1:lastupdate value="2015-01-10T08:05:03"/>
</ts1:current>
</ts1:response>
</ts1:getWeatherResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API documentation: http://avoindata.prh.fi/ytj_en.html
Configuration:
3.id=FI_PILOT.GOV.1019125-0.Demo2Service.searchCompany.v1
3.path=/avoindata.prh.fi/opendata/bis/v1/
3.verb=get
3.response.modurl=true
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/avoindata.prh.fi/opendata/bis/v1/?totalResults=false&resultsFrom=0&name=asunto&companyRegistrationFrom=2014-02-28
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.searchCompany.v1/?totalResults=false&resultsFrom=0&name=asunto&companyRegistrationFrom=2014-02-28&X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks&Accept=application/json
Configuration:
3.id=FI_PILOT.GOV.1019125-0.Demo2Service.searchCompany.v1
3.url=http://avoindata.prh.fi/bis/v1
3.objecttag=responseData
Service request:
- Method:
POST - Content-Type:
text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>searchCompany</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:searchCompany xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request>
<totalResults>false</totalResults>
<maxResults>10</maxResults>
<resultsFrom>0</resultsFrom>
<name>asunto</name>
<companyRegistrationFrom>2014-02-28</companyRegistrationFrom>
</test:request>
</test:searchCompany>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API results URL: http://avoindata.prh.fi/bis/v1?totalResults=false&maxResults=10&resultsFrom=0&name=asunto&companyRegistrationFrom=2014-02-28
REST Gateway response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>searchCompany</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:searchCompanyResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request>
<ts1:totalResults>false</ts1:totalResults>
<ts1:maxResults>10</ts1:maxResults>
<ts1:resultsFrom>0</ts1:resultsFrom>
<ts1:name>asunto</ts1:name>
<ts1:companyRegistrationFrom>2014-02-28</ts1:companyRegistrationFrom>
</ts1:request>
<ts1:response>
<ts1:responseData>
<ts1:exceptionNoticeUri>http://avoindata.prh.fi/bis-exception.txt</ts1:exceptionNoticeUri>
<ts1:nextResultsUri>http://avoindata.prh.fi/opendata/bis/v1?companyRegistrationFrom=2014-02-28&resultsFrom=10&totalResults=false&name=asunto&maxResults=10</ts1:nextResultsUri>
<ts1:results>
<ts1:registrationDate>2015-01-08</ts1:registrationDate>
<ts1:name>Asunto Oy Kangasalan Kauppakulma</ts1:name>
<ts1:businessId>2664443-7</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2664443-7</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2015-01-05</ts1:registrationDate>
<ts1:name>Asunto Oy Mikkelin Sinfonia</ts1:name>
<ts1:businessId>2664370-9</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2664370-9</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2015-01-02</ts1:registrationDate>
<ts1:name>Asunto Oy Tampereen Ryydynkatu 64</ts1:name>
<ts1:businessId>2663825-6</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2663825-6</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:name>Asunto Osakeyhtiö Teijon Metsänvartija</ts1:name>
<ts1:businessId>2663307-6</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2663307-6</ts1:detailsUri>
<ts1:companyForm>OY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-29</ts1:registrationDate>
<ts1:name>Asunto Oy Hämeenlinnan Hongiston Kartano II</ts1:name>
<ts1:businessId>2662966-7</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2662966-7</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-29</ts1:registrationDate>
<ts1:name>Asunto Oy Hämeenlinnan Hongiston Pehtoori</ts1:name>
<ts1:businessId>2662967-5</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2662967-5</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-29</ts1:registrationDate>
<ts1:name>Asunto Oy Hämeenlinnan Hongiston Kartano III</ts1:name>
<ts1:businessId>2662965-9</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2662965-9</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-23</ts1:registrationDate>
<ts1:name>Asunto Oy Huittisten Satulatie 5</ts1:name>
<ts1:businessId>2662624-7</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2662624-7</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-23</ts1:registrationDate>
<ts1:name>Asunto Oy Lapuan Eeronpuisto</ts1:name>
<ts1:businessId>2663340-4</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2663340-4</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:results>
<ts1:registrationDate>2014-12-23</ts1:registrationDate>
<ts1:name>Asunto Oy Lapuan Mikonpuisto</ts1:name>
<ts1:businessId>2663388-5</ts1:businessId>
<ts1:detailsUri>http://avoindata.prh.fi/opendata/bis/v1/2663388-5</ts1:detailsUri>
<ts1:companyForm>AOY</ts1:companyForm>
</ts1:results>
<ts1:resultsFrom>0</ts1:resultsFrom>
<ts1:totalResults>-1</ts1:totalResults>
<ts1:previousResultsUri>null</ts1:previousResultsUri>
<ts1:type>fi.prh.opendata.bis</ts1:type>
<ts1:version>1</ts1:version>
</ts1:responseData>
</ts1:response>
</ts1:searchCompanyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API documentation: http://avoindata.prh.fi/ytj_en.html
Configuration:
4.id=FI_PILOT.GOV.1019125-0.Demo2Service.getCompany.v1
4.path=/avoindata.prh.fi/opendata/bis/v1/{resourceId}
4.verb=get
4.response.modurl=true
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/avoindata.prh.fi/opendata/bis/v1/2663307-6
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.getCompany.v1/2663307-6/?X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks&Accept=application/json
Configuration:
4.id=FI_PILOT.GOV.1019125-0.Demo2Service.getCompany.v1
4.url=http://avoindata.prh.fi/bis/v1
4.objecttag=responseData
Service request:
- Method:
POST - Content-Type:
text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getCompany</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:getCompany xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request>
<resourceId>2663307-6</resourceId>
</test:request>
</test:getCompany>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API response URL: http://avoindata.prh.fi/bis/v1/2663307-6
REST Gateway response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>getCompany</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:getCompanyResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request>
<ts1:resourceId>2663307-6</ts1:resourceId>
</ts1:request>
<ts1:response>
<ts1:responseData>
<ts1:exceptionNoticeUri>http://avoindata.prh.fi/bis-exception.txt</ts1:exceptionNoticeUri>
<ts1:nextResultsUri>null</ts1:nextResultsUri>
<ts1:results>
<ts1:registedOffices>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:order>0</ts1:order>
<ts1:name>SALO</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>SE</ts1:language>
<ts1:version>1</ts1:version>
</ts1:registedOffices>
<ts1:registedOffices>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:order>0</ts1:order>
<ts1:name>SALO</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>EN</ts1:language>
<ts1:version>1</ts1:version>
</ts1:registedOffices>
<ts1:registedOffices>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:order>0</ts1:order>
<ts1:name>SALO</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>FI</ts1:language>
<ts1:version>1</ts1:version>
</ts1:registedOffices>
<ts1:companyForms>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>3</ts1:source>
<ts1:name>Osakeyhtiö</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>FI</ts1:language>
<ts1:type>OY</ts1:type>
<ts1:version>1</ts1:version>
</ts1:companyForms>
<ts1:companyForms>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>3</ts1:source>
<ts1:name>Aktiebolag</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>SE</ts1:language>
<ts1:type>AB</ts1:type>
<ts1:version>1</ts1:version>
</ts1:companyForms>
<ts1:companyForms>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>3</ts1:source>
<ts1:name>Limited company</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:language>EN</ts1:language>
<ts1:type>null</ts1:type>
<ts1:version>1</ts1:version>
</ts1:companyForms>
<ts1:detailsUri>null</ts1:detailsUri>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:names>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>3</ts1:source>
<ts1:order>0</ts1:order>
<ts1:name>Asunto Osakeyhtiö Teijon Metsänvartija</ts1:name>
<ts1:endDate>null</ts1:endDate>
<ts1:version>1</ts1:version>
</ts1:names>
<ts1:name>Asunto Osakeyhtiö Teijon Metsänvartija</ts1:name>
<ts1:liquidations>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>3</ts1:source>
<ts1:description>null</ts1:description>
<ts1:endDate>null</ts1:endDate>
<ts1:language>null</ts1:language>
<ts1:type>TP</ts1:type>
<ts1:version>1</ts1:version>
</ts1:liquidations>
<ts1:registeredEntries>
<ts1:register>1</ts1:register>
<ts1:authority>2</ts1:authority>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:status>2</ts1:status>
<ts1:description>null</ts1:description>
<ts1:endDate>null</ts1:endDate>
<ts1:language>null</ts1:language>
<ts1:statusDate>2014-12-30</ts1:statusDate>
</ts1:registeredEntries>
<ts1:contactDetails>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:value>0400815565</ts1:value>
<ts1:endDate>null</ts1:endDate>
<ts1:language>FI</ts1:language>
<ts1:type>Matkapuhelin</ts1:type>
<ts1:version>1</ts1:version>
</ts1:contactDetails>
<ts1:contactDetails>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:value>0400815565</ts1:value>
<ts1:endDate>null</ts1:endDate>
<ts1:language>SE</ts1:language>
<ts1:type>Mobiltelefon</ts1:type>
<ts1:version>1</ts1:version>
</ts1:contactDetails>
<ts1:businessId>2663307-6</ts1:businessId>
<ts1:addresses>
<ts1:careOf>null</ts1:careOf>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:street>Teijontie 23</ts1:street>
<ts1:postCode>25570</ts1:postCode>
<ts1:endDate>null</ts1:endDate>
<ts1:language>FI</ts1:language>
<ts1:type>2</ts1:type>
<ts1:country>null</ts1:country>
<ts1:city>TEIJO</ts1:city>
<ts1:version>1</ts1:version>
</ts1:addresses>
<ts1:addresses>
<ts1:careOf>null</ts1:careOf>
<ts1:registrationDate>2014-12-30</ts1:registrationDate>
<ts1:source>0</ts1:source>
<ts1:street>Teijontie 23</ts1:street>
<ts1:postCode>25570</ts1:postCode>
<ts1:endDate>null</ts1:endDate>
<ts1:language>FI</ts1:language>
<ts1:type>1</ts1:type>
<ts1:country>null</ts1:country>
<ts1:city>TEIJO</ts1:city>
<ts1:version>1</ts1:version>
</ts1:addresses>
<ts1:companyForm>OY</ts1:companyForm>
</ts1:results>
<ts1:resultsFrom>0</ts1:resultsFrom>
<ts1:totalResults>-1</ts1:totalResults>
<ts1:previousResultsUri>null</ts1:previousResultsUri>
<ts1:type>fi.prh.opendata.bis</ts1:type>
<ts1:version>1</ts1:version>
</ts1:responseData>
</ts1:response>
</ts1:getCompanyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API documentation: http://api.finto.fi/
Configuration:
5.id=FI_PILOT.GOV.1019125-0.Demo2Service.fintoService.v1
5.path=/api.finto.fi/rest/v1/search/
5.verb=get
Service request:
- Method:
GET - Accept:
text/xmlorapplication/json - X-XRd-MessageId:
1 - X-XRd-UserId:
test
N.B. Accept header is ignored and response is always returned in application/json, because Provider Gateway is configured to return the response as SOAP attachment, and conversions are not supported for attachments.
URL:
http://localhost:8080/rest-gateway-0.0.4/Consumer/api.finto.fi/rest/v1/search/?query=cat&lang=en
Browser-based access:
http://localhost:8080/rest-gateway-0.0.4/Consumer/FI_PILOT.GOV.1019125-0.Demo2Service.fintoService.v1/?query=cat&lang=en&X-XRd-UserId=test&X-XRd-MessageId=1&X-XRd-NamespaceSerialize=http://vrk-test.x-road.fi/producer&X-XRd-NamespacePrefixSerialize=ks
Configuration:
5.id=FI_PILOT.GOV.1019125-0.Demo2Service.fintoService.v1
5.url=http://api.finto.fi/rest/v1/search
5.response.convert=false
5.response.attachment=true
Service request:
- Method:
POST - Content-Type:
text/xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>fintoService</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<test:fintoService xmlns:test="http://vrk-test.x-road.fi/producer">
<test:request>
<test:query>cat</test:query>
<test:lang>en</test:lang>
</test:request>
</test:fintoService>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
API response URL: http://api.finto.fi/rest/v1/search?query=cat&lang=en
REST Gateway response:
------=_Part_0_1021174698.1420877957158
Content-Type: text/xml; charset=utf-8
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:sdsb="http://x-road.eu/xsd/sdsb.xsd">
<SOAP-ENV:Header>
<sdsb:client id:objectType="SUBSYSTEM">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>0245437-2</id:memberCode>
<id:subsystemCode>ConsumerService</id:subsystemCode>
</sdsb:client>
<sdsb:service id:objectType="SERVICE">
<id:sdsbInstance>FI_PILOT</id:sdsbInstance>
<id:memberClass>GOV</id:memberClass>
<id:memberCode>1019125-0</id:memberCode>
<id:subsystemCode>Demo2Service</id:subsystemCode>
<id:serviceCode>fintoService</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</sdsb:service>
<sdsb:userId>test</sdsb:userId>
<sdsb:id>0ba036ea-d612-4e74-bf73-59a6f15627c8</sdsb:id>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ts1:fintoServiceResponse xmlns:ts1="http://vrk-test.x-road.fi/producer">
<ts1:request>
<ts1:query>cat</ts1:query>
<ts1:lang>en</ts1:lang>
</ts1:request>
<ts1:response>
<ts1:data href="response_data"/>
</ts1:response>
</ts1:fintoServiceResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
------=_Part_0_1021174698.1420877957158
Content-Type: application/json
Content-ID: response_data
{"@context":{"skos":"http:\/\/www.w3.org\/2004\/02\/skos\/core#","onki":"http:\/\/schema.onki.fi\/onki#","uri":"@id","type":"@type","results":{"@id":"onki:results","@container":"@list"},"prefLabel":"skos:prefLabel","altLabel":"skos:altLabel","hiddenLabel":"skos:hiddenLabel","broader":"skos:broader","@language":null},"uri":"","results":[{"uri":"http:\/\/iconclass.org\/34B12","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"ic"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"afo","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/afo\/p1287","type":["skos:Concept","http:\/\/www.yso.fi\/onto\/afo-meta\/Concept"],"prefLabel":"cat","lang":"en","vocab":"afo"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"juho","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"jupo","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"kauno","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"kito","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/koko\/p37252","type":["skos:Concept","http:\/\/www.yso.fi\/onto\/afo-meta\/Concept","http:\/\/www.yso.fi\/onto\/kauno-meta\/Concept"],"prefLabel":"cat","lang":"en","vocab":"koko"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"kto","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"kulo","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"liito","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"mero","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/mesh\/D002415","type":["skos:Concept"],"prefLabel":"Cats","lang":"en","hiddenLabel":"Cat","vocab":"mesh"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"muso","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"puho","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"maotao","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/tero\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"tero"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"tsr","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"valo","exvocab":"yso"},{"uri":"http:\/\/www.yso.fi\/onto\/yso\/p19378","type":["skos:Concept"],"prefLabel":"cat","lang":"en","vocab":"yso"}]}
------=_Part_0_1021174698.1420877957158--