MyService documentation

Types

class FancyValue

A person description

JSON Sample
{
    "age": 27, 
    "computed": "Hello!", 
    "name": "Rimbaud"
}
XML sample
<fancyvalue>
  <age>27</age>
  <computed>Hello!</computed>
  <name>Rimbaud</name>
</fancyvalue>
age

The age

type: integer

computed

A computed property

type: string

name

The name

type: unicode

Functions

Root Namespace

Path
/api/

Basic functions

times2(value) → integer
JSON params
{
    "value": 0
}
JSON result
{
    "result": 0
}
XML params
<parameters>
  <value>0</value>
</parameters>
XML result
<result>0</result>

Multiplies value by two.

Parameter:value (integer) – The value to multiply
Return type:integer
twentyover(value) → integer
JSON params
{
    "value": 0
}
JSON result
{
    "result": 0
}
XML params
<parameters>
  <value>0</value>
</parameters>
XML result
<result>0</result>

Divides 20 by value.

Parameter:value (integer) – The value to divide
Return type:integer

Namespace fancy

Path
/api/fancy

Fancy functions

getfancy() → FancyValue
JSON params
{}
JSON result
{
    "result": {
        "age": 27, 
        "computed": "Hello!", 
        "name": "Rimbaud"
    }
}
XML params
<parameters />
XML result
<result>
  <age>27</age>
  <computed>Hello!</computed>
  <name>Rimbaud</name>
</result>

Returns a fancy value

Returns:The fancy value
Return type:FancyValue
setfancy(fancy)
JSON params
{
    "fancy": {
        "age": 27, 
        "computed": "Hello!", 
        "name": "Rimbaud"
    }
}
JSON result
{
    "result": ""
}
XML params
<parameters>
  <fancy>
    <age>27</age>
    <computed>Hello!</computed>
    <name>Rimbaud</name>
  </fancy>
</parameters>
XML result
<result />

Send a fancy value :param value: The sent fancy

Parameter:fancy (FancyValue) –

Table Of Contents

Previous topic

Document your API

Next topic

Client side examples

This Page