Net3 API Interface for Customer Portal

Recovery

The following routes are available for this service:
POST	/brs/links	Retrieve list of BRS links for self-service portal access.

**Recovery** Parameters:
Name	Parameter	Data Type	Required	Description
orgs	body	List<TypeOrg>	No
companyIdentifiers	body	List<TypeCompanyIdentifier>	No

**TypeOrg** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
name	form	string	No
type	form	string	No
DatacenterLocation	form	DatacenterLocations	No
modifydate	form	string	No
description	form	string	No
createdate	form	string	No
Networks	form	List<TypeNetworkConfiguration>	No

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

**TypeNetworkConfiguration** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
name	form	string	No
type	form	string	No
Description	form	string	No
Configuration	form	Configuration	No
ProviderInfo	form	string	No

**Configuration** Parameters:
Name	Parameter	Data Type	Required
IpScopes	form	List<IpScope>	No
FenceMode	form	string	No
RetainNetInfoAcrossDeployments	form	bool	No
BackwardCompatibilityMode	form	bool	No
SubInterface	form	bool	No
DistributedInterface	form	bool	No
GuestVlanAllowed	form	bool	No
Connected	form	bool	No
DualStackNetwork	form	bool	No

**IpScope** Parameters:
Name	Parameter	Data Type	Required
IsInherited	form	bool	No
Gateway	form	string	No
Netmask	form	string	No
Dns1	form	string	No
Dns2	form	string	No
DnsSuffix	form	string	No
IsEnabled	form	bool	No
IpRanges	form	List<IpRange>	No

**IpRange** Parameters:
Name	Parameter	Data Type	Required	Description
StartAddress	form	string	No
EndAddress	form	string	No

**TypeCompanyIdentifier** Parameters:
Name	Parameter	Data Type	Required
CompanyIdentifierId	form	int	No
CompanyId	form	Guid	No
LocationId	form	Guid	No
ApplicationId	form	Guid	No
OrgName	form	string	No
OrgUserName	form	string	No
OrgIdentifier	form	string	No
IsRemote	form	bool	No
ApplicationName	form	string	No
CompanyName	form	string	No
Location	form	string	No
LocationType	form	string	No
DatacenterCode	form	string	No
DatacenterName	form	string	No
CompanyNameShort	form	string	No

**RecoveryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	Object	No
ResponseStatus	form	ResponseStatus	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 /brs/links HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orgs: 
	[
		{
			href: String,
			id: String,
			name: String,
			type: String,
			datacenterLocation: GMU,
			modifydate: String,
			description: String,
			createdate: String,
			networks: 
			[
				{
					href: String,
					id: String,
					name: String,
					type: String,
					description: String,
					configuration: 
					{
						ipScopes: 
						[
							{
								isInherited: False,
								gateway: String,
								netmask: String,
								dns1: String,
								dns2: String,
								dnsSuffix: String,
								isEnabled: False,
								ipRanges: 
								[
									{
										startAddress: String,
										endAddress: String
									}
								]
							}
						],
						fenceMode: String,
						retainNetInfoAcrossDeployments: False,
						backwardCompatibilityMode: False,
						subInterface: False,
						distributedInterface: False,
						guestVlanAllowed: False,
						connected: False,
						dualStackNetwork: False
					},
					providerInfo: String
				}
			]
		}
	],
	companyIdentifiers: 
	[
		{
			companyIdentifierId: 0,
			companyId: 00000000000000000000000000000000,
			locationId: 00000000000000000000000000000000,
			applicationId: 00000000000000000000000000000000,
			orgName: String,
			orgUserName: String,
			orgIdentifier: String,
			isRemote: False,
			applicationName: String,
			companyName: String,
			location: String,
			locationType: String,
			datacenterCode: String,
			datacenterName: String,
			companyNameShort: String
		}
	]
}

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

{
	result: {},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}