BusinessApi

<back to all web services

ShareAdLinkRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/share/share-ad-linkCreate a share ad linkThe link contains a JWT token with the identity of the referring user and the shared ad-message as well as the expiration of the link.
<?php namespace BusinessApi;

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};


class ShareAdLinkResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $linkWithShareAdToken=''
    ) {
    }

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

class ShareAdLinkRequest implements IGet, JsonSerializable
{
    public function __construct(
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $adId=0
    ) {
    }

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

PHP ShareAdLinkRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /share/share-ad-link HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"linkWithShareAdToken":"String"}