regis

<back to all web services

PersonSimpleRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person
PersonSimpleRequest Parameters:
NameParameterData TypeRequiredDescription
uuidbodystringNo
PersonSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
ubc_idformint?No
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
preferred_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
emailformstringNo
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
dobformDateTime?No
is_studentformboolNo
is_facultyformboolNo
is_vendorformboolNo

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

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

<PersonSimpleResponse 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>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <first_name>String</first_name>
  <is_faculty>false</is_faculty>
  <is_student>false</is_student>
  <is_vendor>false</is_vendor>
  <last_name>String</last_name>
  <middle_name>String</middle_name>
  <permanent_resident>String</permanent_resident>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <preferred_name>String</preferred_name>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <state>String</state>
  <ubc_id>0</ubc_id>
  <uuid>String</uuid>
</PersonSimpleResponse>