regis

<back to all web services

ProvisionalRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Provisional
import Foundation
import ServiceStack

public class ProvisionalRegistrationsRequest : Codable
{
    public var reporting_term:String
    public var authorizing_uuid:String

    required public init(){}
}

public class ProvisionalRegistrationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var provisional_registrations:[ProvisionalRegistrationResponse] = []

    required public init(){}
}

public class ProvisionalRegistrationResponse : Codable
{
    public var uuid:String
    public var regent_id:Int?
    public var student_name:String
    public var email:String
    public var section_uuid:String
    public var student_section_uuid:String
    public var course_name:String
    public var section_code:String
    public var title:String
    public var term:String
    public var amount:Double
    public var is_audit:Bool
    public var is_waitlist:Bool
    public var is_missing_requisites:Bool
    public var is_other_restriction:Bool
    public var documents:[RegistrationDocumentResponse] = []
    public var requested_date:Date

    required public init(){}
}

public class RegistrationDocumentResponse : Codable
{
    public var uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var gender:String
    public var email:String
    public var program:String
    public var concentration:String
    public var section_uuid:String
    public var course_name:String
    public var course_title:String
    public var reporting_term:String
    public var document_code:String
    public var document_json:String
    public var document_name:String
    public var document_description:String
    public var added_date:Date?
    public var changed_date:Date?

    required public init(){}
}


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

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

<ProvisionalRegistrationsResponse 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>
  <provisional_registrations>
    <ProvisionalRegistrationResponse>
      <amount>0</amount>
      <course_name>String</course_name>
      <documents>
        <RegistrationDocumentResponse>
          <added_date>0001-01-01T00:00:00</added_date>
          <changed_date>0001-01-01T00:00:00</changed_date>
          <concentration>String</concentration>
          <course_name>String</course_name>
          <course_title>String</course_title>
          <document_code>String</document_code>
          <document_description>String</document_description>
          <document_json>String</document_json>
          <document_name>String</document_name>
          <email>String</email>
          <first_name>String</first_name>
          <gender>String</gender>
          <last_name>String</last_name>
          <program>String</program>
          <regent_id>0</regent_id>
          <reporting_term>String</reporting_term>
          <section_uuid>String</section_uuid>
          <uuid>String</uuid>
        </RegistrationDocumentResponse>
      </documents>
      <email>String</email>
      <is_audit>false</is_audit>
      <is_missing_requisites>false</is_missing_requisites>
      <is_other_restriction>false</is_other_restriction>
      <is_waitlist>false</is_waitlist>
      <regent_id>0</regent_id>
      <requested_date>0001-01-01T00:00:00</requested_date>
      <section_code>String</section_code>
      <section_uuid>String</section_uuid>
      <student_name>String</student_name>
      <student_section_uuid>String</student_section_uuid>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </ProvisionalRegistrationResponse>
  </provisional_registrations>
</ProvisionalRegistrationsResponse>