Changes

stoney core: REST API

5,058 bytes added, 18:39, 3 July 2014
/* Relationships */
==== Service Provider Person (SPP) Rights ====
A Service Provider Person can just about do anything. The following rights are unique for a Service Provider Person (SPP):* SPP.00: '''Create a reseller''': Can create a reseller.* SPP.01: '''Retrieve all resellers''': Can retrieve all resellers.* SPP.02: '''Retrieve a reseller''': Can retrieve a reseller.* SPP.03: '''Update a reseller:''' Can update a reseller.* SPP.04: '''Partly Update a reseller''': Can partly update a reseller.* SPP.05: '''Delete reseller''': Can delete a reseller (if no customers, people or services are linked to the reseller).* SPP.06: '''Create a person''': Can create a person (and make them a super user, an employee of one or more reseller(s) and an employee of one or more reseller(s)).* SPP.07: '''Retrieve all people''': Can retrieve all people.* SPP.08: '''Retrieve a person''': Can retrieve a person.* SPP.09: '''Update a person:''' Can update a person (including making them a super user, an employee of one or more reseller(s) and an employee of one or more reseller(s)).* SPP.10: '''Partly Update a person''': Can partly update a person.* SPP.11: '''Delete person''': Can delete a person (if no services are linked to the person).
SPP.0: '''Create === Reseller Employee (RE) ===Definition of a reseller'''Reseller Employee (RE): Can create a reseller.{| border="1" class="wikitable sortable"! API Attribute! LDAP Attribute! Example! Description|-
SPP.1: '''Retrieve all resellers''': Can retrieve all resellers.
SPP.2: '''Retrieve one reseller''': Can retrieve one reseller| id| uid| 4000003| Unique id of the person.|-
SPP| isActive| sstIsActive| true| Is the person active or not.3: '''Update a reseller:''' Can update a resellerOnly active people are allowed to authenticate themselves.|-
SPP.4: '''Partly Update a | belongsToResellerId| sstBelongsToResellerUID| 4000000| Shows the reseller''', that the person belongs to (only on reseller possible, 1: Can partly update a reseller1 relation).|-
| belongsToCustomerId| sstBelongsToCustomerUID| 4000001| Shows the customer, that the person belongs to (only on customer possible, 1:1 relation).|- | employeeOfId| sstEmployeeOfUID| 4000000| Shows the reseller (in this case), that the person is an employee of (multiple resellers possible, 1:N relation).|- | employeeOfId| sstEmployeeOfUID| 4000001| Shows the ustomer (in this case), that the person is an employee of (multiple customers possible, 1:N relation).|- |} ==== Reseller Employee (RE) Rights ====Sees the reseller they belong to, themselves, their own customers, people and their services. The following rights exist for a Reseller Employee (RE) and a Service Provider Person (SPP):* RE.500: '''Create a customer''': Can create a customer.* RE.01: '''Retrieve all customers''': Can retrieve all their customers.* RE.02: '''Retrieve a customer''': Can retrieve one of their customers.* RE.03: '''Update a customer:''' Can update one of their customers.* RE.04: '''Partly Update a customer''': Can partly update one of their customers.* RE.05: '''Delete resellercustomer''': Can delete one of their customers (if no people or services are linked to the customer). * RE.06: '''Create a person''': Can create a person (including making them an employee of their reseller (s) and of their customer(s)).* RE.07: '''Retrieve all people''': Can retrieve all their people (of their reseller(s) and their customer(s)).* RE.08: '''Retrieve a person''': Can retrieve one of their people (of their reseller(s) and their customer(s)).* RE.09: '''Update a person:''' Can update a person (including making them an employee of their reseller(s) and of their customer(s)).* RE.10: '''Partly Update a person''': Can partly update a person.* RE.11: '''Delete person''': Can delete a person (if no services are linked to the person). === Customer Employee (CE) ===Definition of a Customer Employee (CE):{| border="1" class="wikitable sortable"! API Attribute! LDAP Attribute! Example! Description|-  | id| uid| 4000004| Unique id of the person.|- | isActive| sstIsActive| true| Is the person active or not. Only active people are allowed to authenticate themselves.|- | belongsToResellerId| sstBelongsToResellerUID| 4000000| Shows the reseller, that the person belongs to (only on reseller possible, 1:1 relation).|- | belongsToCustomerId| sstBelongsToCustomerUID| 4000002| Shows the customer, that the person belongs to (only on customer possible, 1:1 relation).|- | employeeOfId| sstEmployeeOfUID| 4000002| Shows the ustomer (in this case), that the person is an employee of (multiple customerspossible, 1:N relation).|- |} ==== Customer Employee (RE) Rights ====Sees the customer they belong to, themselves, their own people or and their services. The following rights exist for a Customer Employee (RE), a Reseller Employee (RE) and a Service Provider Person (SPP):* CE.00: '''Retrieve some customers''': Can retrieve the customer(s) they are an employee of.* CE.01: '''Retrieve a customer''': Can retrieve one of the customer(s) they are an employee of.* CE.02: '''Update a customer:''' Can update one of the customer(s) they are an employee of.* CE.03: '''Partly Update a customer''': Can partly update one of the customer(s) they are an employee of. * CE.04: '''Create a person''': Can create a person (including making them an employee of their customer(s)).* CE.05: '''Retrieve all people''': Can retrieve all their people (of their customer(s)).* CE.06: '''Retrieve a person''': Can retrieve one of their people (of their customer(s)).* CE.07: '''Update a person:''' Can update a person (including making them an employee of their customer(s)).* CE.08: '''Partly Update a person''': Can partly update a person.* CE.09: '''Delete person''': Can delete a person (if no services are linked to the resellerperson).
= REST API documentation =
SLB, editor, reviewer
3,368
edits