List a site's invocation codes

Lists the site's placements, grouped by zone, each with the invocation-code types the caller may generate for it.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/invocation-codes.do

Lists the site's placements, grouped by zone, each with the invocation-code types the caller may generate for it. Deleted zones and placements are left out. The types are those the placement type offers minus those the caller lacks the per-type invocation-code permission for; fetch a code with GET /rest-api/placements/{placementId}/invocation-code. Requires VIEW access to the site's inventory (ALL, or SHARED with a share on the site).

Path Params

siteId integer required

Site ID

5001

Query Params

limit integer

Placements per page, 1 to 1000

50

start integer

Offset of the first placement returned

0

Responses

200

{success, total, data:[{zoneId, zoneName, placementId, placementName, placementType, codeTypes}]}

400

start or limit out of range

401

Authentication error

403

No VIEW access to the site

404

Site not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes.do?limit=50&start=0")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body