Net3 API Interface for Customer Portal

ComputeStats

The following routes are available for this service:
POST	/compute/stats/{userId}/{datacenterLocation}/{vmid}

**ComputeStats** Parameters:
Name	Parameter	Data Type	Required	Description
vmid	path	string	No
datacenterLocation	path	string	No	Allowable Values GMU SPA LAS DEV VCD AWS GCP UAT AZU AUV ATL

**ComputeBase** Parameters:
Name	Parameter	Data Type	Required
userId	form	string	No
logins	form	List<TypeLogin>	No
sessionId	form	string	No

**TypeLogin** Parameters:
Name	Parameter	Data Type	Required
MembershipId	form	int	No
UserId	form	Guid	No
Username	form	string	No
Password	form	string	No
DatacenterURL	form	string	No
LocationType	form	string	No
Location	form	string	No
DatacenterLocation	form	DatacenterLocations	No
ApplicationName	form	string	No
ApplicationId	form	Guid	No
ApplicationLocationId	form	Guid	No
CompanyName	form	string	No
CompanyId	form	Guid	No
Status	form	int	No
Rights	form	List<string>	No
SessionId	form	string	No
Roles	form	List<string>	No
Permissions	form	List<string>	No
Attributes	form	List<TypeMembershipAttribute>	No
UseTwoFactorAuth	form	bool	No
PresharedKey	form	string	No
Passcode	form	string	No
Id	form	string	No
FirstName	form	string	No
LastName	form	string	No

**DatacenterLocations** Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL

**TypeMembershipAttribute** Parameters:
Name	Parameter	Data Type	Required
AttributeType	form	string	No
AttributeValue	form	string	No
AttributeDataType	form	string	No

**ComputeStatsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	CurrentUsage	No
ResponseStatus	form	ResponseStatus	No

**CurrentUsage** Parameters:
Name	Parameter	Data Type	Required	Description
Link	form	CurrentUsageLink	No
Metric	form	List<CurrentUsageMetric>	No

**CurrentUsageLink** Parameters:
Name	Parameter	Data Type	Required
rel	form	string	No
href	form	string	No
type	form	string	No

**CurrentUsageMetric** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
unit	form	string	No
value	form	decimal	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 /compute/stats/{userId}/{datacenterLocation}/{vmid} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	vmid: String,
	datacenterLocation: String,
	userId: String,
	logins: 
	[
		{
			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
		}
	],
	sessionId: String
}

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

{
	result: 
	{
		link: 
		{
			rel: String,
			href: String,
			type: String
		},
		metric: 
		[
			{
				name: String,
				unit: String,
				value: 0
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Net3 API Interface for Customer Portal

ComputeStats

Allowable Values

HTTP + JSV