Indicates the value assigned to the Query-String Caching option
A request to find out query string caching information is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.edgecast.com/v2/mcc/customers/AccountNumber/querystringcaching?mediatypeid=MediaTypeID |
Define the following variable
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 |
---|---|
Required |
|
Required |
Replace this variable with the ID associated with the desired platform.
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters:
Name | Data Type | Description |
---|---|---|
MediaTypeId |
Integer |
Indicates the platform for which query string caching information was reported.
|
QueryStringCaching |
String |
Indicates the value associated with the query string caching setting for the platform defined in the MediaTypeID response body parameter. Valid values are:
|
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
GET https://api.edgecast.com/v2/mcc/customers/0001/querystringcaching?mediatypeid=3 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Host:api.edgecast.com
A sample JSON response is provided 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: 85
{
"MediaTypeId" : 3,
"QueryStringCaching" : "unique-cache"
}
A sample XML request is provided below.
GET https://api.edgecast.com/v2/mcc/customers/0001/querystringcaching?mediatypeid=3 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Host:api.edgecast.com
A sample XML response is provided 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: 266
<CustomerQueryStringCachingResult xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MediaTypeId>3</MediaTypeId>
<QueryStringCaching>unique-cache</QueryStringCaching>
</CustomerQueryStringCachingResult>