regis

<back to all web services

UnauthenticatedPersonStatusUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPerson/{uuid}/UpdateStatus
"use strict";
export class UnauthenticatedPersonResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,reporting_term?:string,survey?:string,friend_referral?:string,other_referral?:string,is_returning?:boolean,is_applying?:boolean,is_landlord?:boolean,postsecondary_education_level?:number,uuid?:string,regent_login?:string,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_name?:string,spouse_name?:string,addr1?:string,addr2?:string,country?:string,state?:string,city?:string,code?:string,phone_home?:string,phone_cell?:string,phone_bus?:string,email?:string,prefix?:string,dob?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,denomination?:string,occupation?:string,ethnicity?:string,gender?:string,marital_status?:string,deceased_date?:string,added_by?:string,added_date?:string,last_changed_by?:string,last_changed_date?:string,addr_last_changed_by?:string,addr_last_changed_date?:string,timestamp?:string,submitted_datetime?:string,submitted_by_unauthenticated_person_id?:number,authorized_datetime?:string,authorized_by_person_id?:number,archived_datetime?:string,archived_by_person_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {?number} */
    regent_id;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    survey;
    /** @type {string} */
    friend_referral;
    /** @type {string} */
    other_referral;
    /** @type {boolean} */
    is_returning;
    /** @type {boolean} */
    is_applying;
    /** @type {boolean} */
    is_landlord;
    /** @type {number} */
    postsecondary_education_level;
    /** @type {string} */
    uuid;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    spouse_name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    country;
    /** @type {string} */
    state;
    /** @type {string} */
    city;
    /** @type {string} */
    code;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    email;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    denomination;
    /** @type {string} */
    occupation;
    /** @type {string} */
    ethnicity;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    last_changed_by;
    /** @type {?string} */
    last_changed_date;
    /** @type {string} */
    addr_last_changed_by;
    /** @type {?string} */
    addr_last_changed_date;
    /** @type {string} */
    timestamp;
    /** @type {?string} */
    submitted_datetime;
    /** @type {?number} */
    submitted_by_unauthenticated_person_id;
    /** @type {?string} */
    authorized_datetime;
    /** @type {?number} */
    authorized_by_person_id;
    /** @type {?string} */
    archived_datetime;
    /** @type {?number} */
    archived_by_person_id;
}
export class UnauthenticatedPersonStatusUpdateRequest {
    /** @param {{uuid?:string,authorizing_uuid?:string,is_authorized?:boolean,is_archived?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    authorizing_uuid;
    /** @type {boolean} */
    is_authorized;
    /** @type {boolean} */
    is_archived;
}

JavaScript UnauthenticatedPersonStatusUpdateRequest 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/UnauthenticatedPerson/{uuid}/UpdateStatus HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UnauthenticatedPersonStatusUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <is_archived>false</is_archived>
  <is_authorized>false</is_authorized>
  <uuid>String</uuid>
</UnauthenticatedPersonStatusUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UnauthenticatedPersonResponse 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>
  <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>