digitaluapi

<back to all web services

ClientRegister

Requires Authentication
Required role:Partner
The following routes are available for this service:
POST/clientregister
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports ServiceStack.Auth

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class ClientRegister
            <Validate(Validator:="Email")>
            Public Overridable Property EMail As String

            <Validate(Validator:="[NotNull,NotEmpty]")>
            Public Overridable Property FirstName As String

            <Validate(Validator:="[NotNull,NotEmpty]")>
            Public Overridable Property LastName As String

            <Validate(Validator:="[NotNull,NotEmpty]")>
            Public Overridable Property Password As String

            Public Overridable Property ConfirmPassword As String
            <Validate(Validator:="NotNull")>
            Public Overridable Property Company As String

            Public Overridable Property PartnerUserID As Integer
            Public Overridable Property Roles As String()
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace ServiceStack.Auth

        Public Partial Class UserAuth
            Public Overridable Property Id As Integer
            Public Overridable Property UserName As String
            Public Overridable Property Email As String
            Public Overridable Property PrimaryEmail As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property DisplayName As String
            Public Overridable Property Company As String
            Public Overridable Property BirthDate As Date?
            Public Overridable Property BirthDateRaw As String
            Public Overridable Property Address As String
            Public Overridable Property Address2 As String
            Public Overridable Property City As String
            Public Overridable Property State As String
            Public Overridable Property Country As String
            Public Overridable Property Culture As String
            Public Overridable Property FullName As String
            Public Overridable Property Gender As String
            Public Overridable Property Language As String
            Public Overridable Property MailAddress As String
            Public Overridable Property Nickname As String
            Public Overridable Property PostalCode As String
            Public Overridable Property TimeZone As String
            Public Overridable Property Salt As String
            Public Overridable Property PasswordHash As String
            Public Overridable Property DigestHa1Hash As String
            Public Overridable Property Roles As List(Of String)
            Public Overridable Property Permissions As List(Of String)
            Public Overridable Property CreatedDate As Date
            Public Overridable Property ModifiedDate As Date
            Public Overridable Property InvalidLoginAttempts As Integer
            Public Overridable Property LastLoginAttempt As Date?
            Public Overridable Property LockedDate As Date?
            Public Overridable Property RecoveryToken As String
            Public Overridable Property RefId As Integer?
            Public Overridable Property RefIdStr As String
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace
End Namespace

VB.NET ClientRegister 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 /clientregister HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EMail: String,
	FirstName: String,
	LastName: String,
	Password: String,
	ConfirmPassword: String,
	Company: String,
	PartnerUserID: 0,
	Roles: 
	[
		String
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	UserName: String,
	Email: String,
	PrimaryEmail: String,
	PhoneNumber: String,
	FirstName: String,
	LastName: String,
	DisplayName: String,
	Company: String,
	BirthDate: 0001-01-01,
	BirthDateRaw: String,
	Address: String,
	Address2: String,
	City: String,
	State: String,
	Country: String,
	Culture: String,
	FullName: String,
	Gender: String,
	Language: String,
	MailAddress: String,
	Nickname: String,
	PostalCode: String,
	TimeZone: String,
	Salt: String,
	PasswordHash: String,
	DigestHa1Hash: String,
	Roles: 
	[
		String
	],
	Permissions: 
	[
		String
	],
	CreatedDate: 0001-01-01,
	ModifiedDate: 0001-01-01,
	InvalidLoginAttempts: 0,
	LastLoginAttempt: 0001-01-01,
	LockedDate: 0001-01-01,
	RecoveryToken: String,
	RefId: 0,
	RefIdStr: String,
	Meta: 
	{
		String: String
	}
}