Doc formatting fixup

This commit is contained in:
DanB
2013-12-03 17:34:09 +01:00
parent 4de7dd3c26
commit 3fb00f8fea

View File

@@ -6,24 +6,24 @@ Creates a new timing within a tariff plan.
**Request**:
Data:
::
::
type ApierTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
Years string // semicolon separated list of years this timing is valid on, \*any supported
Months string // semicolon separated list of months this timing is valid on, \*any supported
MonthDays string // semicolon separated list of month's days this timing is valid on, \*any supported
WeekDays string // semicolon separated list of week day names this timing is valid on \*any supported
Time string // String representing the time this timing starts on
}
type ApierTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
Years string // semicolon separated list of years this timing is valid on, \*any supported
Months string // semicolon separated list of months this timing is valid on, \*any supported
MonthDays string // semicolon separated list of month's days this timing is valid on, \*any supported
WeekDays string // semicolon separated list of week day names this timing is valid on \*any supported
Time string // String representing the time this timing starts on
}
Mandatory parameters: ``[]string{"TPid", "TimingId", "Years", "Months", "MonthDays", "WeekDays", "Time"}``
*JSON sample*:
::
::
{
{
"id": 3,
"method": "ApierV1.SetTPTiming",
"params": [
@@ -37,26 +37,26 @@ Creates a new timing within a tariff plan.
"Years": "*any"
}
]
}
}
**Reply**:
Data:
::
::
string
string
Possible answers:
``OK`` - Success.
*JSON sample*:
::
::
{
{
"error": null,
"id": 3,
"result": "OK"
}
}
**Errors**:
@@ -73,17 +73,17 @@ Queries specific Timing on tariff plan.
**Request**:
Data:
::
::
type AttrGetTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
}
type AttrGetTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
}
Mandatory parameters: ``[]string{"TPid", "TimingId"}``
*JSON sample*:
::
::
{
"id": 5,
@@ -94,28 +94,28 @@ Queries specific Timing on tariff plan.
"TimingId": "ALWAYS"
}
]
}
}
**Reply**:
Data:
::
::
type ApierTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
Years string // semicolon separated list of years this timing is valid on, \*any supported
Months string // semicolon separated list of months this timing is valid on, \*any supported
MonthDays string // semicolon separated list of month's days this timing is valid on, \*any supported
WeekDays string // semicolon separated list of week day names this timing is valid on \*any supported
Time string // String representing the time this timing starts on
}
type ApierTPTiming struct {
TPid string // Tariff plan id
TimingId string // Timing id
Years string // semicolon separated list of years this timing is valid on, \*any supported
Months string // semicolon separated list of months this timing is valid on, \*any supported
MonthDays string // semicolon separated list of month's days this timing is valid on, \*any supported
WeekDays string // semicolon separated list of week day names this timing is valid on \*any supported
Time string // String representing the time this timing starts on
}
*JSON sample*:
::
::
{
{
"error": null,
"id": 5,
"result": {
@@ -127,7 +127,7 @@ Queries specific Timing on tariff plan.
"WeekDays": "*any",
"Years": "*any"
}
}
}
**Errors**:
@@ -146,18 +146,18 @@ Queries timing identities on tariff plan.
**Request**:
Data:
::
::
type AttrGetTPTimingIds struct {
type AttrGetTPTimingIds struct {
TPid string // Tariff plan id
}
}
Mandatory parameters: ``[]string{"TPid"}``
*JSON sample*:
::
::
{
{
"id": 4,
"method": "ApierV1.GetTPTimingIds",
"params": [
@@ -165,25 +165,25 @@ Queries timing identities on tariff plan.
"TPid": "CGR_API_TESTS"
}
]
}
}
**Reply**:
Data:
::
::
[]string
[]string
*JSON sample*:
::
::
{
{
"error": null,
"id": 4,
"result": [
"ASAP"
]
}
}
**Errors**: