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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<OrganizationSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <Page>0</Page>
  <organization_email>String</organization_email>
  <organization_id>0</organization_id>
  <organization_name>String</organization_name>
</OrganizationSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfOrganizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <OrganizationResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <email>String</email>
    <is_institution>false</is_institution>
    <is_re>false</is_re>
    <is_vendor>false</is_vendor>
    <organization_id>0</organization_id>
    <organization_name>String</organization_name>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <state>String</state>
  </OrganizationResponse>
</ArrayOfOrganizationResponse>