regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}
DirectorySettingsAndActivePersonLookupRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
DirectorySettingsAndPersonLookupResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
directory_settingsformDirectoryResponseNo
directory_share_settingsformDirectoryShareSettingsResponseNo
person_lookupformList<DirectoryPersonLookupResponse>No
DirectoryResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
waiverformstringNo
bdayformDateTime?No
spouse_bdayformDateTime?No
spouse_nameformstringNo
wedding_dateformDateTime?No
kidsformstringNo
home_countryformstringNo
quoteformstringNo
bioformstringNo
interestsformstringNo
categoryformstringNo
field_of_workformstringNo
churchformstringNo
DirectoryShareSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
share_full_nameformboolNo
share_bdayformboolNo
share_home_phoneformboolNo
share_cell_phoneformboolNo
share_emailformboolNo
share_addressformboolNo
share_quoteformboolNo
share_bioformboolNo
share_interestsformboolNo
share_home_countryformboolNo
share_programformboolNo
share_pictureformboolNo
share_spouse_nameformboolNo
share_spouse_bdayformboolNo
share_wedding_dateformboolNo
share_kidsformboolNo
share_field_of_workformboolNo
share_churchformboolNo
DirectoryPersonLookupResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
nameformstringNo
is_activeformboolNo

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

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

<DirectorySettingsAndPersonLookupResponse 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>
  <directory_settings>
    <bday>0001-01-01T00:00:00</bday>
    <bio>String</bio>
    <category>String</category>
    <church>String</church>
    <directory_uuid>String</directory_uuid>
    <field_of_work>String</field_of_work>
    <home_country>String</home_country>
    <interests>String</interests>
    <kids>String</kids>
    <quote>String</quote>
    <spouse_bday>0001-01-01T00:00:00</spouse_bday>
    <spouse_name>String</spouse_name>
    <waiver>String</waiver>
    <wedding_date>0001-01-01T00:00:00</wedding_date>
  </directory_settings>
  <directory_share_settings>
    <directory_uuid>String</directory_uuid>
    <share_address>false</share_address>
    <share_bday>false</share_bday>
    <share_bio>false</share_bio>
    <share_cell_phone>false</share_cell_phone>
    <share_church>false</share_church>
    <share_email>false</share_email>
    <share_field_of_work>false</share_field_of_work>
    <share_full_name>false</share_full_name>
    <share_home_country>false</share_home_country>
    <share_home_phone>false</share_home_phone>
    <share_interests>false</share_interests>
    <share_kids>false</share_kids>
    <share_picture>false</share_picture>
    <share_program>false</share_program>
    <share_quote>false</share_quote>
    <share_spouse_bday>false</share_spouse_bday>
    <share_spouse_name>false</share_spouse_name>
    <share_wedding_date>false</share_wedding_date>
  </directory_share_settings>
  <person_lookup>
    <DirectoryPersonLookupResponse>
      <directory_uuid>String</directory_uuid>
      <is_active>false</is_active>
      <name>String</name>
    </DirectoryPersonLookupResponse>
  </person_lookup>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</DirectorySettingsAndPersonLookupResponse>