POST api/marketing/ShortUrlCreate

Формирование короткой ссылки из длинной с дополнительными параметрами

Request Information

URI Parameters

None.

Body Parameters

ShortUrlCreateRequest
NameDescriptionTypeAdditional information
ServiceToken

Токен, выданный сторонней системе, которая по api укорачивает ссылки через ml-go.ru

string

None.

Anonimus

Признак, что аноним хочет сделать короткую ссылку из длинной (т.е. вообще левый пользователь)

boolean

None.

EventName

Наименование евента по которому нужна короткая ссылка (например: ссылка для ВК_8 марта 2021)

string

None.

EventChannel

Идентификатор канала распространения для которого делают ссылку (например: Вконтакте, Sms)

byte

None.

UrlLong

Длинная ссылка, из которой нужно сделать короткую

string

None.

UrlShortWant

Желаемая короткая ссылка

string

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceToken": "sample string 1",
  "Anonimus": true,
  "EventName": "sample string 2",
  "EventChannel": 64,
  "UrlLong": "sample string 3",
  "UrlShortWant": "sample string 4",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 5"
}

application/xml, text/xml

Sample:
<ShortUrlCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 5</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Anonimus>true</Anonimus>
  <EventChannel>64</EventChannel>
  <EventName>sample string 2</EventName>
  <ServiceToken>sample string 1</ServiceToken>
  <UrlLong>sample string 3</UrlLong>
  <UrlShortWant>sample string 4</UrlShortWant>
</ShortUrlCreateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShortUrlCreateResponse
NameDescriptionTypeAdditional information
UrlShort

Итоговая сформированная короткая ссылка

string

None.

UrlQrCode

Ссылка на изображение qr-кода короткой ссылки

string

None.

QrCodeCreate

Признак, генерить и отображать qr-код короткой ссылки пользователю или нет

boolean

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "UrlShort": "sample string 1",
  "UrlQrCode": "sample string 2",
  "QrCodeCreate": true,
  "ErrorCode": 3,
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<ShortUrlCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">3</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</Message>
  <QrCodeCreate>true</QrCodeCreate>
  <UrlQrCode>sample string 2</UrlQrCode>
  <UrlShort>sample string 1</UrlShort>
</ShortUrlCreateResponse>