ShortlinksAPI

<back to all web services

PostAutopilotOptionsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/autopilot-options

// @DataContract
export class PostAutopilotOptionsResponse implements IPostAutopilotOptionsResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    // @DataMember(Name="success")
    public success: boolean;

    public constructor(init?: Partial<PostAutopilotOptionsResponse>) { (Object as any).assign(this, init); }
}

export enum AutopilotFrequency
{
    Daily = 'Daily',
    Hourly = 'Hourly',
    Once = 'Once',
}

export enum AutopilotLevel
{
    ShortLink = 'ShortLink',
    Group = 'Group',
    Account = 'Account',
}

// @DataContract
export class PostAutopilotOptionsRequest implements IPostAutopilotOptionsRequest
{
    // @DataMember(Name="frequency")
    // @ApiMember(IsRequired=true, Name="frequency")
    public frequency: AutopilotFrequency;

    // @DataMember(Name="level")
    // @ApiMember(IsRequired=true, Name="level")
    public level: AutopilotLevel;

    // @DataMember(Name="enabled")
    // @ApiMember(Name="enabled")
    public enabled: boolean;

    // @DataMember(Name="identifier")
    // @ApiMember(IsRequired=true, Name="identifier")
    public identifier: string;

    // @DataMember(Name="choicePageOptions")
    // @ApiMember(IsRequired=true, Name="choicePageOptions")
    public choicePageOptions: { [index:string]: string; } = {};

    public constructor(init?: Partial<PostAutopilotOptionsRequest>) { (Object as any).assign(this, init); }
}

TypeScript PostAutopilotOptionsRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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