REL documentation
uiproperties users (http://api.3plcentral.com/rels/uiproperties/users)
Resource:
Collection: of user
C# Rel Const:
Rels.UiPropertySvc.UserList
URI template:
users{?pgsiz,pgnum,rql,sort,beginuserid,enduserid,right,provisioned}
Obtain URI from:
Billboard
A list of users (automatically limited by the logged-in user)
Success status: 200; Response is cacheable
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
beginuserid int DEPRECATED; DON'T USE; the first user to return from the sorted list; overrides pgsiz
enduserid int DEPRECATED; DON'T USE; the last user to return from the sorted list; overrides pgsiz
right string the name of a UiRight; to limit the result to users whose role(s) include the specified right
Type Description
TotalResults int
ResourceList IList<UIProperty.Models.User>
UserId int read only
CreationDate DateTime? ... read only
Deactivated bool read only
Name 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
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/uiproperties/user": [
      {
        "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
      }
    ]
  }
}
Create a new user
Success status: 201; ETag response header supplied
Name Data Type Description
provisioned bool directive to create the user in a provisioned state, default value is true
Type Description
UserId int read only
CreationDate DateTime? ... read only
Deactivated bool read only
Name 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
 
{
  "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
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
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.