GeniuslinkAPI

<back to all web services

PostAutopilotOptionsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/autopilot-options
POST/v3.5/autopilot-options
"use strict";
export class PostAutopilotOptionsResponse {
    /** @param {{responseStatus?:ResponseStatus,success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    success;
}
/** @typedef {'Daily'|'Hourly'|'Once'} */
export var AutopilotFrequency;
(function (AutopilotFrequency) {
    AutopilotFrequency["Daily"] = "Daily"
    AutopilotFrequency["Hourly"] = "Hourly"
    AutopilotFrequency["Once"] = "Once"
})(AutopilotFrequency || (AutopilotFrequency = {}));
/** @typedef {'ShortLink'|'Group'|'Account'} */
export var AutopilotLevel;
(function (AutopilotLevel) {
    AutopilotLevel["ShortLink"] = "ShortLink"
    AutopilotLevel["Group"] = "Group"
    AutopilotLevel["Account"] = "Account"
})(AutopilotLevel || (AutopilotLevel = {}));
export class PostAutopilotOptionsRequest {
    /** @param {{frequency?:AutopilotFrequency,level?:AutopilotLevel,enabled?:boolean,identifier?:string,choicePageOptions?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?AutopilotFrequency} */
    frequency;
    /** @type {?AutopilotLevel} */
    level;
    /** @type {boolean} */
    enabled;
    /** @type {string} */
    identifier;
    /** @type {{ [index:string]: string; }} */
    choicePageOptions;
}

JavaScript PostAutopilotOptionsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v4/autopilot-options HTTP/1.1 
Host: geniuslink-api-zane.dev.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	frequency: Daily,
	level: ShortLink,
	enabled: False,
	identifier: String,
	choicePageOptions: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	success: False
}