Type
Description
UserId
int
read only
CreationDate
DateTime?
read only
Deactivated
bool
read only
Name
string
Login
string
NewPassword
string
To be used for POST or PUT (to change existing password); null on GET
HintPhrase
string
LastLoginDate
DateTime?
V1Role
string
EmailConfirmed
bool
Email
string
CellPhone
string
CellCarrierIdentifier
Generic.Models.CellCarrierIdentifier
Name
string
Id
int
UiRoleIdentifiers
IEnumerable<Generic.Models.UiRoleIdentifier>
names and ids refer to custom or system roles
Name
string
Id
int
FacilityIdentifiers
IEnumerable<Generic.Models.FacilityIdentifier>
Name
string
Id
int
CustomerIdentifiers
IEnumerable<Generic.Models.CustomerIdentifier>
distinct union of UserLogin.CustomerId + UserCustomer.CustomerId
if CustomerIdentifiers.Any() then this is a so-called customer user
ExternalId
string
Name
string
Id
int
CanInvoiceTransactions
bool
CanAccessAllFacilities
bool
Provisioned
bool
supplied on GET; ignored on POST and PUT
HasCustomers
bool
Sample content-type: application/hal+json
Copy to clipboard
copied
{
"userId": 1 ,
"creationDate": "2016-12-25T23:00:00" ,
"deactivated": true ,
"name": "str" ,
"login": "str" ,
"newPassword": "str" ,
"hintPhrase": "str" ,
"lastLoginDate": "2016-12-25T23:00:00" ,
"v1Role": "str" ,
"emailConfirmed": true ,
"email": "str" ,
"cellPhone": "str" ,
"cellCarrierIdentifier": {
"name": "str" ,
"id": 2
},
"uiRoleIdentifiers": [
{
"name": "str" ,
"id": 2
}
],
"facilityIdentifiers": [
{
"name": "str" ,
"id": 2
}
],
"customerIdentifiers": [
{
"externalId": "str" ,
"name": "str" ,
"id": 3
}
],
"canInvoiceTransactions": true ,
"canAccessAllFacilities": true ,
"provisioned": true ,
"hasCustomers": true
}
Type
Description
UserId
int
read only
CreationDate
DateTime?
read only
Deactivated
bool
read only
Name
string
Login
string
NewPassword
string
To be used for POST or PUT (to change existing password); null on GET
HintPhrase
string
LastLoginDate
DateTime?
V1Role
string
EmailConfirmed
bool
Email
string
CellPhone
string
CellCarrierIdentifier
Generic.Models.CellCarrierIdentifier
Name
string
Id
int
UiRoleIdentifiers
IEnumerable<Generic.Models.UiRoleIdentifier>
names and ids refer to custom or system roles
Name
string
Id
int
FacilityIdentifiers
IEnumerable<Generic.Models.FacilityIdentifier>
Name
string
Id
int
CustomerIdentifiers
IEnumerable<Generic.Models.CustomerIdentifier>
distinct union of UserLogin.CustomerId + UserCustomer.CustomerId
if CustomerIdentifiers.Any() then this is a so-called customer user
ExternalId
string
Name
string
Id
int
CanInvoiceTransactions
bool
CanAccessAllFacilities
bool
Provisioned
bool
supplied on GET; ignored on POST and PUT
HasCustomers
bool
Links
IList<WebApi.Hal.Link>
-
edit
-
/rels/customers/customerlogo
Sample accept: application/hal+json
{
"userId": 1 ,
"creationDate": "2016-12-25T23:00:00" ,
"deactivated": true ,
"name": "str" ,
"login": "str" ,
"newPassword": "str" ,
"hintPhrase": "str" ,
"lastLoginDate": "2016-12-25T23:00:00" ,
"v1Role": "str" ,
"emailConfirmed": true ,
"email": "str" ,
"cellPhone": "str" ,
"cellCarrierIdentifier": {
"name": "str" ,
"id": 2
},
"uiRoleIdentifiers": [
{
"name": "str" ,
"id": 2
}
],
"facilityIdentifiers": [
{
"name": "str" ,
"id": 2
}
],
"customerIdentifiers": [
{
"externalId": "str" ,
"name": "str" ,
"id": 3
}
],
"canInvoiceTransactions": true ,
"canAccessAllFacilities": true ,
"provisioned": true ,
"hasCustomers": true
}