regis

<back to all web services

PersonRestrictionsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Person/{uuid}/Restrictions
import java.math.*
import java.util.*
import net.servicestack.client.*


open class PersonRestrictionsRequest
{
    var uuid:String? = null
}

open class PersonRestrictionsResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var restrictions:ArrayList<PersonRestrictionResponse> = ArrayList<PersonRestrictionResponse>()
    var valid_restrictions:ArrayList<RestrictionResponse> = ArrayList<RestrictionResponse>()
}

open class PersonRestrictionResponse
{
    var id:Int? = null
    var restriction_code:String? = null
    var restriction_description:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
}

open class RestrictionResponse
{
    var id:Int? = null
    var restriction_code:String? = null
    var restriction_description:String? = null
    var is_active:Boolean? = null
}

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

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

<PersonRestrictionsResponse 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>
  <regent_id>0</regent_id>
  <restrictions>
    <PersonRestrictionResponse>
      <end_date>0001-01-01T00:00:00</end_date>
      <id>0</id>
      <restriction_code>String</restriction_code>
      <restriction_description>String</restriction_description>
      <start_date>0001-01-01T00:00:00</start_date>
    </PersonRestrictionResponse>
  </restrictions>
  <uuid>String</uuid>
  <valid_restrictions>
    <RestrictionResponse>
      <id>0</id>
      <is_active>false</is_active>
      <restriction_code>String</restriction_code>
      <restriction_description>String</restriction_description>
    </RestrictionResponse>
  </valid_restrictions>
</PersonRestrictionsResponse>