Batch

Services

Services and service definitions

Service	Description
STD_HYGIENE	CASS standardization without Change of Address
ENH_HYGIENE	CASS standardization and Change of Address. Requires completed PAF and PAF ID
ENRICHMENT_ESSENTIAL_DEMOGRAPHICS	Essential demographic append package
ENRICHMENT_COMPREHENSIVE_DEMOGRAPHICS	Comprehensive demographic append package
ENRICHMENT_GEOGRAPHY	Geography append package
ENRICHMENT_FINANCIAL	Financial demographic append package
ENRICHMENT_HOMEOWNERSHIP	Homeownership demographic append package
ENRICHMENT_HOBBIES_INTERESTS_HOME	Hobbies and Interests demographic append package
ENRICHMENT_HEALTH_WELLNESS	Health and Wellness demographic append package
ENRICHMENT_ENTERTAINMENT_TRAVEL_SPORTS	Entertainment, Travel, and Sports interest demographic append package

Standard Workflow

Create a batch and store the id from the response:

/Batch/{accountId}/create

{
  "id": "string",
  "result": "string",
  "status": "string",
  "error": "string"
}

Start processing the batch id from /Batch/{accountId}/create:

/Batch/{accountId}/{batchId}/process

Periodically check the status of the batch until it has completed. The chart below lists all possible statuses and the processing state they represent.

/Batch/{accountId}/{batchId}/status

Status	Description	State
ACCEPTED	Batch request has been accepted	Pending
CREATED	Batch request has been created	Pending
PENDING	Batch processing start is pending	Pending
STARTED	Batch has started processing	Running
PROCESSING	Batch is currently being processed	Running
COMPLETED	Batch has completed, use /Batch/{accountId}/{batchId}/result to retrieve the results	Completed without error
NOTFOUND	The specified batch was not found	Completed with error (not found)
ERROR	An error occurred while processing the batch	Completed with error

{
  "result": "string",
  "status": "string",
  "error": "string"
}

Retrieve the batch processing result. The result property in the response body contains the location of the processed data.

/Batch/{accountId}/{batchId}/result

{
  "result": "string",
  "status": "string",
  "error": "string"
}

Example Workflow

/Batch/{accountId}/create

Input

{
  "RemoteFile": "s3://a-remote-file/input.csv",
  "Optimization": "None",
  "Services": ["ENH_HYGIENE", "ENRICHMENT_COMPREHENSIVE_DEMOGRAPHICS"]
}

Output

{
  "id": "12345",
  "status": "CREATED"
}

/Batch/{accountId}/{batchId}/process

Input

{}

Output

{
  "id": "12345",
  "status": "STARTED"
}

/Batch/{accountId}/{batchId}/status

Output

{
  "id": "12345",
  "status": "PROCESSING"
}

/Batch/{accountId}/{batchId}/result

Output

{
  "id": "12345",
  "status": "COMPLETED",
  "result": "s3://a-remote-file/output.csv"
}

Results are available immediately following successful completion. No results will be produced any any error state.