ShortlinksAPI

<back to all web services

MigrateShortLinksRequest

Requires Authentication
The following routes are available for this service:
POST/v4/short-links/migrate
"use strict";
export class MigrateShortLinksResponse {
    /** @param {{linksMigrated?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    linksMigrated;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class MigrateShortLinksRequest {
    /** @param {{sourceUsername?:string,targetUsername?:string,sourceGroupId?:number,targetGroupId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    sourceUsername;
    /** @type {string} */
    targetUsername;
    /** @type {number} */
    sourceGroupId;
    /** @type {number} */
    targetGroupId;
}

JavaScript MigrateShortLinksRequest DTOs

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

HTTP + XML

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

<MigrateShortLinksRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Requests">
  <sourceGroupId>0</sourceGroupId>
  <sourceUsername>String</sourceUsername>
  <targetGroupId>0</targetGroupId>
  <targetUsername>String</targetUsername>
</MigrateShortLinksRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MigrateShortLinksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Responses">
  <linksMigrated>0</linksMigrated>
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
</MigrateShortLinksResponse>