Net3 API Interface for Customer Portal

<back to all web services

PostUserSCS

Post Tenant SCS User

Requires Authentication
The following routes are available for this service:
POST/backup/backupcustomer/user/scs
PostUserSCS Parameters:
NameParameterData TypeRequiredDescription
locationbodystringYesURL for underlying backup system
postUserbodyPostUserNoUser
environmentbodyN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
PostUser Parameters:
NameParameterData TypeRequiredDescription
locationformstringYesURL for underlying backup system
postUserformPostUserNoUser
environmentformN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
PostUserSCSResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<User>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo
User Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
versionformintNo
tenant_idformstringNo
created_atformDateTimeNo
updated_atformDateTimeNo
deleted_atformObjectNo
access_policiesformList<Access_Policies>No
personal_tenant_idformstringNo
loginformstringNo
enabledformboolNo
contactformTenantContactNo
activatedformboolNo
languageformstringNo
business_typesformList<string>No
notificationsformList<string>No
idp_idformstringNo
external_idformstringNo
mfa_statusformstringNo
Access_Policies Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
issuer_idformstringNo
trustee_idformstringNo
trustee_typeformstringNo
tenant_idformstringNo
role_idformstringNo
created_atformDateTimeNo
updated_atformDateTimeNo
deleted_atformObjectNo
versionformintNo
TenantContact Parameters:
NameParameterData TypeRequiredDescription
aanformObjectNo
stateformstringNo
zipcodeformstringNo
lastnameformstringNo
address2formstringNo
industryformstringNo
email_confirmedformObjectNo
created_atformDateTimeNo
cityformstringNo
emailformstringNo
address1formstringNo
phoneformstringNo
updated_atformDateTimeNo
organization_sizeformstringNo
websiteformstringNo
idformstringNo
firstnameformstringNo
titleformstringNo
countryformstringNo
faxformstringNo
languageformstringNo
typesformList<string>No

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 /backup/backupcustomer/user/scs HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostUserSCS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <environment>DEV</environment>
  <location>String</location>
  <postUser xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.BackupCustomer.Backup">
    <d2p1:business_types xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:business_types>
    <d2p1:contact>
      <d2p1:aan />
      <d2p1:address1>String</d2p1:address1>
      <d2p1:address2>String</d2p1:address2>
      <d2p1:city>String</d2p1:city>
      <d2p1:country>String</d2p1:country>
      <d2p1:created_at>0001-01-01T00:00:00</d2p1:created_at>
      <d2p1:email>String</d2p1:email>
      <d2p1:email_confirmed />
      <d2p1:fax>String</d2p1:fax>
      <d2p1:firstname>String</d2p1:firstname>
      <d2p1:id>String</d2p1:id>
      <d2p1:industry>String</d2p1:industry>
      <d2p1:language>String</d2p1:language>
      <d2p1:lastname>String</d2p1:lastname>
      <d2p1:organization_size>String</d2p1:organization_size>
      <d2p1:phone>String</d2p1:phone>
      <d2p1:state>String</d2p1:state>
      <d2p1:title>String</d2p1:title>
      <d2p1:types xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:types>
      <d2p1:updated_at>0001-01-01T00:00:00</d2p1:updated_at>
      <d2p1:website>String</d2p1:website>
      <d2p1:zipcode>String</d2p1:zipcode>
    </d2p1:contact>
    <d2p1:enabled>false</d2p1:enabled>
    <d2p1:language>String</d2p1:language>
    <d2p1:login>String</d2p1:login>
    <d2p1:notifications xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:notifications>
    <d2p1:tenant_id>String</d2p1:tenant_id>
  </postUser>
</PostUserSCS>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostUserSCSResponse 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:access_policies>
        <d3p1:Access_Policies>
          <d3p1:created_at>0001-01-01T00:00:00</d3p1:created_at>
          <d3p1:deleted_at />
          <d3p1:id>String</d3p1:id>
          <d3p1:issuer_id>String</d3p1:issuer_id>
          <d3p1:role_id>String</d3p1:role_id>
          <d3p1:tenant_id>String</d3p1:tenant_id>
          <d3p1:trustee_id>String</d3p1:trustee_id>
          <d3p1:trustee_type>String</d3p1:trustee_type>
          <d3p1:updated_at>0001-01-01T00:00:00</d3p1:updated_at>
          <d3p1:version>0</d3p1:version>
        </d3p1:Access_Policies>
      </d3p1:access_policies>
      <d3p1:activated>false</d3p1:activated>
      <d3p1:business_types xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:business_types>
      <d3p1:contact>
        <d3p1:aan />
        <d3p1:address1>String</d3p1:address1>
        <d3p1:address2>String</d3p1:address2>
        <d3p1:city>String</d3p1:city>
        <d3p1:country>String</d3p1:country>
        <d3p1:created_at>0001-01-01T00:00:00</d3p1:created_at>
        <d3p1:email>String</d3p1:email>
        <d3p1:email_confirmed />
        <d3p1:fax>String</d3p1:fax>
        <d3p1:firstname>String</d3p1:firstname>
        <d3p1:id>String</d3p1:id>
        <d3p1:industry>String</d3p1:industry>
        <d3p1:language>String</d3p1:language>
        <d3p1:lastname>String</d3p1:lastname>
        <d3p1:organization_size>String</d3p1:organization_size>
        <d3p1:phone>String</d3p1:phone>
        <d3p1:state>String</d3p1:state>
        <d3p1:title>String</d3p1:title>
        <d3p1:types xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:types>
        <d3p1:updated_at>0001-01-01T00:00:00</d3p1:updated_at>
        <d3p1:website>String</d3p1:website>
        <d3p1:zipcode>String</d3p1:zipcode>
      </d3p1:contact>
      <d3p1:created_at>0001-01-01T00:00:00</d3p1:created_at>
      <d3p1:deleted_at />
      <d3p1:enabled>false</d3p1:enabled>
      <d3p1:external_id>String</d3p1:external_id>
      <d3p1:id>String</d3p1:id>
      <d3p1:idp_id>String</d3p1:idp_id>
      <d3p1:language>String</d3p1:language>
      <d3p1:login>String</d3p1:login>
      <d3p1:mfa_status>String</d3p1:mfa_status>
      <d3p1:notifications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:notifications>
      <d3p1:personal_tenant_id>String</d3p1:personal_tenant_id>
      <d3p1:tenant_id>String</d3p1:tenant_id>
      <d3p1:updated_at>0001-01-01T00:00:00</d3p1:updated_at>
      <d3p1:version>0</d3p1:version>
    </d2p1:Result>
  </Result>
</PostUserSCSResponse>