regis

<back to all web services

CatalogsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Catalogs
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 CatalogsRequest
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class CatalogResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property id As Integer
            Public Overridable Property catalog_code As String
        End Class

        Public Partial Class CatalogsResponse
            Public Sub New()
                catalogs = New List(Of CatalogResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property catalogs As List(Of CatalogResponse)
        End Class
    End Namespace
End Namespace

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

{
	
}
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
		}
	},
	catalogs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			catalog_code: String
		}
	]
}