Net3 API Interface for Customer Portal

<back to all web services

TenantUsers

Retrieve list of Tenant Users

Requires Authentication
The following routes are available for this service:
GET/backup/backupcustomer/tenantUsers
TenantUsers Parameters:
NameParameterData TypeRequiredDescription
locationquerystringYesURL for underlying backup system
uuidquerystringYesUUID of Tenant
environmentqueryN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
TenantUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<TenantUsers>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo

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.

GET /backup/backupcustomer/tenantUsers HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TenantUsersResponse 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Common">
    <d2p1:Exception xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL i:nil="true" xmlns="" />
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">-2146233088</HResult>
      <Source i:nil="true" xmlns="" />
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:HasError>false</d2p1:HasError>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:Result xmlns:d3p1="http://schemas.datacontract.org/2004/07/N3TEntities.BackupCustomer.Backup">
      <d3p1:items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:items>
    </d2p1:Result>
  </Result>
</TenantUsersResponse>