Net3 API Interface for Customer Portal

<back to all web services

Recovery

Requires Authentication
The following routes are available for this service:
POST/brs/linksRetrieve list of BRS links for self-service portal access.
Recovery Parameters:
NameParameterData TypeRequiredDescription
orgsbodyList<TypeOrg>No
companyIdentifiersbodyList<TypeCompanyIdentifier>No
TypeOrg Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
nameformstringNo
typeformstringNo
DatacenterLocationformDatacenterLocationsNo
modifydateformstringNo
descriptionformstringNo
createdateformstringNo
NetworksformList<TypeNetworkConfiguration>No
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
TypeNetworkConfiguration Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
nameformstringNo
typeformstringNo
DescriptionformstringNo
ConfigurationformConfigurationNo
ProviderInfoformstringNo
Configuration Parameters:
NameParameterData TypeRequiredDescription
IpScopesformList<IpScope>No
FenceModeformstringNo
RetainNetInfoAcrossDeploymentsformboolNo
BackwardCompatibilityModeformboolNo
SubInterfaceformboolNo
DistributedInterfaceformboolNo
GuestVlanAllowedformboolNo
ConnectedformboolNo
DualStackNetworkformboolNo
IpScope Parameters:
NameParameterData TypeRequiredDescription
IsInheritedformboolNo
GatewayformstringNo
NetmaskformstringNo
Dns1formstringNo
Dns2formstringNo
DnsSuffixformstringNo
IsEnabledformboolNo
IpRangesformList<IpRange>No
IpRange Parameters:
NameParameterData TypeRequiredDescription
StartAddressformstringNo
EndAddressformstringNo
TypeCompanyIdentifier Parameters:
NameParameterData TypeRequiredDescription
CompanyIdentifierIdformintNo
CompanyIdformGuidNo
LocationIdformGuidNo
ApplicationIdformGuidNo
OrgNameformstringNo
OrgUserNameformstringNo
OrgIdentifierformstringNo
IsRemoteformboolNo
ApplicationNameformstringNo
CompanyNameformstringNo
LocationformstringNo
LocationTypeformstringNo
DatacenterCodeformstringNo
DatacenterNameformstringNo
CompanyNameShortformstringNo
RecoveryResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformObjectNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Recovery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <companyIdentifiers xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:TypeCompanyIdentifier>
      <d2p1:_x003C_ApplicationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ApplicationId_x003E_k__BackingField>
      <d2p1:_x003C_ApplicationName_x003E_k__BackingField>String</d2p1:_x003C_ApplicationName_x003E_k__BackingField>
      <d2p1:_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_CompanyId_x003E_k__BackingField>
      <d2p1:_x003C_CompanyIdentifierId_x003E_k__BackingField>0</d2p1:_x003C_CompanyIdentifierId_x003E_k__BackingField>
      <d2p1:_x003C_CompanyNameShort_x003E_k__BackingField>String</d2p1:_x003C_CompanyNameShort_x003E_k__BackingField>
      <d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
      <d2p1:_x003C_DatacenterCode_x003E_k__BackingField>String</d2p1:_x003C_DatacenterCode_x003E_k__BackingField>
      <d2p1:_x003C_DatacenterName_x003E_k__BackingField>String</d2p1:_x003C_DatacenterName_x003E_k__BackingField>
      <d2p1:_x003C_IsRemote_x003E_k__BackingField>false</d2p1:_x003C_IsRemote_x003E_k__BackingField>
      <d2p1:_x003C_LocationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_LocationId_x003E_k__BackingField>
      <d2p1:_x003C_LocationType_x003E_k__BackingField>String</d2p1:_x003C_LocationType_x003E_k__BackingField>
      <d2p1:_x003C_Location_x003E_k__BackingField>String</d2p1:_x003C_Location_x003E_k__BackingField>
      <d2p1:_x003C_OrgIdentifier_x003E_k__BackingField>String</d2p1:_x003C_OrgIdentifier_x003E_k__BackingField>
      <d2p1:_x003C_OrgName_x003E_k__BackingField>String</d2p1:_x003C_OrgName_x003E_k__BackingField>
      <d2p1:_x003C_OrgUserName_x003E_k__BackingField>String</d2p1:_x003C_OrgUserName_x003E_k__BackingField>
    </d2p1:TypeCompanyIdentifier>
  </companyIdentifiers>
  <orgs xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:TypeOrg>
      <d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>GMU</d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>
      <d2p1:_x003C_Networks_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models.NetworkConfiguration">
        <d4p1:TypeNetworkConfiguration>
          <d4p1:Configuration>
            <d4p1:BackwardCompatibilityMode>false</d4p1:BackwardCompatibilityMode>
            <d4p1:Connected>false</d4p1:Connected>
            <d4p1:DistributedInterface>false</d4p1:DistributedInterface>
            <d4p1:DualStackNetwork>false</d4p1:DualStackNetwork>
            <d4p1:FenceMode>String</d4p1:FenceMode>
            <d4p1:GuestVlanAllowed>false</d4p1:GuestVlanAllowed>
            <d4p1:IpScopes>
              <d4p1:IpScope>
                <d4p1:Dns1>String</d4p1:Dns1>
                <d4p1:Dns2>String</d4p1:Dns2>
                <d4p1:DnsSuffix>String</d4p1:DnsSuffix>
                <d4p1:Gateway>String</d4p1:Gateway>
                <d4p1:IpRanges>
                  <d4p1:IpRange>
                    <d4p1:EndAddress>String</d4p1:EndAddress>
                    <d4p1:StartAddress>String</d4p1:StartAddress>
                  </d4p1:IpRange>
                </d4p1:IpRanges>
                <d4p1:IsEnabled>false</d4p1:IsEnabled>
                <d4p1:IsInherited>false</d4p1:IsInherited>
                <d4p1:Netmask>String</d4p1:Netmask>
              </d4p1:IpScope>
            </d4p1:IpScopes>
            <d4p1:RetainNetInfoAcrossDeployments>false</d4p1:RetainNetInfoAcrossDeployments>
            <d4p1:SubInterface>false</d4p1:SubInterface>
          </d4p1:Configuration>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:ProviderInfo>String</d4p1:ProviderInfo>
          <d4p1:href>String</d4p1:href>
          <d4p1:id>String</d4p1:id>
          <d4p1:name>String</d4p1:name>
          <d4p1:type>String</d4p1:type>
        </d4p1:TypeNetworkConfiguration>
      </d2p1:_x003C_Networks_x003E_k__BackingField>
      <d2p1:_x003C_createdate_x003E_k__BackingField>String</d2p1:_x003C_createdate_x003E_k__BackingField>
      <d2p1:_x003C_description_x003E_k__BackingField>String</d2p1:_x003C_description_x003E_k__BackingField>
      <d2p1:_x003C_href_x003E_k__BackingField>String</d2p1:_x003C_href_x003E_k__BackingField>
      <d2p1:_x003C_id_x003E_k__BackingField>String</d2p1:_x003C_id_x003E_k__BackingField>
      <d2p1:_x003C_modifydate_x003E_k__BackingField>String</d2p1:_x003C_modifydate_x003E_k__BackingField>
      <d2p1:_x003C_name_x003E_k__BackingField>String</d2p1:_x003C_name_x003E_k__BackingField>
      <d2p1:_x003C_type_x003E_k__BackingField>String</d2p1:_x003C_type_x003E_k__BackingField>
    </d2p1:TypeOrg>
  </orgs>
</Recovery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecoveryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result />
</RecoveryResponse>