GETALL,CRA/getAPIScopeCodes

Returns

resultJSON Object

Returns an object with these properties:

errorboolean

true if there was an error

errorTextstring

resultarray

Name

the name of the scope

Code

the 3 letter code for the scope

Description

the description of the scope

Description

Get a list of API scopes. API scopes are specified when an API key is created. The API scopes define what API methods a particular API key allows.

CURL

CURL --insecure -H "apikey:Your_api_key" -H "accept: application/json"  "https://transform.alphasoftware.com/transformAPIVersion1.a5svc/getAPIScopeCodes"

Node

var https = require('https');
var options = {
  protocol: "https:",
  hostname: "transform.alphasoftware.com",
  path: "/transformAPIVersion1.a5svc/getAPIScopeCodes",
  headers: {apikey: "Your_api_key"}
};

https.get(options, (resp) => {
  let data = '';
  resp.on('data', (chunk) => {data += chunk;});
  resp.on('end', () => {console.log(data);});
}).on("error", (err) => {console.log("Error: " + err.message);});

Xbasic

dim apikey as c = "Your_api_key"
dim postdata as c 
dim url as c = "/getAPIScopeCodes"
dim pr as p
pr = a5dialogHelper_transformAPIQuery(url,postdata,apikey)
if pr.error = .f. then
	dim result as c 
	result = pr.result
else
	dim errorText as c 
	errorText = pr.errorText
end if