Get Bulk Load Request

Retrieves information, including status, about a bulk load submitted via the Bulk Load Content endpoint.

Request

A request to retrieve information about a bulk load request is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/edge/bulkload/BulkLoadID

Define the following variables when submitting the above request.

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.
BulkLoadID Required	Replace this variable with an integer that identifies a bulk load request by its ID. This ID is returned by the Bulk Load Content endpoint.

Description

AccountNumber

Required

Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.

BulkLoadID

Required

Replace this variable with an integer that identifies a bulk load request by its ID. This ID is returned by the Bulk Load Content endpoint.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters:

Name	Data Type	Description
Status_Details	Object	Provides information about the bulk load request.
Count	Integer	Status_Details object Indicates the number of load requests defined in the bulk load request. Each element defined in the MediaPath array of the Bulk Load Content endpoint counts as a separate load request.
Status	String	Status_Details object Indicates the status for the load requests defined in the bulk load request. Valid values are: in-progress: Indicates that one or more load requests have not been completed. done: Indicates that all load requests have been completed.
Created_at	String	Status_Details object Indicates the date and time (UTC) at which the bulk load request was submitted. Format: MM\/DD\/YYYY hh:mm:ss AM\|PM
Completed_at	String	Status_Details object Indicates the date and time (UTC) at which all load requests defined in the bulk load request were completed. Format: MM\/DD\/YYYY hh:mm:ss AM\|PM A null value is returned when the bulk load request is still being processed.
Batch_id	String	Status_Details object Identifies a bulk load request by its unique ID.
Progress	String	Status_Details object Identifies the percentage of load requests that have been completed.
Completed	Integer	Status_Details object Indicates the number of load requests that have been completed.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

GET https://api.transactcdn.com/v2/mcc/customers/0001/edge/bulkload/522e0c33e5671c06c14235e8 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host: api.transactcdn.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 227

{
	"Status_Details": {
		"Count": 50,
		"Status": "in-progress",
		"Created_at": "1\/20\/2022 8:33:25 PM",
		"Completed_at": null,
		"Batch_id": "522e0c33e5671c06c14235e8 ",
		"Progress": "0.0",
		"Completed": 0
	}
}