User Tools

Site Tools


api:product:campaign:name

API : Product campaign Name

Introduction

This request returns the name of one campaign, for the campaign badge on an account. The account's campaign stamp holds only ids ({ campaign, product, to }), so the name has to be read from the product.

Customers are not shown campaigns, so this request is for RESELLER and above.

Request

URL https://api.telecomx.dk/product/PRODUCT_ID/campaign/CAMPAIGN_ID
Method GET
Param PRODUCT_ID Id of the product holding the campaign - campaign.product on the account
Param CAMPAIGN_ID Id of the campaign - campaign.campaign on the account
Access level RESELLER with read access to the reseller, for a reseller product. RESELLER for any master product.
RESELLER_ADMIN or ADMIN for any product.

Query example

GET https://api.telecomx.dk/product/665ef4b42ed3cfb02005fdc9/campaign/6abb99d5bd7e0a0c2984bb36

Response

JSON object
_id Id Id of the campaign.
name String Name of the campaign.

Example

{
  "_id": "6abb99d5bd7e0a0c2984bb36",
  "name": "Sundbynets efterårstilbud"
}

Errors

Error code Message Description
422 <property> Invalid input for the named property - the request body, query or URL parameter failed validation
403 access_denied Insufficient access level
404 not_found Product not found
404 campaignId Campaign not found on this product
500 internal_error <Unspecified>
api/product/campaign/name.txt · Last modified: by Thomas Andersen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki