GET /api/tags

Returns tags that match the typed input, so they can be presented to the user for selection.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/tags?startWith={String}[&count={int}]

Back to top

Sample Request

In the example below, tags beginning with the user input "and" will be returned.

Request URL

https://{hostname}/api/tags?q=and

Sample request headers

GET /api/tags?q=android HTTP/1.1
Accept: */*

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
startWith Query string Required The string that the match starts with.
count Query integer Optional The number of matching entries to be returned. If not specified, defaults to 10.

Back to top

Response

If successful, this operation returns HTTP status code 200, with matching results, if any, in JSON format.

Back to top

Sample Response

The sample response below shows that there is one tag in the database that matches the user input.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Thu, 20 Sep 2012 18:47:09 GMT
Content-Type: application/json

Sample response body: application/json

{
  "Tag": [
    "Android"
  ]
}

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
Tags Tags Contains information about one or more tags that match the value provided in the request.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics