Net3 API Interface for Customer Portal

<back to all web services

LoginUser

Login User actions.

Requires Authentication
The following routes are available for this service:
GET/user/{userId}Retrieve a User.
POST/userCreate a User.
PUT/userUpdate a User.
DELETE/user/{userId}/deleteDelete a Login User.
TypeLoginUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
FullNameformstringNo
IsActiveformboolNo
CompanyIdformGuidNo
CompanyNameformstringNo
CreatedOnformDateTimeNo
CreatedByformGuidNo
ModifiedOnformDateTime?No
ModifiedByformGuidNo
CommentformstringNo
RolesformstringNo
CompanyformTypeCompanyNo
UseTwoFactorAuthformboolNo
PresharedKeyformstringNo
PasscodeformstringNo
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ParentCompanyIdformstringNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
SeparateInvoiceformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo
ChannelCompaniesformList<TypeCompany>No
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo

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

<LoginUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.DTO">
  <Comment xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Comment>
  <Company xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">
    <_x003C_ChannelCompanies_x003E_k__BackingField>
      <TypeCompany>
        <_x003C_ChannelCompanies_x003E_k__BackingField>
          <TypeCompany>
            <_x003C_ChannelCompanies_x003E_k__BackingField>
              <TypeCompany i:nil="true" />
            </_x003C_ChannelCompanies_x003E_k__BackingField>
            <_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
            <_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
            <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
            <_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
            <_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
            <_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
            <_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
            <_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
            <_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
            <_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
          </TypeCompany>
        </_x003C_ChannelCompanies_x003E_k__BackingField>
        <_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
        <_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
        <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
        <_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
        <_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
        <_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
        <_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
        <_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
        <_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
        <_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
      </TypeCompany>
    </_x003C_ChannelCompanies_x003E_k__BackingField>
    <_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
    <_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
    <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
    <_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
    <_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
    <_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
    <_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
    <_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
    <_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
    <_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
  </Company>
  <CompanyId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</CompanyName>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</CreatedBy>
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</CreatedOn>
  <Email xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Email>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</FirstName>
  <FullName xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</FullName>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</IsActive>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</LastName>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</ModifiedBy>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</ModifiedOn>
  <Passcode xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Passcode>
  <PresharedKey xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</PresharedKey>
  <Roles xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Roles>
  <UseTwoFactorAuth xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</UseTwoFactorAuth>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</UserId>
</LoginUser>