iSheets API version 2 - Common objects - Progressive key response object
iSheets API version 2 - Common objects - Progressive key response object
OVERVIEW
The progressive key response object consists of the following elements
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<progressivekeyresponse>
<progressivekey>{unique key}</progressivekey>
<progressivekeystatus>{status}</progressivekeystatus>
</progressivekeyresponse>
Andrew Quinn sorry about this. There were some inconsistencies with JSON, some of which we have already resolved, but I will also raise this as a general issue with JSON response, so the team can get this resolved. Thanks
HI Imran Aziz, I have another instance of inconsistent responses when requesting JSON. Normally when polling the progress of a request (in this case column creations), I would correctly receive something like the following when completed:
{
"progressivekey": null,
"siteid": null,
"progressivekeystatus": null,
"userid": null,
"responsebody": null,
"message": null,
"messagecode": null,
"integrationResponseDBO": null,
"columns": {
"column": [
{
"index": 1,
"columnid": 12171,
"name": "Expert ID",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
},
{
"index": 2,
"columnid": 12172,
"name": "Title",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
},
{
"index": 3,
"columnid": 12173,
"name": "FullName",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
}
]
},
"error": null,
"downloadlink": null
}
However, sometimes I receive a slightly different response. Instead of "columns" property, I receive "columnErrorsDBO", e.g.
{
"progressivekey": null,
"siteid": null,
"progressivekeystatus": null,
"userid": null,
"responsebody": null,
"message": null,
"messagecode": null,
"integrationResponseDBO": null,
"contentType": null,
"failedEntities": 0,
"downloadlink": null,
"attachment": null,
"columnErrorsDBO": {
"column": [
{
"index": 1,
"columnid": 12190,
"name": "Expert ID",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
},
{
"index": 2,
"columnid": 12191,
"name": "Title",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
},
{
"index": 3,
"columnid": 12192,
"name": "FullName",
"status": "SUCCESS",
"statuscode": "200",
"message": "Column added successfully"
}
],
"failedEntities": 0,
"successEntities": 0
},
"itemsErrorsDBO": null,
"importISheetTemplateDBO": null,
"errorDBO": null
}
This seems to be part of a broader problem - which I've reported on other end points - that when dealing with JSON responses, there seems to be two paths (or components) that are handling the JSON response differently. I don't believe I've seen similar behaviour when dealing with XML, so it's seems logical that they must be rendering JSON differently. Can we expand the issue tracker item to include reviewing JSON responses in general? As finding them is a fragmented and slow process.
Thank you
Your review has been submitted.
Comments
2 Comments