Postback Message Specification for Bulk Data Transfers

This document defines the message specification sent back to API partners who request a bulk data transfer. The postback message is meant to notify them that their data is ready to pickup and to tell them where to go it.

A JSON formatted text body will be sent to the PostbackURL specified in the original request.

EndpointHTTP MethodFormat of return output
PostbackURL provided in original request message POST JSON

The JSON text will contain the following fields:

FieldTypeDescription
RequestId integer Council-generated unique id used for tracking the request

FileRetrievalURL

string

URL to retrieve completed file

Username

string

Username that originally requested bulk data file

OriginalRequest

string

Original message text

ExpirationDate

date/time

Date/time in UTC that the file will expire and be unavailable for retrieval

RequestedFileFormat

string

File format of original request

RequestedFilename

string

File name of original request

Data Element Formats

Type of Date ElementFormatExample

Date

"YYYY-MM-DD"

"2014-07-30"

Time

24-hour format, to the second "HH24:MM:SS"

"14:04:22"

Date/Time

The date and time formats above, separated by a "T"

"2014-07-30T14:04:22"

JSON Example

{
"RequestId": 138, "FileRetrievalURL":
"https://api.bbb.org/api/orgs/getbulkdatafile/04be8dd7-e676-4374-9e59-6241325ef6b2", "Username": "vendor1"
"OriginalRequest": ""
"ExpirationDate": "2016-07-30 14:04:22"
"RequestedFileFormat": "JSON"
"RequestedFilename": "test_json_file.json"
}