Booklinker.API

PostGroupRequest

The following routes are available for this service:
POST	/v1/groups

<?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 PostGroupResponse implements IPostGroupResponse, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="groupId")
        /** @var int */
        public int $groupId=0,

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

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

// @DataContract
class PostGroupRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="userAuthId")
        // @ApiMember(IsRequired=true, Name="userAuthId")
        /** @var int */
        public int $userAuthId=0
    ) {
    }

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

PHP PostGroupRequest 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 /v1/groups HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userAuthId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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