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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PostAutopilotOptionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Autopilot.Requests">
  <choicePageOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </choicePageOptions>
  <enabled>false</enabled>
  <frequency>Daily</frequency>
  <identifier>String</identifier>
  <level>ShortLink</level>
</PostAutopilotOptionsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostAutopilotOptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Autopilot.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <success>false</success>
</PostAutopilotOptionsResponse>