API Enablement

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue

Hi Colin,

--data '{ "SQREQ": { "ITEM_ID": 2033 }}' will work.
But the case of the JSON field names is significant, in this example, uppercase. The request data must match what is expected by the service request schema.
You can view the request schema for a service using the URI: /zosConnect/services/{serviceName}/schema/request as documented in Get the request schema of a service.

I agree that surrounding the data string with single quotes and avoiding the need to escape double quotes is neater, (personally I had enclosed the data string value in double quotes and so had to escape the double quotes within the string). 

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue

Hi Colin,

--data '{ "SQREQ": { "ITEM_ID": 2033 }}' will work.
But the case of the JSON field names is significant, in this example, uppercase. The request data must match what is expected by the service request schema.
You can view the request schema for a service using the URI: /zosConnect/services/{serviceName}/schema/request as documented in Get the request schema of a service.

I agree that surrounding the data string with single quotes and avoiding the need to escape double quotes is neater, (personally I had enclosed the data string value in double quotes and so had to escape the double quotes within the string). 

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue

Hi Colin,

--data '{ "SQREQ": { "ITEM_ID": 2033 }}' will work.
But the case of the JSON field names is significant, in this example, uppercase. The request data must match what is expected by the service request schema.
You can view the request schema for a service using the URI: /zosConnect/services/{serviceName}/schema/request as documented in Get the request schema of a service.

I agree that surrounding the data string with single quotes and avoiding the need to escape double quotes is neater, (personally I had enclosed the data string value in double quotes and so had to escape the double quotes within the string). 

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue

Sue,

Even with
--data {"sqreq" : { "item_id": 2033}}} https://10.1.3.10:9443/zosConnect/services/stockQuery?action=invoke

I get
{"SQRESP":{"ITEM_ID":104523,"ITEM_DESC":"ription. 00050000000","ITEM_COST":null,"ITEM_COUNT":45}}
The TwoWayBackend.java has a

//a 6 digit integer item cost.
//Return a hard coded response body, with the itemID inserted.
String responseMessagePayload = String.format("%sA description. 0005000000045", itemID);

Message responseMessage = ctx.createTextMessage(responseMessagePayload);
//Response messages have the correlation id set to the message id of the


could there be a bug in the  parsing code in the sample service?

Hi Colin,

--data '{ "SQREQ": { "ITEM_ID": 2033 }}' will work.
But the case of the JSON field names is significant, in this example, uppercase. The request data must match what is expected by the service request schema.
You can view the request schema for a service using the URI: /zosConnect/services/{serviceName}/schema/request as documented in Get the request schema of a service.

I agree that surrounding the data string with single quotes and avoiding the need to escape double quotes is neater, (personally I had enclosed the data string value in double quotes and so had to escape the double quotes within the string). 

Hi Colin,

This problem is caused by the request payload being sent to the service not matching the JSON schema that the service expects.

If you are using the MQ service provider sample stockQuery.sar file shipped with the sample server template sampleMqStockManager, change the payload you send on the --data argument to be:

This should receive the response:

The API Toolkit supports the creation of services (.sar files) which use the MQ service provider. This is the typical approach to create these services, and is how the sample stockQuery.sar file was created. Instructions for using the API Toolkit to create services for the MQ service provider is described in the Quick Start scenario instructions Create a two-way IBM MQ service and more generally in Creating a CICS, IMS or IBM MQ service.

For compatibility with earlier releases, MQ service provider services can also be created using the command line build toolkit, but these do not benefit from the additional functionality provided by the API Toolkit. It looks like you may have been using request payload from "Test the stock query service",  which is only applicable to its preceding Knowledge Center pages for creating the stock query service using the build toolkit and a properties file. 

Regards, Sue