| GET POST | /api/documents/count |
|---|
<?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};
class RegistrationProfileFieldValue implements JsonSerializable
{
public function __construct(
/** @var string */
public string $DocumentFieldID='',
/** @var string|null */
public ?string $Value=null,
/** @var string|null */
public ?string $ShadowValue=null,
/** @var bool|null */
public ?bool $IsModifiedByUser=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DocumentFieldID'])) $this->DocumentFieldID = $o['DocumentFieldID'];
if (isset($o['Value'])) $this->Value = $o['Value'];
if (isset($o['ShadowValue'])) $this->ShadowValue = $o['ShadowValue'];
if (isset($o['IsModifiedByUser'])) $this->IsModifiedByUser = $o['IsModifiedByUser'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DocumentFieldID)) $o['DocumentFieldID'] = $this->DocumentFieldID;
if (isset($this->Value)) $o['Value'] = $this->Value;
if (isset($this->ShadowValue)) $o['ShadowValue'] = $this->ShadowValue;
if (isset($this->IsModifiedByUser)) $o['IsModifiedByUser'] = $this->IsModifiedByUser;
return empty($o) ? new class(){} : $o;
}
}
class GetDocumentsCount implements IModifiedSince, ISearchCriteria, JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $ViewID=null,
/** @var int */
public int $PageSize=0,
/** @var int */
public int $PageNumber=0,
/** @var string|null */
public ?string $SearchCriteria=null,
/** @var string|null */
public ?string $ExplorerID=null,
/** @var string|null */
public ?string $Path=null,
/** @var string|null */
public ?string $ExternalNumber=null,
/** @var DateTime|null */
public ?DateTime $ModifiedSince=null,
/** @var bool|null */
public ?bool $AllVersions=null,
/** @var bool|null */
public ?bool $Archived=null,
/** @var string|null */
public ?string $FilterName=null,
/** @var string|null */
public ?string $ProgCode=null,
/** @var string */
public string $RegistrationProfileFieldID='',
/** @var array<RegistrationProfileFieldValue>|null */
public ?array $DependableFields=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ViewID'])) $this->ViewID = $o['ViewID'];
if (isset($o['PageSize'])) $this->PageSize = $o['PageSize'];
if (isset($o['PageNumber'])) $this->PageNumber = $o['PageNumber'];
if (isset($o['SearchCriteria'])) $this->SearchCriteria = $o['SearchCriteria'];
if (isset($o['ExplorerID'])) $this->ExplorerID = $o['ExplorerID'];
if (isset($o['Path'])) $this->Path = $o['Path'];
if (isset($o['ExternalNumber'])) $this->ExternalNumber = $o['ExternalNumber'];
if (isset($o['ModifiedSince'])) $this->ModifiedSince = JsonConverters::from('DateTime', $o['ModifiedSince']);
if (isset($o['AllVersions'])) $this->AllVersions = $o['AllVersions'];
if (isset($o['Archived'])) $this->Archived = $o['Archived'];
if (isset($o['FilterName'])) $this->FilterName = $o['FilterName'];
if (isset($o['ProgCode'])) $this->ProgCode = $o['ProgCode'];
if (isset($o['RegistrationProfileFieldID'])) $this->RegistrationProfileFieldID = $o['RegistrationProfileFieldID'];
if (isset($o['DependableFields'])) $this->DependableFields = JsonConverters::fromArray('RegistrationProfileFieldValue', $o['DependableFields']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ViewID)) $o['ViewID'] = $this->ViewID;
if (isset($this->PageSize)) $o['PageSize'] = $this->PageSize;
if (isset($this->PageNumber)) $o['PageNumber'] = $this->PageNumber;
if (isset($this->SearchCriteria)) $o['SearchCriteria'] = $this->SearchCriteria;
if (isset($this->ExplorerID)) $o['ExplorerID'] = $this->ExplorerID;
if (isset($this->Path)) $o['Path'] = $this->Path;
if (isset($this->ExternalNumber)) $o['ExternalNumber'] = $this->ExternalNumber;
if (isset($this->ModifiedSince)) $o['ModifiedSince'] = JsonConverters::to('DateTime', $this->ModifiedSince);
if (isset($this->AllVersions)) $o['AllVersions'] = $this->AllVersions;
if (isset($this->Archived)) $o['Archived'] = $this->Archived;
if (isset($this->FilterName)) $o['FilterName'] = $this->FilterName;
if (isset($this->ProgCode)) $o['ProgCode'] = $this->ProgCode;
if (isset($this->RegistrationProfileFieldID)) $o['RegistrationProfileFieldID'] = $this->RegistrationProfileFieldID;
if (isset($this->DependableFields)) $o['DependableFields'] = JsonConverters::toArray('RegistrationProfileFieldValue', $this->DependableFields);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents/count HTTP/1.1
Host: dogw.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ViewID: 00000000-0000-0000-0000-000000000000,
PageSize: 0,
PageNumber: 0,
SearchCriteria: String,
ExplorerID: 00000000-0000-0000-0000-000000000000,
Path: String,
ExternalNumber: String,
ModifiedSince: 0001-01-01,
AllVersions: False,
Archived: False,
FilterName: String,
ProgCode: String,
DependableFields:
[
{
Value: String,
ShadowValue: String,
IsModifiedByUser: False
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length 0