Skip to main content

Current Chapter

Current chapter – Appendix B – the JSON file


These are examples of what you will see within the JSON file. 


JSON file for an unsuccessful submission with a validation report

{
"files": [
{
"validation_counts": { the values below detail how many of each kind of validation error were triggered "no_action": 1,
"errors": 2,
"warnings": 1
},
"type": "validation report",
"name": "validation rules -2_validation_report.csv" this is the name of the accompanying validation report
}
],
"submission": {
"status": "failed", this tells you the submission was unsuccessful
"date_time": "2018-08-08 16:26:44.643818+00:00", this is when the submission was made "supporting_information": "", any supporting information provided by the sender will appear here "sender": {
"org": "2GETHER NHS FOUNDATION TRUST", sending or gan isation ’s nam e  "id": "RTQ", send in g or gan isation’s OD S cod e 
"name": "M Bielsa" sen der’s name
},
"specification": {
"name": "validation rules", name of the specification used
"id": "6c283ec93af34920ab50033791e703d6" unique specification ID
},
"recipient": {
"org": "DSCRO SOUTH", recipient or gan isation ’s n am e  "id": "0CW" recipient or gan isation’s OD S cod e 
},
"id": "97a35f66d6eb4b9f9f07f67129fc9cd8" transaction ID
}
}

JSON file for a successful submission without a validation report

{
"files": [ validation section is not present here as there is no validation report
{
"rows": 3, number of rows in the submitted file "type": "submission",
"name": "4 columns spec with diff cases3 - template.CSV" name of the accompanying submission file
}
],
"submission": {
"status": "success", this tells you the submission was successful "date_time": "2018-08-08 16:13:50.144030+00:00",
"supporting_information": "", "sender": {
"org": "2GETHER NHS FOUNDATION TRUST", "id": "RTQ",
"name": "M Bielsa"
},
"specification": {
"name": "4 columns spec with diff cases3",
"id":    "b2ac5871-39c3-4646-bc5c-a6cbfb600cf5"
},
"recipient": {
"org": "DSCRO SOUTH",
"id": "0CW"
},
"id":   "10a3f55a8da44b77bfb3f66bfeb5df96"
}
}

SON file for a successful submission without a validation report

{
"files": [
{ file details in this section "rows": 2,
"type": "submission",
"name": "validation rules - template.csv"
},
{ validation details in this section "validation_counts": { "no_action": 1,
"errors": 0,
"warnings": 1
},
"type": "validation report",
"name": "validation rules - template_validation_report.csv"
}
],
"submission": { "status": "success",
"date_time": "2018-08-08 16:01:42.398362+00:00",
"supporting_information": "", "sender": {
"org": "2GETHER NHS FOUNDATION TRUST", "id": "RTQ",
"name": "M Bielsa"
},
"specification": {
"name": "validation rules",
"id":    "6c283ec93af34920ab50033791e703d6"
},
"recipient": {
"org": "DSCRO SOUTH",
"id": "0CW"
},
"id":    "507c0e4187aa4f9187f8b53b6f784cbc"
}
}

Last edited: 12 August 2021 11:56 am