Skip to content

Commit 50cf656

Browse files
committed
Update documentation with fileName in Submission json
Also, make corrections where other fields were left out.
1 parent 19cf052 commit 50cf656

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

Documents/API.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ Example response:
141141
"message": "created",
142142
"description": "The filing period is now open and available to accept HMDA data."
143143
},
144+
"fileName": "bank1_hmda_2017.txt",
145+
"receipt": "",
144146
"start": 1483287071000,
145147
"end": 0
146148
},
@@ -155,6 +157,8 @@ Example response:
155157
"message": "created",
156158
"description": "The filing period is now open and available to accept HMDA data."
157159
},
160+
"fileName": "bank1_lars_2017.txt",
161+
"receipt": "",
158162
"start": 1483287071000,
159163
"end": 0
160164
},
@@ -169,6 +173,8 @@ Example response:
169173
"message": "created",
170174
"description": "The filing period is now open and available to accept HMDA data."
171175
},
176+
"fileName": "bank1_lars_2017.txt",
177+
"receipt": "",
172178
"start": 1483287071000,
173179
"end": 0
174180
}
@@ -196,6 +202,8 @@ Example response, with HTTP code 201:
196202
"message": "created",
197203
"description": "The filing period is now open and available to accept HMDA data."
198204
},
205+
"fileName": "bank1_lars_2017.txt",
206+
"receipt": "",
199207
"start": 1483287071000,
200208
"end": 0
201209
}
@@ -221,6 +229,8 @@ Example response:
221229
"message": "created",
222230
"description": "The filing period is now open and available to accept HMDA data."
223231
},
232+
"fileName": "bank1_lars_2017.txt",
233+
"receipt": "",
224234
"start": 1483287071000,
225235
"end": 1514736671000
226236
}
@@ -245,7 +255,11 @@ Example response:
245255
"code": 3,
246256
"message": "uploaded",
247257
"description": "The data have finished uploading and are ready to be analyzed."
248-
}
258+
},
259+
"fileName": "bank1_lars_2017.txt",
260+
"receipt": "",
261+
"start": 1505142349962,
262+
"end": 0
249263
}
250264
```
251265

@@ -262,7 +276,11 @@ Example response, with HTTP code 400:
262276
"code": -1,
263277
"message": "Submission 4848484 not available for upload",
264278
"description": "An error occurred during the process of submitting the data. Please re-upload your file."
265-
}
279+
},
280+
"fileName": "",
281+
"receipt": "",
282+
"start": 0,
283+
"end": 0
266284
}
267285
```
268286

0 commit comments

Comments
 (0)