REL documentation
master logins (http://api.3plcentral.com/rels/master/logins)
Resource:
Collection: of login
C# Rel Const:
Rels.MasterSvc.Logins
URI template:
logins{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a list of logins
Success status: 200
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
Type Description
TotalResults int
ResourceList IList<Master.Models.Login>
User string
NewPassword string
Deactivated bool
Links IList<WebApi.Hal.Link>
- edit
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/master/login": [
      {
        "user": "str",
        "newPassword": "str",
        "deactivated": true
      }
    ]
  }
}
Create a new login
Success status: 201; ETag response header supplied
none
Type Description
User string
NewPassword string
Deactivated bool
Sample content-type: application/hal+json
 
{
  "user": "str",
  "newPassword": "str",
  "deactivated": true
}
Type Description
User string
NewPassword string
Deactivated bool
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "user": "str",
  "newPassword": "str",
  "deactivated": 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.