GET All Ad Functions By Id

Overview

---

The following table contains important information about the GET method in regards to receiving all the ad functions by id.

GET Ad Functions By Id
Method	GET
URL or Endpoint	/api/projects/projectId/ad-functions/id
Headers	Authorization
Parameters	id, projectId, api-version
Body	Not Applicable

The description of the URL parameter is as follows:

Parameter Name	Mandatory	Type	Description
id	string	Unique id of the ad function.
projectId	Yes	string	The id of the project.
api-version	No	string	The correct api version to use.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "description": "string"
    }
  ],
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	Id of the ad functions.
name	string	Name of the ad functions.
value	string	Value of the ad functions.
description	string	Description of the ad functions.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed