regis

<back to all web services

UnauthenticatedPersonsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPersons/{reporting_term}
<?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 UnauthenticatedPersonsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var bool|null */
        public ?bool $is_submitted=null,
        /** @var bool|null */
        public ?bool $is_authorized=null,
        /** @var bool|null */
        public ?bool $is_archived=null
    ) {
    }

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

PHP UnauthenticatedPersonsRequest 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 /Registration/UnauthenticatedPersons/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UnauthenticatedPersonsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <is_archived>false</is_archived>
  <is_authorized>false</is_authorized>
  <is_submitted>false</is_submitted>
  <reporting_term>String</reporting_term>
</UnauthenticatedPersonsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfUnauthenticatedPersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <UnauthenticatedPersonResponse>
    <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>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <addr_last_changed_by>String</addr_last_changed_by>
    <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
    <archived_by_person_id>0</archived_by_person_id>
    <archived_datetime>0001-01-01T00:00:00</archived_datetime>
    <authorized_by_person_id>0</authorized_by_person_id>
    <authorized_datetime>0001-01-01T00:00:00</authorized_datetime>
    <birth_name>String</birth_name>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <denomination>String</denomination>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <ethnicity>String</ethnicity>
    <first_name>String</first_name>
    <friend_referral>String</friend_referral>
    <gender>String</gender>
    <is_applying>false</is_applying>
    <is_landlord>false</is_landlord>
    <is_returning>false</is_returning>
    <last_changed_by>String</last_changed_by>
    <last_changed_date>0001-01-01T00:00:00</last_changed_date>
    <last_name>String</last_name>
    <marital_status>String</marital_status>
    <middle_name>String</middle_name>
    <occupation>String</occupation>
    <other_referral>String</other_referral>
    <permanent_resident>String</permanent_resident>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <postsecondary_education_level>0</postsecondary_education_level>
    <preferred_name>String</preferred_name>
    <prefix>String</prefix>
    <regent_id>0</regent_id>
    <regent_login>String</regent_login>
    <reporting_term>String</reporting_term>
    <spouse_name>String</spouse_name>
    <state>String</state>
    <submitted_by_unauthenticated_person_id>0</submitted_by_unauthenticated_person_id>
    <submitted_datetime>0001-01-01T00:00:00</submitted_datetime>
    <survey>String</survey>
    <timestamp>0001-01-01T00:00:00</timestamp>
    <uuid>String</uuid>
  </UnauthenticatedPersonResponse>
</ArrayOfUnauthenticatedPersonResponse>