Net3 API Interface for Customer Portal

<back to all web services

Login

Retrieve the Login object.

The following routes are available for this service:
POST/loginOLD
Login Parameters:
NameParameterData TypeRequiredDescription
usernamebodystringNo
passwordbodystringNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
LoginResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeLoginNo
ResponseStatusformResponseStatusNo
TypeLogin Parameters:
NameParameterData TypeRequiredDescription
MembershipIdformintNo
UserIdformGuidNo
UsernameformstringNo
PasswordformstringNo
DatacenterURLformstringNo
LocationTypeformstringNo
LocationformstringNo
DatacenterLocationformDatacenterLocationsNo
ApplicationNameformstringNo
ApplicationIdformGuidNo
ApplicationLocationIdformGuidNo
CompanyNameformstringNo
CompanyIdformGuidNo
StatusformintNo
RightsformList<string>No
SessionIdformstringNo
RolesformList<string>No
PermissionsformList<string>No
AttributesformList<TypeMembershipAttribute>No
UseTwoFactorAuthformboolNo
PresharedKeyformstringNo
PasscodeformstringNo
IdformstringNo
FirstNameformstringNo
LastNameformstringNo
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
TypeMembershipAttribute Parameters:
NameParameterData TypeRequiredDescription
AttributeTypeformstringNo
AttributeValueformstringNo
AttributeDataTypeformstringNo

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

{
	username: String,
	password: String,
	sessionId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		membershipId: 0,
		userId: 00000000000000000000000000000000,
		username: String,
		password: String,
		datacenterURL: String,
		locationType: String,
		location: String,
		datacenterLocation: GMU,
		applicationName: String,
		applicationId: 00000000000000000000000000000000,
		applicationLocationId: 00000000000000000000000000000000,
		companyName: String,
		companyId: 00000000000000000000000000000000,
		status: 0,
		rights: 
		[
			String
		],
		sessionId: String,
		roles: 
		[
			String
		],
		permissions: 
		[
			String
		],
		attributes: 
		[
			{
				attributeType: String,
				attributeValue: String,
				attributeDataType: String
			}
		],
		useTwoFactorAuth: False,
		presharedKey: String,
		passcode: String,
		id: String,
		firstName: String,
		lastName: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}