ShortlinksAPI

<back to all web services

PostAutopilotOptionsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/autopilot-options
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class PostAutopilotOptionsRequest : IPostAutopilotOptionsRequest
{
    @DataMember(Name="frequency")
    @SerializedName("frequency")
    @ApiMember(IsRequired=true, Name="frequency")
    override var frequency:AutopilotFrequency? = null

    @DataMember(Name="level")
    @SerializedName("level")
    @ApiMember(IsRequired=true, Name="level")
    override var level:AutopilotLevel? = null

    @DataMember(Name="enabled")
    @SerializedName("enabled")
    @ApiMember(Name="enabled")
    override var enabled:Boolean? = null

    @DataMember(Name="identifier")
    @SerializedName("identifier")
    @ApiMember(IsRequired=true, Name="identifier")
    override var identifier:String? = null

    @DataMember(Name="choicePageOptions")
    @SerializedName("choicePageOptions")
    @ApiMember(IsRequired=true, Name="choicePageOptions")
    override var choicePageOptions:HashMap<String,String> = HashMap<String,String>()
}

enum class AutopilotFrequency
{
    Daily,
    Hourly,
    Once,
}

enum class AutopilotLevel
{
    ShortLink,
    Group,
    Account,
}

@DataContract
open class PostAutopilotOptionsResponse : IPostAutopilotOptionsResponse
{
    @DataMember(Name="responseStatus")
    @SerializedName("responseStatus")
    open var responseStatus:ResponseStatus? = null

    @DataMember(Name="success")
    @SerializedName("success")
    override var success:Boolean? = null
}

Kotlin 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
}