POST /resources/branding/generatestyles

Generates platform styles for a specified theme or for all themes.

Authorization Roles/Permissions: Must be logged in. Site Admin only.

This topic includes the following sections:

HTTP Method

POST

URL

{protocol}//{hostname}/resources/branding/generatestyles

Sample Request

The example below shows a request to generate styles for the specified theme.

Sample Request URL

http://acmepaymentscorp.com/resources/branding/generatestyles

Sample request headers

Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

theme=devportal

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	application/x-www-form-urlencoded
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
theme	Form	String	Optional	The platform theme for which styles should be generated. If no theme is included, styles are generated for all themes.

Response

If successful, this operation returns HTTP status code 200, and the platform styles are regenerated using the latest version of the custom.less file.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

(Status-Line): HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache
Expires: Wed, 23 Sep 2015 09:07:57 GMT

Sample response body

None.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

None. If the response code is 200, the styles were regenerated.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if the Accept header is set to a wrong value.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics