DokuWiki

It's better when it's simple

User Tools

Site Tools


playground:playground

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
playground:playground [2017-12-06 10:37] 101.100.171.100playground:playground [2024-04-18 09:14] (current) – [Table] 2a04:2747:7e04:8d00:888f:3cf8:8153:d32d
Line 1: Line 1:
-''**Users**''+== Basic text formatting == 
 +You can format the page using Wikitext special characters.
  
-[[playground:teste.html|test]]+{border="1" cellpadding="2" cellspacing="0" 
 +!width="1000"|What it looks like 
 +!width="500"|What you type 
 +
 +
 +You can ''italicize'' text by putting 2  
 +apostrophes on ''each'' side. 
  
-  * [[syntax#internal|User Object]] +3 apostrophes will '''bold''' the text. 
-  * [[syntax#internal|GET users]] +
-  * [[syntax#internal|GET users/:id]] +
-  * [[syntax#internal|GET users/me]] +
-  * [[syntax#internal|GET users/me/permissions]] +
-  * [[syntax#internal|GET users/:id/accounts]] +
-  * [[syntax#internal|POST users/new (will eventually be changed to 'POST users')]] +
-  * [[syntax#internal|PUT users/:id]] +
-  * [[syntax#internal|POST users/signup]] +
-  * [[syntax#internal|POST users/resetpassword]] +
-  * [[syntax#internal|POST users/password]]+
  
-''** User Object **'' 
  
-**''Description''**+5 apostrophes will '''''bold and italicize'''''  
 +the text.
  
-A direct user of the system. Could be an organization employee or customer.+(Using 4 apostrophes doesn't do anything 
 +special -- <br /> 3 of them '''bold''' the text as 
 +usual; the others are ''''just'''' apostrophes  
 +around the text.)
  
-''**Fields**''+
 +You can ''italicize'' text by putting 2  
 +apostrophes on ''each'' side. 
  
-^ Field       ^ Type      ^ Optional       ^ Subtypes      ^ Description       ^ +3 apostrophes will '''bold''' the text. 
-|    id                                |                                 | +
-|    email    |                          |                                 | +
-|  fist name  |                          |                                 | +
-|  last name  |                          |                                 | +
-|   address                            |                                 | +
-| organization|                          |                                 | +
-|  is owner                            |                                 |+
  
 +5 apostrophes will '''''bold and italicize''''' 
 +the text.
  
-**''JSON Sample''**+(Using 4 apostrophes doesn't do anything 
 +special -- <br /> 3 of them '''bold''' the text as 
 +usual; the others are ''''just'''' apostrophes  
 +around the text.) 
 +</syntaxhighlight> 
 +|- 
 +
 +A single newline 
 +generally has no effect on the layout. 
 +These can be used to separate 
 +sentences within a paragraph. 
 +Some editors find that this aids editing 
 +and improves the ''diff'' function 
 +(used internally to compare 
 +different versions of a page).
  
-{ +But an empty line 
-  "email" : "first.last@example.com", +starts a new paragraph.
-  "first_name" : "Doug", +
-  "last_name" : "Kurth", +
-  "user_type" : "Customer", +
-  "is_professional" : false, +
-  "id" : 12345, +
-  "is_active" : false +
-}+
  
 +When used in a list, a newline ''does'' affect the layout ([[#lists|see below]]).
 +|<syntaxhighlight lang=wikitext>
 +A single newline
 +generally has no effect on the layout.
 +These can be used to separate
 +sentences within a paragraph.
 +Some editors find that this aids editing
 +and improves the ''diff'' function
 +(used internally to compare
 +different versions of a page).
  
-**GET users**                                                               +But an empty line 
 +starts a new paragraph.
  
-**Description**                                                            +When used in a list, a newline ''does'' 
 +affect the layout ([[#lists|see below]]). 
 +</syntaxhighlight> 
 +
 +
 +You can break lines<br/> 
 +without a new paragraph.<br/> 
 +Please use this sparingly.
  
-Get the details for all users visible by the requester                                     +Please do not start a link or ''italics'' or '''bold''' text on one line and end on the next. 
 +|<syntaxhighlight lang=wikitext> 
 +You can break lines<br/> 
 +without a new paragraph.<br/> 
 +Please use this sparingly.
  
-**Resource URL**                                                             +Please do not start a link or 
-https://api.optionscity.com/users      +''italics'' or '''bold''' text on one line 
-                                       +and end on the next
-^Authentication   |Required           | +</syntaxhighlight> 
-^HTTP Methods   |GET                | +|-
-^Media Types   |application/json                     +
-^Response Object  |User               | +
-^Response Type   |Standard           | +
-          +
-**Parameters**+
  
-^Name     ^Description                                        ^Required? ^Type       ^ +|You should "sign" your comments on talk pages: <br/> 
-|page     |1-indexed page to retrieve. Default is 1.                |No         |Number     +<div class="mw-notalk"> 
-|per_page   |Number of entries returned per page. Default is 20.       |No              |Number     | +* Three tildes gives your signature: [[User:Example|Example]] <br/> 
-|email     |Get the user registered with this email address.        |No              |String     +* Four tildes give your signature plus date/time: [[User:Example|Example]] 07:46, 27 November 2005 (UTC) <br/> 
-|query     |Search for users matching this query by name              |No         |String     |+* Five tildes gives the date/time alone: 07:46, 27 November 2005 (UTC) <br/> 
 +</div> 
 +|<syntaxhighlight lang=wikitext> 
 + You should "sign" your comments  
 + on talk pages: 
 + * Three tildes gives your 
 + signature: ~~~ 
 + * Four tildes give your  
 + signature plus date/time: ~~~~ 
 + * Five tildes gives the  
 + date/time alone: ~~~~~ 
 +</syntaxhighlight> 
 +|}
  
-**Example Request** 
-GET https://api.optionscity.com/users 
- 
-**Example Response** 
- 
-[ { 
-  "email" : "first.last@example.com", 
-  "first_name" : "Doug", 
-  "last_name" : "Kurth", 
-  "user_type" : "Customer", 
-  "is_professional" : false, 
-  "id" : 12345, 
-  "is_active" : false 
-} ] 
playground/playground.1512553035.txt.gz · Last modified: 2017-12-06 10:37 by 101.100.171.100

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki