Provisioning Management » History » Version 6
Eric Vieillevigne, 05/12/2015 03:44 PM
| 1 | 1 | Eric Vieillevigne | {{>toc}} |
|---|---|---|---|
| 2 | |||
| 3 | h1. Provisioning Management |
||
| 4 | 2 | Eric Vieillevigne | |
| 5 | Provisionning Management allows a thirdParty Application to create, update, delete an account of FamilyWall, Set the member profile right, set member premium type and select/update the services enable for such user. |
||
| 6 | |||
| 7 | h2. Search User - _provsearch_ |
||
| 8 | |||
| 9 | This method returns the accountId of a Valid user by Identifiers (email, login or MSISDN) |
||
| 10 | |||
| 11 | 4 | Eric Vieillevigne | By sending an HTTP request http://devserver/api/prov/search?identifier=test@gmail.com |
| 12 | 2 | Eric Vieillevigne | |
| 13 | *Parameters*: |
||
| 14 | |||
| 15 | |*Name*|*Type*|*Description*| |
||
| 16 | |email|String|Email identifier| |
||
| 17 | |MSISDN|String|internationalized 10 digits number| |
||
| 18 | |login|String|login of a valid account| |
||
| 19 | |||
| 20 | *Response*: |
||
| 21 | <pre><code class="javascript"> |
||
| 22 | { |
||
| 23 | "a01":{ |
||
| 24 | "r":{ |
||
| 25 | "r":"12345" |
||
| 26 | }, |
||
| 27 | "cn":"provsearch" |
||
| 28 | } |
||
| 29 | } |
||
| 30 | </code></pre> |
||
| 31 | The Method response is a *Long* which represents the _AccountId_ of the account searched. |
||
| 32 | |||
| 33 | In case, the method encounter any error, the response is an exception with specific parameters detailed below. |
||
| 34 | |||
| 35 | *Error*: |
||
| 36 | |||
| 37 | |*Error Code*|*Type*|*Value*|*Description*| |
||
| 38 | |FizApiAccIdentifierInvalidException |Ex|21|User does not exist| |
||
| 39 | 3 | Eric Vieillevigne | |
| 40 | |||
| 41 | 5 | Eric Vieillevigne | h2. Create Family - _provcreatefamily_ |
| 42 | 3 | Eric Vieillevigne | |
| 43 | 4 | Eric Vieillevigne | This method create a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...) |
| 44 | 3 | Eric Vieillevigne | |
| 45 | By sending an HTTP request http://devserver/api/prov/createfamily |
||
| 46 | |||
| 47 | *Parameters*: |
||
| 48 | |||
| 49 | |*Name*|*Type*|*Description*| |
||
| 50 | |FamilyName|String|Name of the Family| |
||
| 51 | |Family Image|file|Binary file of Family image| |
||
| 52 | 4 | Eric Vieillevigne | |Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)| |
| 53 | 3 | Eric Vieillevigne | |Calendar_Service|Boolean|Default true| |
| 54 | |Location_Service|Boolean|Default true| |
||
| 55 | |Message_Service|Boolean|Default true| |
||
| 56 | |Photo_Service|Boolean|Default true| |
||
| 57 | |Video_Service|Boolean|Default true| |
||
| 58 | |Audio_Service|Boolean|Default true| |
||
| 59 | |Task_Service|Boolean|Default true| |
||
| 60 | |Calendar_Service|Boolean|Default true| |
||
| 61 | |||
| 62 | |||
| 63 | *Response*: |
||
| 64 | <pre><code class="javascript"> |
||
| 65 | { |
||
| 66 | "a01":{ |
||
| 67 | "r":{ |
||
| 68 | "r":"12345" |
||
| 69 | }, |
||
| 70 | 4 | Eric Vieillevigne | "cn":"provcreatefamily" |
| 71 | 3 | Eric Vieillevigne | } |
| 72 | } |
||
| 73 | </code></pre> |
||
| 74 | 4 | Eric Vieillevigne | The Method response is a *Long* which represents the _FamilyId_ of the familycreated. |
| 75 | 3 | Eric Vieillevigne | |
| 76 | 1 | Eric Vieillevigne | In case, the method encounter any error, the response is an exception with specific parameters detailed below. |
| 77 | 3 | Eric Vieillevigne | |
| 78 | *Error*: |
||
| 79 | |||
| 80 | |*Error Code*|*Type*|*Value*|*Description*| |
||
| 81 | 6 | Eric Vieillevigne | |AFizApiUnattendedException|Ex|21|Unknown exception| |