ShortlinksAPI

<back to all web services

PostAutopilotOptionsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/autopilot-options
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostAutopilotOptionsResponse(IPostAutopilotOptionsResponse):
    response_status: Optional[ResponseStatus] = None
    success: bool = False


class AutopilotFrequency(str, Enum):
    DAILY = 'Daily'
    HOURLY = 'Hourly'
    ONCE = 'Once'


class AutopilotLevel(str, Enum):
    SHORT_LINK = 'ShortLink'
    GROUP = 'Group'
    ACCOUNT = 'Account'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostAutopilotOptionsRequest(IPostAutopilotOptionsRequest):
    # @ApiMember(IsRequired=true, Name="frequency")
    frequency: Optional[AutopilotFrequency] = None

    # @ApiMember(IsRequired=true, Name="level")
    level: Optional[AutopilotLevel] = None

    # @ApiMember(Name="enabled")
    enabled: bool = False

    # @ApiMember(IsRequired=true, Name="identifier")
    identifier: Optional[str] = None

    # @ApiMember(IsRequired=true, Name="choicePageOptions")
    choice_page_options: Dict[str, str] = field(default_factory=dict)

Python 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: shortlinks-api.qa.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
}