regis

<back to all web services

OrganizationSearchRequest

Requires Authentication
Required permission:SearchOrganization
The following routes are available for this service:
POST/organization/search
POST/organization/search/page/{Page}
<?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 OrganizationSearchRequest implements JsonSerializable
{
    public function __construct(
        /** @var int|null */
        public ?int $page=null,
        /** @var int|null */
        public ?int $organization_id=null,
        /** @var string|null */
        public ?string $organization_name=null,
        /** @var string|null */
        public ?string $organization_email=null
    ) {
    }

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

PHP OrganizationSearchRequest 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 /organization/search HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"page":0,"organization_id":0,"organization_name":"String","organization_email":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"organization_id":0,"organization_name":"String","email":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","phone_cell":"String","phone_bus":"String","phone_home":"String","is_institution":false,"is_vendor":false,"is_re":false}]