GET /api/apps/versions/{AppVersionID}/publicprofile

Returns information about an app's public profile, if the public profile has been set up.

Authorization Roles/Permissions: No permission required.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/publicprofile

Back to top

Sample Request

The example below shows a request for the public profile for the specified app version.

Request URL

https://{hostname}/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/publicprofile

Sample request headers

GET /api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/publicprofile HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
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, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the public profile for the specified app version.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 08 Jul 2013 19:54:44 GMT

Sample response body

{
  "RuntimeID" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
  "Title" : "PaaSTime",
  "SubTitle" : "Learning Fun!",
  "Description" : "A learning app: games, puzzles, language and spelling practice.",
  "AppURI" : "http://www.acmepaymentscorp.com/paastime",
  "LogoPictureID" : 1553,
  "LogoAssigned" : true,
  "LogoURL" : "/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/publicprofile/picture",
  "LegalDisclaimer" : "Copyright (c) 2013. All Rights Reserved.",
  "Created" : "2013-07-08T15:46:50Z",
  "Updated" : "2013-07-08T15:46:50Z"
}

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, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
AppPublicProfile AppPublicProfile Contains information about an app's public profile.

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
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.
404 The resource could not be found. For example, you might get this if you included an invalid AppVersionID in the request.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics