Get Load Request

Retrieves information about a load request.

Request

A request to retrieve a load request is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/mcc/customers/AccountNumber/edge/load/LoadID

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.

LoadID

Required

Replace this variable with an integer that identifies a load request by its ID. This ID is returned by the 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

AccountNumber

String

Indicates the CDN account number associated with the load request.

CompleteDate

String

Indicates the date and time on which the load request was completed.

Format: YYYY-MM-DD hh:mm

Learn more.

A null value is returned when the load request is still being processed.

Id

String

Identifies a load request by its unique ID.

InDate

String

Indicates the date and time on which the load request was submitted.

Format: YYYY-MM-DD hh:mm

Learn more.

MediaPath

String

Indicates the CDN or edge CNAME URL for which a load request was submitted.

MediaTypeId

Integer

Indicates the service associated with the load request.

The only valid value is:

  • 14: Commerce Acceleration Network (CAN)

Regions

Array

Lists all regions to which the load request was applied.

Id

Integer

Regions array

Identifies a region by its system-defined ID.

Name

String

Regions array

Identifies a region by its name.

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/load/522e0c33e5671c06c14224d7 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: 234

{
	"AccountNumber" : "0001",
	"CompleteDate" : null,
	"Id" : "522e0c33e5671c06c14224d7",
	"InDate" : "2022-01-14 19:08",
	"MediaPath" : "http:\/\/can.0001.transactcdn.com\/000001\/WebPage.htm",
	"MediaTypeId" : 14,
	"Regions" : []
}		

Sample Request and Response (XML)

A sample XML request is shown below.

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

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

Accept: application/xml

Host: api.transactcdn.com

A sample XML response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

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

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

Content-Length: 386

<Load xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<AccountNumber>0001</AccountNumber>
	<CompleteDate i:nil="true"/>
	<Id>522e0c33e5671c06c14224d7</Id>
	<InDate>2022-01-14 19:08</InDate>
	<MediaPath>http://can.0001.transactcdn.com/000001/WebPage.htm</MediaPath>
	<MediaTypeId>14</MediaTypeId>
	<Regions/>
</Load>