Get Compression Setting

Provides compression setting information for the specified HTTP-based platform. This information includes the current status of the Compression option and the file types that will be compressed.

Request

A request to find out compression setting information is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/mcc/customers/AccountNumber/compression?mediatypeid=MediaTypeID

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 right-hand corner of the MCC.
MediaTypeID Required	Replace this variable with the ID associated with the desired platform. Valid values are: 3: HTTP Large 8: HTTP Small 14: Application Delivery Network (ADN)

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
MediaTypeId	Integer	Indicates the platform for which compression setting information will be reported. Valid values are: 3: HTTP Large 8: HTTP Small 14: Application Delivery Network (ADN)
Status	Integer	Indicates whether compression has been enabled on the platform defined in the MediaTypeID response body parameter. Valid values are: 0: Disabled 1: Enabled
ContentTypes	Array	If the Compression setting has been enabled, then this response parameter will contain the set of content types on which compression will be applied.
a:string	String	ContentTypes array Indicates a content type on which compression will be applied.

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 provided below.

A sample JSON response is provided below.

{
	"MediaTypeId" : 3,
	"Status" : 1,
	"ContentTypes" : ["text\/plain", "text\/html", "text\/css", "application\/x-javascript", "text\/javascript"]
}		

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<CustomerCompressionResultAPI xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<MediaTypeId>3</MediaTypeId>
	<Status>1</Status>
	<ContentTypes xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
		<a:string>text/plain</a:string>
		<a:string>text/html</a:string>
		<a:string>text/css</a:string>
		<a:string>application/x-javascript</a:string>
		<a:string>text/javascript</a:string>
	</ContentTypes>
</CustomerCompressionResultAPI>