ShortlinksAPI

<back to all web services

MigrateShortLinksRequest

Requires Authentication
The following routes are available for this service:
POST/v4/short-links/migrate
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class MigrateShortLinksResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="linksMigrated")
        /** @var int */
        public int $linksMigrated=0,

        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['linksMigrated'])) $this->linksMigrated = $o['linksMigrated'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->linksMigrated)) $o['linksMigrated'] = $this->linksMigrated;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class MigrateShortLinksRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="sourceUsername")
        /** @var string|null */
        public ?string $sourceUsername=null,

        // @DataMember(Name="targetUsername")
        /** @var string|null */
        public ?string $targetUsername=null,

        // @DataMember(Name="sourceGroupId")
        /** @var int */
        public int $sourceGroupId=0,

        // @DataMember(Name="targetGroupId")
        /** @var int */
        public int $targetGroupId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['sourceUsername'])) $this->sourceUsername = $o['sourceUsername'];
        if (isset($o['targetUsername'])) $this->targetUsername = $o['targetUsername'];
        if (isset($o['sourceGroupId'])) $this->sourceGroupId = $o['sourceGroupId'];
        if (isset($o['targetGroupId'])) $this->targetGroupId = $o['targetGroupId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->sourceUsername)) $o['sourceUsername'] = $this->sourceUsername;
        if (isset($this->targetUsername)) $o['targetUsername'] = $this->targetUsername;
        if (isset($this->sourceGroupId)) $o['sourceGroupId'] = $this->sourceGroupId;
        if (isset($this->targetGroupId)) $o['targetGroupId'] = $this->targetGroupId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MigrateShortLinksRequest 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/short-links/migrate HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"sourceUsername":"String","targetUsername":"String","sourceGroupId":0,"targetGroupId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"linksMigrated":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}