regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
<?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 SyncBioAndAddressResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $successfull=null
    ) {
    }

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

class SyncBioRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var string|null */
        public ?string $middle_name=null,
        /** @var string|null */
        public ?string $preferred_name=null,
        /** @var string|null */
        public ?string $birth_name=null,
        /** @var string|null */
        public ?string $prefix=null,
        /** @var string|null */
        public ?string $current_occupation=null,
        /** @var DateTime|null */
        public ?DateTime $dob=null,
        /** @var DateTime|null */
        public ?DateTime $deceased_date=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $marital_status=null,
        /** @var string|null */
        public ?string $citizenship=null,
        /** @var string|null */
        public ?string $citizenship_other=null,
        /** @var string|null */
        public ?string $permanent_resident=null,
        /** @var string|null */
        public ?string $queued_by_username=null,
        /** @var bool|null */
        public ?bool $queued_by_CRM=null,
        /** @var bool|null */
        public ?bool $queued_by_RE=null,
        /** @var bool|null */
        public ?bool $queued_by_REGIS=null,
        /** @var bool|null */
        public ?bool $queued_by_Sugar=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['first_name'])) $this->first_name = $o['first_name'];
        if (isset($o['last_name'])) $this->last_name = $o['last_name'];
        if (isset($o['middle_name'])) $this->middle_name = $o['middle_name'];
        if (isset($o['preferred_name'])) $this->preferred_name = $o['preferred_name'];
        if (isset($o['birth_name'])) $this->birth_name = $o['birth_name'];
        if (isset($o['prefix'])) $this->prefix = $o['prefix'];
        if (isset($o['current_occupation'])) $this->current_occupation = $o['current_occupation'];
        if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
        if (isset($o['deceased_date'])) $this->deceased_date = JsonConverters::from('DateTime', $o['deceased_date']);
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
        if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
        if (isset($o['citizenship_other'])) $this->citizenship_other = $o['citizenship_other'];
        if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
        if (isset($o['queued_by_username'])) $this->queued_by_username = $o['queued_by_username'];
        if (isset($o['queued_by_CRM'])) $this->queued_by_CRM = $o['queued_by_CRM'];
        if (isset($o['queued_by_RE'])) $this->queued_by_RE = $o['queued_by_RE'];
        if (isset($o['queued_by_REGIS'])) $this->queued_by_REGIS = $o['queued_by_REGIS'];
        if (isset($o['queued_by_Sugar'])) $this->queued_by_Sugar = $o['queued_by_Sugar'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->first_name)) $o['first_name'] = $this->first_name;
        if (isset($this->last_name)) $o['last_name'] = $this->last_name;
        if (isset($this->middle_name)) $o['middle_name'] = $this->middle_name;
        if (isset($this->preferred_name)) $o['preferred_name'] = $this->preferred_name;
        if (isset($this->birth_name)) $o['birth_name'] = $this->birth_name;
        if (isset($this->prefix)) $o['prefix'] = $this->prefix;
        if (isset($this->current_occupation)) $o['current_occupation'] = $this->current_occupation;
        if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
        if (isset($this->deceased_date)) $o['deceased_date'] = JsonConverters::to('DateTime', $this->deceased_date);
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
        if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
        if (isset($this->citizenship_other)) $o['citizenship_other'] = $this->citizenship_other;
        if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
        if (isset($this->queued_by_username)) $o['queued_by_username'] = $this->queued_by_username;
        if (isset($this->queued_by_CRM)) $o['queued_by_CRM'] = $this->queued_by_CRM;
        if (isset($this->queued_by_RE)) $o['queued_by_RE'] = $this->queued_by_RE;
        if (isset($this->queued_by_REGIS)) $o['queued_by_REGIS'] = $this->queued_by_REGIS;
        if (isset($this->queued_by_Sugar)) $o['queued_by_Sugar'] = $this->queued_by_Sugar;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SyncBioRequest 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 /Sync/Bio HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SyncBioRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <birth_name>String</birth_name>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <current_occupation>String</current_occupation>
  <deceased_date>0001-01-01T00:00:00</deceased_date>
  <dob>0001-01-01T00:00:00</dob>
  <first_name>String</first_name>
  <gender>String</gender>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <permanent_resident>String</permanent_resident>
  <preferred_name>String</preferred_name>
  <prefix>String</prefix>
  <queued_by_CRM>false</queued_by_CRM>
  <queued_by_RE>false</queued_by_RE>
  <queued_by_REGIS>false</queued_by_REGIS>
  <queued_by_Sugar>false</queued_by_Sugar>
  <queued_by_username>String</queued_by_username>
  <regent_id>0</regent_id>
</SyncBioRequest>

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

<SyncBioAndAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <successfull>false</successfull>
</SyncBioAndAddressResponse>