regis

<back to all web services

CorrespondenceRequestedRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
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 CorrespondenceRequestedRequest
            Public Overridable Property pid As Integer
            Public Overridable Property token As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class CorrespondenceRequestedResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property request_code As String
            Public Overridable Property request_description As String
            Public Overridable Property request_instance As String
            Public Overridable Property request_status As String
            Public Overridable Property request_date As Nullable(Of Date)
            Public Overridable Property request_assigned_date As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET CorrespondenceRequestedRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /correspondence HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	pid: 0,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	request_code: String,
	request_description: String,
	request_instance: String,
	request_status: String,
	request_date: 0001-01-01,
	request_assigned_date: 0001-01-01
}