regis

<back to all web services

PersonKeyRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/keys
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 PersonKeyRequest
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property regent_login As String
            Public Overridable Property regent_network_login As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class PersonKeyResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property re_id As Integer
            Public Overridable Property sugar_id As String
            Public Overridable Property uuid As String
            Public Overridable Property student_id As Nullable(Of Integer)
            Public Overridable Property regent_login As String
        End Class
    End Namespace
End Namespace

VB.NET PersonKeyRequest 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 /person/keys HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	uuid: String,
	regent_login: String,
	regent_network_login: 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,
	re_id: 0,
	sugar_id: String,
	uuid: String,
	student_id: 0,
	regent_login: String
}