regis

<back to all web services

RegistrationInProgressSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgress/{uuid}/Term/{reporting_term}/Submit
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class RegistrationInProgressSubmitRequest
            Public Sub New()
                rates_opted_in = New List(Of Integer)
            End Sub

            Public Overridable Property transaction_uuid As String
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property rates_opted_in As List(Of Integer)
            Public Overridable Property authorizing_uuid As String
            Public Overridable Property casl_optin As Boolean
            Public Overridable Property ams_optin As Boolean
            Public Overridable Property rcsa_locker_optin As Boolean
            Public Overridable Property appliedForDEReentryBenefit As Boolean
            Public Overridable Property appliedForSpousalAuditBenefit As Boolean
            Public Overridable Property appliedForSpousalCreditBenefit As Boolean
            Public Overridable Property notes As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class RegistrationInProgressSubmitResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property email As String
            Public Overridable Property first_name As String
            Public Overridable Property preferred_name As String
            Public Overridable Property last_name As String
        End Class
    End Namespace
End Namespace

VB.NET RegistrationInProgressSubmitRequest 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/InProgress/{uuid}/Term/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegistrationInProgressSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <ams_optin>false</ams_optin>
  <appliedForDEReentryBenefit>false</appliedForDEReentryBenefit>
  <appliedForSpousalAuditBenefit>false</appliedForSpousalAuditBenefit>
  <appliedForSpousalCreditBenefit>false</appliedForSpousalCreditBenefit>
  <authorizing_uuid>String</authorizing_uuid>
  <casl_optin>false</casl_optin>
  <notes>String</notes>
  <rates_opted_in xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </rates_opted_in>
  <rcsa_locker_optin>false</rcsa_locker_optin>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</RegistrationInProgressSubmitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationInProgressSubmitResponse 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>
  <email>String</email>
  <first_name>String</first_name>
  <last_name>String</last_name>
  <preferred_name>String</preferred_name>
</RegistrationInProgressSubmitResponse>