ShortlinksAPI

<back to all web services

PostAutopilotOptionsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/autopilot-options
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ShortlinksAPI.ServiceModel.V4.Requests
Imports Geniuslink.Shortlinks.Contracts.Autopilot
Imports ShortlinksAPI.ServiceModel.V4.Responses

Namespace Global

    Namespace Geniuslink.Shortlinks.Contracts.Autopilot

        Public Enum AutopilotFrequency
            Daily
            Hourly
            Once
        End Enum

        Public Enum AutopilotLevel
            ShortLink
            Group
            Account
        End Enum
    End Namespace

    Namespace ShortlinksAPI.ServiceModel.V4.Requests

        <DataContract>
        Public Partial Class PostAutopilotOptionsRequest
            Implements IPostAutopilotOptionsRequest
            <DataMember(Name:="frequency")>
            <ApiMember(IsRequired:=true, Name:="frequency")>
            Public Overridable Property Frequency As AutopilotFrequency? Implements IPostAutopilotOptionsRequest.Frequency

            <DataMember(Name:="level")>
            <ApiMember(IsRequired:=true, Name:="level")>
            Public Overridable Property Level As AutopilotLevel? Implements IPostAutopilotOptionsRequest.Level

            <DataMember(Name:="enabled")>
            <ApiMember(Name:="enabled")>
            Public Overridable Property Enabled As Boolean Implements IPostAutopilotOptionsRequest.Enabled

            <DataMember(Name:="identifier")>
            <ApiMember(IsRequired:=true, Name:="identifier")>
            Public Overridable Property Identifier As String Implements IPostAutopilotOptionsRequest.Identifier

            <DataMember(Name:="choicePageOptions")>
            <ApiMember(IsRequired:=true, Name:="choicePageOptions")>
            Public Overridable Property ChoicePageOptions As Dictionary(Of String, String) Implements IPostAutopilotOptionsRequest.ChoicePageOptions = New Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace ShortlinksAPI.ServiceModel.V4.Responses

        <DataContract>
        Public Partial Class PostAutopilotOptionsResponse
            Implements IPostAutopilotOptionsResponse
            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus

            <DataMember(Name:="success")>
            Public Overridable Property Success As Boolean Implements IPostAutopilotOptionsResponse.Success
        End Class
    End Namespace
End Namespace

VB.NET PostAutopilotOptionsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

HTTP/1.1 200 OK
Content-Type: application/json
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}