sfgboxapi

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST	/register

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations

Namespace Global

    Namespace ServiceStack

        '''<Summary>
        '''Sign Up
        '''</Summary>
        <Api(Description:="Sign Up")>
        <DataContract>
        Public Partial Class Register
            Implements IPost
            Implements IMeta
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property UserName As String

            <DataMember(Order:=2)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=3)>
            Public Overridable Property LastName As String

            <DataMember(Order:=4)>
            Public Overridable Property DisplayName As String

            <DataMember(Order:=5)>
            Public Overridable Property Email As String

            <DataMember(Order:=6)>
            Public Overridable Property Password As String

            <DataMember(Order:=7)>
            Public Overridable Property ConfirmPassword As String

            <DataMember(Order:=8)>
            Public Overridable Property AutoLogin As Nullable(Of Boolean)

            <DataMember(Order:=10)>
            Public Overridable Property ErrorView As String

            <DataMember(Order:=11)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class RegisterResponse
            Implements IMeta
            Implements IHasSessionId
            Implements IHasBearerToken
            Public Sub New()
                Roles = New List(Of String)
                Permissions = New List(Of String)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property UserId As String

            <DataMember(Order:=2)>
            Public Overridable Property SessionId As String

            <DataMember(Order:=3)>
            Public Overridable Property UserName As String

            <DataMember(Order:=4)>
            Public Overridable Property ReferrerUrl As String

            <DataMember(Order:=5)>
            Public Overridable Property BearerToken As String

            <DataMember(Order:=6)>
            Public Overridable Property RefreshToken As String

            <DataMember(Order:=7)>
            Public Overridable Property Roles As List(Of String)

            <DataMember(Order:=8)>
            Public Overridable Property Permissions As List(Of String)

            <DataMember(Order:=9)>
            Public Overridable Property ResponseStatus As ResponseStatus

            <DataMember(Order:=10)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace
End Namespace

VB.NET Register 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 /register HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userName: String,
	firstName: String,
	lastName: String,
	displayName: String,
	email: String,
	password: String,
	confirmPassword: String,
	autoLogin: False,
	errorView: String,
	meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userId: String,
	sessionId: String,
	userName: String,
	referrerUrl: String,
	bearerToken: String,
	refreshToken: String,
	roles: 
	[
		String
	],
	permissions: 
	[
		String
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	meta: 
	{
		String: String
	}
}