Net3 API Interface for Customer Portal

<back to all web services

LoginUser

Login User actions.

Requires Authentication
The following routes are available for this service:
GET/user/{userId}Retrieve a User.
POST/userCreate a User.
PUT/userUpdate a User.
DELETE/user/{userId}/deleteDelete a Login User.
TypeLoginUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
FullNameformstringNo
IsActiveformboolNo
CompanyIdformGuidNo
CompanyNameformstringNo
CreatedOnformDateTimeNo
CreatedByformGuidNo
ModifiedOnformDateTime?No
ModifiedByformGuidNo
CommentformstringNo
RolesformstringNo
CompanyformTypeCompanyNo
UseTwoFactorAuthformboolNo
PresharedKeyformstringNo
PasscodeformstringNo
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ParentCompanyIdformstringNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
SeparateInvoiceformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo
ChannelCompaniesformList<TypeCompany>No
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo

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 /user HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userId: 00000000000000000000000000000000,
	firstName: String,
	lastName: String,
	email: String,
	fullName: String,
	isActive: False,
	companyId: 00000000000000000000000000000000,
	companyName: String,
	createdOn: 0001-01-01,
	createdBy: 00000000000000000000000000000000,
	modifiedOn: 0001-01-01,
	modifiedBy: 00000000000000000000000000000000,
	comment: String,
	roles: String,
	company: 
	{
		companyId: 00000000000000000000000000000000,
		parentCompanyId: String,
		companyName: String,
		website: String,
		companyNameShort: String,
		isReseller: False,
		separateInvoice: False,
		typeCompanyStatusId: 0,
		modifiedBy: 00000000000000000000000000000000,
		modifiedDate: 0001-01-01,
		channelCompanies: 
		[
			{
				companyId: 00000000000000000000000000000000,
				parentCompanyId: String,
				companyName: String,
				website: String,
				companyNameShort: String,
				isReseller: False,
				separateInvoice: False,
				typeCompanyStatusId: 0,
				modifiedBy: 00000000000000000000000000000000,
				modifiedDate: 0001-01-01,
				channelCompanies: 
				[
					{
						companyId: 00000000000000000000000000000000,
						parentCompanyId: String,
						companyName: String,
						website: String,
						companyNameShort: String,
						isReseller: False,
						separateInvoice: False,
						typeCompanyStatusId: 0,
						modifiedBy: 00000000000000000000000000000000,
						modifiedDate: 0001-01-01,
						channelCompanies: 
						[
							{
								
							}
						]
					}
				]
			}
		]
	},
	useTwoFactorAuth: False,
	presharedKey: String,
	passcode: String
}