<back to all web services
LoginUser
Login User actions.
The following routes are available for this service:| GET | /user/{userId} | Retrieve a User. | |
|---|
| POST | /user | Create a User. | |
|---|
| PUT | /user | Update a User. | |
|---|
| DELETE | /user/{userId}/delete | Delete a Login User. | |
|---|
TypeLoginUser Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| UserId | form | Guid | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Email | form | string | No | |
| FullName | form | string | No | |
| IsActive | form | bool | No | |
| CompanyId | form | Guid | No | |
| CompanyName | form | string | No | |
| CreatedOn | form | DateTime | No | |
| CreatedBy | form | Guid | No | |
| ModifiedOn | form | DateTime? | No | |
| ModifiedBy | form | Guid | No | |
| Comment | form | string | No | |
| Roles | form | string | No | |
| Company | form | TypeCompany | No | |
| UseTwoFactorAuth | form | bool | No | |
| PresharedKey | form | string | No | |
| Passcode | form | string | No | |
TypeCompany Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| CompanyId | form | Guid | No | |
| ParentCompanyId | form | string | No | |
| CompanyName | form | string | No | |
| Website | form | string | No | |
| CompanyNameShort | form | string | No | |
| IsReseller | form | bool | No | |
| SeparateInvoice | form | bool | No | |
| TypeCompanyStatusId | form | int | No | |
| ModifiedBy | form | Guid | No | |
| ModifiedDate | form | DateTime | No | |
| CreatedBy | form | string | No | |
| CreatedDate | form | DateTime | No | |
| ChannelCompanies | form | List<TypeCompany> | No | |
TypeCompany Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| CompanyId | form | Guid | No | |
| CompanyName | form | string | No | |
| Website | form | string | No | |
| CompanyNameShort | form | string | No | |
| IsReseller | form | bool | No | |
| TypeCompanyStatusId | form | int | No | |
| ModifiedBy | form | Guid | No | |
| ModifiedDate | form | DateTime | No | |
| CreatedBy | form | string | No | |
| CreatedDate | form | DateTime | 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 /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_CreatedBy_x003E_k__BackingField>String</_x003C_CreatedBy_x003E_k__BackingField>
<_x003C_CreatedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDate_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_CreatedBy_x003E_k__BackingField>String</_x003C_CreatedBy_x003E_k__BackingField>
<_x003C_CreatedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDate_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_CreatedBy_x003E_k__BackingField>String</_x003C_CreatedBy_x003E_k__BackingField>
<_x003C_CreatedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDate_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>