regis

<back to all web services

DirectorySearchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/{search}
<?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 DirectorySearchRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $search=null
    ) {
    }

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

PHP DirectorySearchRequest 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.

POST /Directory/{search} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"search":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"directory_uuid":"String","name":"String","is_active":false}]