sfgboxapi

<back to all web services

RegisterPaidUser

The following routes are available for this service:
POST/registerpaiduser
RegisterPaidUser Parameters:
NameParameterData TypeRequiredDescription
GuidbodyGuidNo
PeriodbodyintNo
ReferencebodystringNo
PlanbodyintNo
ResponseStatusbodyResponseStatusNo
UserAuth Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
SaltformstringNo
PasswordHashformstringNo
DigestHa1HashformstringNo
RolesformList<string>No
PermissionsformList<string>No
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
InvalidLoginAttemptsformintNo
LastLoginAttemptformDateTime?No
LockedDateformDateTime?No
RecoveryTokenformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No

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

{
	guid: 00000000000000000000000000000000,
	period: 0,
	reference: String,
	plan: 0,
	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
	}
}