| GET | /user/{userId} | Retrieve a User. | |
|---|---|---|---|
| POST | /user | Create a User. | |
| PUT | /user | Update a User. | |
| DELETE | /user/{userId}/delete | Delete a Login User. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | Guid | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| 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 |
| 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 |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
userId: 00000000000000000000000000000000,
firstName: String,
lastName: String,
email: String,
fullName: String,
isActive: False,
companyId: 00000000000000000000000000000000,
companyName: String,
createdOn: 0001-01-01,
createdBy: 00000000000000000000000000000000,
modifiedOn: 0001-01-01,
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: 0001-01-01,
createdBy: String,
createdDate: 0001-01-01,
channelCompanies:
[
{
companyId: 00000000000000000000000000000000,
parentCompanyId: String,
companyName: String,
website: String,
companyNameShort: String,
isReseller: False,
separateInvoice: False,
typeCompanyStatusId: 0,
modifiedBy: 00000000000000000000000000000000,
modifiedDate: 0001-01-01,
createdBy: String,
createdDate: 0001-01-01,
channelCompanies:
[
{
companyId: 00000000000000000000000000000000,
parentCompanyId: String,
companyName: String,
website: String,
companyNameShort: String,
isReseller: False,
separateInvoice: False,
typeCompanyStatusId: 0,
modifiedBy: 00000000000000000000000000000000,
modifiedDate: 0001-01-01,
createdBy: String,
createdDate: 0001-01-01,
channelCompanies:
[
{
}
]
}
]
}
]
},
useTwoFactorAuth: False,
presharedKey: String,
passcode: String
}