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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"userId":"00000000000000000000000000000000","firstName":"String","lastName":"String","email":"String","fullName":"String","isActive":false,"companyId":"00000000000000000000000000000000","companyName":"String","createdOn":"\/Date(-62135596800000-0000)\/","createdBy":"00000000000000000000000000000000","modifiedOn":"\/Date(-62135596800000-0000)\/","modifiedBy":"00000000000000000000000000000000","comment":"String","roles":"String","company":{"companyId":"00000000000000000000000000000000","parentCompanyId":"String","companyName":"String","website":"String","companyNameShort":"String","isReseller":false,"separateInvoice":false,"typeCompanyStatusId":0,"modifiedBy":"00000000000000000000000000000000","modifiedDate":"\/Date(-62135596800000-0000)\/","channelCompanies":[{"companyId":"00000000000000000000000000000000","parentCompanyId":"String","companyName":"String","website":"String","companyNameShort":"String","isReseller":false,"separateInvoice":false,"typeCompanyStatusId":0,"modifiedBy":"00000000000000000000000000000000","modifiedDate":"\/Date(-62135596800000-0000)\/","channelCompanies":[{"companyId":"00000000000000000000000000000000","parentCompanyId":"String","companyName":"String","website":"String","companyNameShort":"String","isReseller":false,"separateInvoice":false,"typeCompanyStatusId":0,"modifiedBy":"00000000000000000000000000000000","modifiedDate":"\/Date(-62135596800000-0000)\/","channelCompanies":[{}]}]}]},"useTwoFactorAuth":false,"presharedKey":"String","passcode":"String"}