Booklinker.API

<back to all web services

PostAppleServicesSettingsRequest

Requires Authentication
<?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 V2BaseRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class V2BaseResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class PostAppleServicesSettingsResponse extends V2BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null
    ) {
        parent::__construct($responseStatus);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

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

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

PHP PostAppleServicesSettingsRequest DTOs

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

HTTP + JSV

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

POST /jsv/reply/PostAppleServicesSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	username: String,
	userEmail: String,
	password: String,
	apiKey: String,
	publisherId: String,
	userApiResponseJsonString: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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