GET /api/properties

Returns properties for the tenant on the platform.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/properties

Back to top

Sample Request

The example below shows a request for the properties for the tenant.

Request URL

https://{hostname}/api/properties

Sample request headers

xxsample_req_hdrxx
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Back to top

Request Parameters

None.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the tenant properties.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Expires: Thu, 15 Jan 2015 15:30:45 GMT

Sample response body


{
  "DefaultTheme" : "default",
  "ConsoleAddress" : "http://acmepaymentscorp.com/",
  "SupportedThemes" : [ {
    "Theme" : "default",
    "ConsoleAddress" : "http://acmepaymentscorp.com/"
  }, {
    "Theme" : "simpledev",
    "ConsoleAddress" : "http://acmepaymentscorp.simpledev.com"
  } ],
  "TenantID" : "acmepaymentscorp",
  "SiteAdminGroupID" : "tenantadmin.acmepaymentscorp",
  "TenantBusinessID" : "tenantbusiness.acmepaymentscorp",
  "BusinessAdminGroupID" : "bizadmin-tenantbusiness.acmepaymentscorp"
}

Back to top

Response Headers

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

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

Back to top

Response Body

Name Type Description
TenantProperties TenantProperties Contains information about basic properties for the current tenant.

Back to top

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
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics