Open APIs

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.
• Operation was executed immediately (e.g. prepaid balance topup), still a task resource might be created due to the need to keep a permanent record of the topup transaction. So HTTP status for the POST would be 201 in this case, but the status of the task on creation would be complete or similar
• Operation was executed immediately (e.g. qualification check with the instantSync flag set true), in this case no value to create a permanent record, so HTTP status for the POST would be 200.

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,

Based on your post , Scenario  1 and 2 cover cases where instantSyncQualification is false  resulting task and resource creation . 

In case of scenario 2 (Operation was executed immediately )  task and resource are  created  and  request is fulfilled . 201 Created in this case looks valid.

For scenario 1 (Operation was not executed immediately) it results in task and resource creation.  But the request is still not fulfilled . In this case shouldn't it be a 202 response as per below https://tools.ietf.org/html/rfc7231#page-51%20 " target="_blank" rel="noopener">RFC standard?

 In case of scenario 3  where instantSyncQualification is true, understanding is no resource is created. 

The user guide has an example where queryServiceQualification resulted in creation of resource when instantSyncQualification  was  true. Does it need to be corrected?

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.
• Operation was executed immediately (e.g. prepaid balance topup), still a task resource might be created due to the need to keep a permanent record of the topup transaction. So HTTP status for the POST would be 201 in this case, but the status of the task on creation would be complete or similar
• Operation was executed immediately (e.g. qualification check with the instantSync flag set true), in this case no value to create a permanent record, so HTTP status for the POST would be 200.

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,

Based on your post , Scenario  1 and 2 cover cases where instantSyncQualification is false  resulting task and resource creation . 

In case of scenario 2 (Operation was executed immediately )  task and resource are  created  and  request is fulfilled . 201 Created in this case looks valid.

For scenario 1 (Operation was not executed immediately) it results in task and resource creation.  But the request is still not fulfilled . In this case shouldn't it be a 202 response as per below https://tools.ietf.org/html/rfc7231#page-51%20">https://tools.ietf.org/html/rfc7231#page-51%20"="">https://tools.ietf.org/html/rfc7231#page-51%20 " target="_blank" rel="noopener">RFC standard?

 In case of scenario 3  where instantSyncQualification is true, understanding is no resource is created. 

The user guide has an example where queryServiceQualification resulted in creation of resource when instantSyncQualification  was  true. Does it need to be corrected?

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.
• Operation was executed immediately (e.g. prepaid balance topup), still a task resource might be created due to the need to keep a permanent record of the topup transaction. So HTTP status for the POST would be 201 in this case, but the status of the task on creation would be complete or similar
• Operation was executed immediately (e.g. qualification check with the instantSync flag set true), in this case no value to create a permanent record, so HTTP status for the POST would be 200.

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.

Based on your post , Scenario  1 and 2 cover cases where instantSyncQualification is false  resulting task and resource creation . 

In case of scenario 2 (Operation was executed immediately )  task and resource are  created  and  request is fulfilled . 201 Created in this case looks valid.

For scenario 1 (Operation was not executed immediately) it results in task and resource creation.  But the request is still not fulfilled . In this case shouldn't it be a 202 response as per below https://tools.ietf.org/html/rfc7231#page-51%20">https://tools.ietf.org/html/rfc7231#page-51%20"="">https://tools.ietf.org/html/rfc7231#page-51%20 " target="_blank" rel="noopener">RFC standard?

 In case of scenario 3  where instantSyncQualification is true, understanding is no resource is created. 

The user guide has an example where queryServiceQualification resulted in creation of resource when instantSyncQualification  was  true. Does it need to be corrected?

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.
• Operation was executed immediately (e.g. prepaid balance topup), still a task resource might be created due to the need to keep a permanent record of the topup transaction. So HTTP status for the POST would be 201 in this case, but the status of the task on creation would be complete or similar
• Operation was executed immediately (e.g. qualification check with the instantSync flag set true), in this case no value to create a permanent record, so HTTP status for the POST would be 200.

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.

Based on your post , Scenario  1 and 2 cover cases where instantSyncQualification is false  resulting task and resource creation . 

In case of scenario 2 (Operation was executed immediately )  task and resource are  created  and  request is fulfilled . 201 Created in this case looks valid.

For scenario 1 (Operation was not executed immediately) it results in task and resource creation.  But the request is still not fulfilled . In this case shouldn't it be a 202 response as per below https://tools.ietf.org/html/rfc7231#page-51%20">https://tools.ietf.org/html/rfc7231#page-51%20"="">https://tools.ietf.org/html/rfc7231#page-51%20 " target="_blank" rel="noopener">RFC standard?

 In case of scenario 3  where instantSyncQualification is true, understanding is no resource is created. 

The user guide has an example where queryServiceQualification resulted in creation of resource when instantSyncQualification  was  true. Does it need to be corrected?

• Operation was not executed immediately (e.g. address validation in some cases) - in this case a task resource will be created in some persistent storage, and its status could be polled (or, better, status change events could be raised). HTTP status for the POST would be 201 in this case, since something was created.
• Operation was executed immediately (e.g. prepaid balance topup), still a task resource might be created due to the need to keep a permanent record of the topup transaction. So HTTP status for the POST would be 201 in this case, but the status of the task on creation would be complete or similar
• Operation was executed immediately (e.g. qualification check with the instantSync flag set true), in this case no value to create a permanent record, so HTTP status for the POST would be 200.

Hi,

 Looking for your guidance on understanding the  attribute instantSyncQualification used in  645 V4 tasks .

As per the description for instantSyncQualification in user guide :

• An indicator which when the value is "true" means that requester expects to get qualification result immediately in the response. 

• • If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201.

Would like to get a better  clarity on the scenarios where 200 and 201 are returned. 

Understanding is, 200 and 201 are both used in  successful  scenarios  . 

What would be the response code when  instantSyncQualification  = false and when it's true?

 cc: @Rati Mehrotra

 Thank s & Regards,