updating some api docs and generating questions for keith
This commit is contained in:
+50
-317
@@ -92,8 +92,6 @@
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td colspan=2 valign="top"><div class="matrixHeadingVerbs"><table><tr><td>RESOURCES</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td><div class=matrixHeadingCommands>create/update</div></td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td><div class=matrixHeadingCommands>read</div></td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td><div class=matrixHeadingCommands>simple update</div></td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td><div class=matrixHeadingCommands>delete</div></td></tr></table></td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td></td><td></td><td></td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td></td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td></td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td></td><td></td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td></td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td></td><td></td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td></td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td></td><td></td></tr>
|
||||
@@ -2422,7 +2420,7 @@ Request Body:
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h3>Configuration</h3>
|
||||
<p>Application related configuration like being able to select what currencies are permitted for use within the MFI.</p>
|
||||
<p>Application related configuration like being able to select the currencies permitted for use within the MFI.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2430,124 +2428,70 @@ Request Body:
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Retrieve Currency Configuration</h4>
|
||||
<p>Returns the list of selectedCurrencies that are allowed within the MFI and the list of currencies that are currently not selected.</p>
|
||||
<p>Example Request:
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/configurations/currency">https://localhost:8443/mifosng-provider/api/v1/configurations/currency</a>
|
||||
</p>
|
||||
<p>Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).</p>
|
||||
<p>Example Requests: </p>
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true">https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true</a>
|
||||
<br>
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions">https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions</a>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">GET https://thedomainname/api/v1/configurations/currency</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"selectedCurrencyOptions": [
|
||||
{
|
||||
"code": "KES",
|
||||
"name": "Kenyan Shilling",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": "KSh",
|
||||
"nameCode": "currency.KES",
|
||||
"displayLabel": "Kenyan Shilling (KSh)"
|
||||
},
|
||||
{
|
||||
"code": "BND",
|
||||
"name": "Brunei Dollar",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": "BND",
|
||||
"nameCode": "currency.BND",
|
||||
"displayLabel": "Brunei Dollar (BND)"
|
||||
},
|
||||
{
|
||||
"code": "LBP",
|
||||
"name": "Lebanese Pound",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": "L£",
|
||||
"nameCode": "currency.LBP",
|
||||
"displayLabel": "Lebanese Pound (L£)"
|
||||
},
|
||||
{
|
||||
"code": "GHC",
|
||||
"name": "Ghana Cedi",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": "GHC",
|
||||
"nameCode": "currency.GHC",
|
||||
"displayLabel": "Ghana Cedi (GHC)"
|
||||
},
|
||||
{
|
||||
"code": "USD",
|
||||
"name": "US Dollar",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": "$",
|
||||
"nameCode": "currency.USD",
|
||||
"displayLabel": "US Dollar ($)"
|
||||
},
|
||||
{
|
||||
"code": "XOF",
|
||||
"name": "CFA Franc BCEAO",
|
||||
"decimalPlaces": 0,
|
||||
"displaySymbol": "CFA",
|
||||
"nameCode": "currency.XOF",
|
||||
"displayLabel": "CFA Franc BCEAO (CFA)"
|
||||
}
|
||||
],
|
||||
"currencyOptions": [
|
||||
{
|
||||
"code": "AED",
|
||||
"name": "UAE Dirham",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": null,
|
||||
"nameCode": "currency.AED",
|
||||
"displayLabel": "UAE Dirham [AED]"
|
||||
},
|
||||
{
|
||||
"code": "AFN",
|
||||
"name": "Afghanistan Afghani",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": null,
|
||||
"nameCode": "currency.AFN",
|
||||
"displayLabel": "Afghanistan Afghani [AFN]"
|
||||
},
|
||||
...
|
||||
...
|
||||
{
|
||||
"code": "ZMK",
|
||||
"name": "Zambian Kwacha",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": null,
|
||||
"nameCode": "currency.ZMK",
|
||||
"displayLabel": "Zambian Kwacha [ZMK]"
|
||||
},
|
||||
{
|
||||
"code": "ZWD",
|
||||
"name": "Zimbabwe Dollar",
|
||||
"decimalPlaces": 2,
|
||||
"displaySymbol": null,
|
||||
"nameCode": "currency.ZWD",
|
||||
"displayLabel": "Zimbabwe Dollar [ZWD]"
|
||||
}
|
||||
]
|
||||
<code class="method-response">{
|
||||
"selectedCurrencyOptions" : [ {
|
||||
"code" : "XOF",
|
||||
"name" : "CFA Franc BCEAO",
|
||||
"decimalPlaces" : 0,
|
||||
"displaySymbol" : "CFA",
|
||||
"nameCode" : "currency.XOF",
|
||||
"displayLabel" : "CFA Franc BCEAO (CFA)"
|
||||
}, {
|
||||
"code" : "ETB",
|
||||
"name" : "Ethiopian Birr",
|
||||
"decimalPlaces" : 2,
|
||||
"displaySymbol" : null,
|
||||
"nameCode" : "currency.ETB",
|
||||
"displayLabel" : "Ethiopian Birr [ETB]"
|
||||
} ],
|
||||
"currencyOptions" : [ {
|
||||
"code" : "AED",
|
||||
"name" : "UAE Dirham",
|
||||
"decimalPlaces" : 2,
|
||||
"displaySymbol" : null,
|
||||
"nameCode" : "currency.AED",
|
||||
"displayLabel" : "UAE Dirham [AED]"
|
||||
}, {
|
||||
"code" : "AFN",
|
||||
"name" : "Afghanistan Afghani",
|
||||
"decimalPlaces" : 2,
|
||||
"displaySymbol" : null,
|
||||
"nameCode" : "currency.AFN",
|
||||
"displayLabel" : "Afghanistan Afghani [AFN]"
|
||||
}, ...
|
||||
]
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="configs_currencyupdate" name="configs_currencyupdate" class="old-syle-anchor"> </a>
|
||||
<a id="configs_currencyupdate" name="configs_currencyupdate" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Update Currency Configuration</h4>
|
||||
<p>Update list of selectedCurrencies that are allowed within the MFI and the list of currencies that are currently not selected.</p>
|
||||
<p>Example Request:
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/configurations/currency">https://localhost:8443/mifosng-provider/api/v1/configurations/currency</a>
|
||||
</p>
|
||||
<p>Updates the list of currencies permitted for use.</p>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">PUT https://thedomainname/api/v1/configurations/currency</code>
|
||||
<code class="method-response">
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">PUT https://thedomainname/api/v1/configurations/currency</code>
|
||||
<code class="method-request">PUT https://localhost:8443/mifosng-provider/api/v1/configurations/currency
|
||||
Content-Type: application/json
|
||||
Request Body:
|
||||
{
|
||||
"selectedItems": ["USD", "GBP"]
|
||||
"currencies": ["USD", "GBP","XOF","ETB"]
|
||||
}
|
||||
</code>
|
||||
</code>
|
||||
<code class="method-response">Question Outstanding
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- start of additionalfields api docs -->
|
||||
<a id="additionalfields" name="additionalfields" class="old-syle-anchor"> </a>
|
||||
@@ -2995,215 +2939,6 @@ Content-Type: application/xml
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- start of useraccounts api docs -->
|
||||
<a id="useraccounts" name="useraccounts" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h3>User account details</h3>
|
||||
<p>An API capability to allowed client applications expose functionality for users to update their account details and password.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="useraccount_details_retrieve" name="useraccount_details_retrieve" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Retrieve current users account details</h4>
|
||||
<p>Will return user account details.</p>
|
||||
<p>Example Request:
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/useraccounts/current">https://localhost:8443/mifosng-provider/api/v1/useraccounts/current</a>
|
||||
</p>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">GET https://thedomainname/api/v1/useraccounts/current</code>
|
||||
<code class="method-request">GET https://localhost:8443/mifosng-provider/api/v1/useraccounts/current</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"id": 1,
|
||||
"orgId": 1,
|
||||
"officeId": 1,
|
||||
"officeName": "Demo MFI Head Office",
|
||||
"username": "mifos",
|
||||
"firstname": "App hello",
|
||||
"lastname": "Administrator",
|
||||
"email": "demomfi@mifos.org",
|
||||
"allowedOffices": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Demo MFI Head Office",
|
||||
"externalId": "1",
|
||||
"openingDate": "2009-01-01",
|
||||
"hierarchy": ".",
|
||||
"parentName": null,
|
||||
"parentId": 0,
|
||||
"allowedParents": []
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "sub branch 1",
|
||||
"externalId": "2",
|
||||
"openingDate": "2012-01-02",
|
||||
"hierarchy": ".2.",
|
||||
"parentName": "Demo MFI Head Office",
|
||||
"parentId": 1,
|
||||
"allowedParents": []
|
||||
}
|
||||
],
|
||||
"availableRoles": [
|
||||
{
|
||||
"id": 2,
|
||||
"orgId": 1,
|
||||
"name": "Field officer",
|
||||
"description": "A field officer role allows the user to add client and loans and view reports but nothing else.",
|
||||
"availablePermissions": [],
|
||||
"selectedPermissions": []
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"orgId": 1,
|
||||
"name": "Data Entry (Portfolio only)",
|
||||
"description": "This role allows a user full permissions around client and loan functionality but nothing else.",
|
||||
"availablePermissions": [],
|
||||
"selectedPermissions": []
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"orgId": 1,
|
||||
"name": "Credit Committe Member",
|
||||
"description": "This role allows a user to approve reject or withdraw loans (with reporting).",
|
||||
"availablePermissions": [],
|
||||
"selectedPermissions": []
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"orgId": 1,
|
||||
"name": "Manager",
|
||||
"description": "This role allows a manager to do anything related to portfolio management and also view all reports.",
|
||||
"availablePermissions": [],
|
||||
"selectedPermissions": []
|
||||
}
|
||||
],
|
||||
"selectedRoles": [
|
||||
{
|
||||
"id": 1,
|
||||
"orgId": 1,
|
||||
"name": "Super user",
|
||||
"description": "This role provides all application permissions.",
|
||||
"availablePermissions": [],
|
||||
"selectedPermissions": [
|
||||
{
|
||||
"id": 1,
|
||||
"orgId": 1,
|
||||
"name": "User administration ALL",
|
||||
"description": "An application user will have permission to execute all tasks related to user administration.",
|
||||
"code": "USER_ADMINISTRATION_SUPER_USER_ROLE",
|
||||
"groupType": 1
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"orgId": 1,
|
||||
"name": "Reporting ALL",
|
||||
"description": "An application user will have permission to execute and view all reports.",
|
||||
"code": "REPORTING_SUPER_USER_ROLE",
|
||||
"groupType": 4
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"orgId": 1,
|
||||
"name": "Portfolio management ALL",
|
||||
"description": "An application user will have permission to execute all tasks related to portfolio management.",
|
||||
"code": "PORTFOLIO_MANAGEMENT_SUPER_USER_ROLE",
|
||||
"groupType": 3
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"orgId": 1,
|
||||
"name": "Organisation adminsitration ALL",
|
||||
"description": "An application user will have permission to execute all tasks related to organisation administration.",
|
||||
"code": "ORGANISATION_ADMINISTRATION_SUPER_USER_ROLE",
|
||||
"groupType": 2
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="useraccount_details_update" name="useraccount_details_update" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Update current users account details</h4>
|
||||
<p>Will update user account details.</p>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">PUT https://thedomainname/api/v1/useraccounts/current</code>
|
||||
<code class="method-request">PUT https://localhost:8443/mifosng-provider/api/v1/useraccounts/current
|
||||
Content-Type: application/json
|
||||
Request body:
|
||||
{
|
||||
"officeId": 1,
|
||||
"username": "mifos",
|
||||
"firstname": "App hello",
|
||||
"lastname": "Administrator",
|
||||
"email": "demomfi@mifos.org",
|
||||
"selectedItems": ["1"]
|
||||
}
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"entityId": 1
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a id="useraccount_password_retrieve" name="useraccount_password_retrieve" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Retrieve change password template details</h4>
|
||||
<p>Will details for change of password screen.</p>
|
||||
<p>Example Request:
|
||||
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/useraccounts/current/password/template">https://localhost:8443/mifosng-provider/api/v1/useraccounts/current/password/template</a>
|
||||
</p>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">GET https://thedomainname/api/v1/useraccounts/current/password/template</code>
|
||||
<code class="method-request">GET https://localhost:8443/mifosng-provider/api/v1/useraccounts/current/password/template</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"password": null,
|
||||
"passwordrepeat": null
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="useraccount_password_update" name="useraccount_password_update" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Update current users password</h4>
|
||||
<p>Will update users password.</p>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">PUT https://thedomainname/api/v1/useraccounts/current/password</code>
|
||||
<code class="method-request">PUT https://localhost:8443/mifosng-provider/api/v1/useraccounts/current/password
|
||||
Content-Type: application/json
|
||||
Request body:
|
||||
{
|
||||
"password": "demo",
|
||||
"passwordrepeat": "demo"
|
||||
}
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"entityId": 1
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- start of users api docs -->
|
||||
<a id="users" name="users" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
@@ -3985,8 +3720,6 @@ Request body:
|
||||
<tr><td><a href="#reports">REPORT</a></td><td>/v1/reports</td><td></td><td><a href="#reports_list">List Reports</a></td><td></td><td></td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/reports/{reportName}</td><td></td><td><a href="#report_run">Run a Report</a></td><td></td><td></td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td></td><td></td><td></td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td></td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td></td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td></td><td></td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td></td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td></td><td></td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td></td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td></td><td></td></tr>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,670 @@
|
||||
.tocMatrix {
|
||||
font-size: 85%;
|
||||
}
|
||||
.fullMatrixOuter {
|
||||
margin-right: 20px;
|
||||
margin-left: 20px;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.matrixHeading {
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
border-collapse:collapse;
|
||||
border:3px solid #6eb4db;
|
||||
width:100%;
|
||||
}
|
||||
|
||||
.matrixHeading td
|
||||
{
|
||||
//padding:3px 7px 2px 7px;
|
||||
|
||||
padding-right:5px;
|
||||
|
||||
vertical-align:text-top;
|
||||
}
|
||||
.matrixHeading tr.alt
|
||||
{
|
||||
color:#000;
|
||||
background-color: rgb(240, 240, 255);
|
||||
}
|
||||
|
||||
|
||||
.matrixHeadingBG {
|
||||
background-color: #6eb4db;
|
||||
}
|
||||
|
||||
.matrixHeadingVerbs {
|
||||
color: white;
|
||||
font-weight: bold;
|
||||
font-size: 125%
|
||||
}
|
||||
|
||||
.matrixHeadingCommands {
|
||||
color: rgb(240, 240, 255);
|
||||
}
|
||||
|
||||
|
||||
|
||||
html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,tdjpw{margin:0;padding:0;}tablejpw{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym{border:0;font-variant:normal;}sup{vertical-align:text-top;}sub{vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}
|
||||
|
||||
a img { outline: none; border: 0; }
|
||||
h1 { font-size: 180%; font-weight: bold; }
|
||||
h2 { font-size: 165%; font-weight: bold; }
|
||||
h3 { font-size: 145%; font-weight: bold; }
|
||||
h4 { font-size: 120%; font-weight: bold; }
|
||||
h5 { font-size: 120%; font-weight: bold; }
|
||||
h6 { font-size: 110%; font-weight: bold; }
|
||||
h1, h2, h3, h4, h5, h6 { margin: 0 0 0.5em 0; line-height: 1.2em; }
|
||||
p { margin: 1em 0; }
|
||||
em {font-style: italic;}
|
||||
|
||||
html {
|
||||
background-color: rgb(240, 240, 255);
|
||||
}
|
||||
|
||||
body {
|
||||
padding: 0; margin: 0;
|
||||
font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
|
||||
font-size: 15px;
|
||||
line-height: 22px;
|
||||
min-width: 1000px;
|
||||
background-color: gray;
|
||||
border-top: 15px solid black;
|
||||
}
|
||||
|
||||
#flybar {
|
||||
font-size: 14px;
|
||||
line-height: 20px;
|
||||
}
|
||||
|
||||
.method-example h1, .method-example h2, .method-example h3, .method-example h4, .method-example h5, .method-example h6, #flybar, .footer {
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
}
|
||||
|
||||
.method-example code {
|
||||
font-family: Monaco, Consolas, "Lucida Console", monospace;
|
||||
font-size: 12px;
|
||||
line-height: 18px;
|
||||
}
|
||||
|
||||
#flybar {
|
||||
position: fixed;
|
||||
z-index: 100;
|
||||
height: 40px;
|
||||
min-width: 745px;
|
||||
left: 0; right: 0; top: 0;
|
||||
padding-left: 200px;
|
||||
background: #eee;
|
||||
background: -webkit-gradient(linear, left top, left bottom, from(#f8f8f8), to(#dadada));
|
||||
background: -moz-linear-gradient(top, #f8f8f8, #dadada);
|
||||
border-top: 3px solid black;
|
||||
border-bottom: 1px solid #888;
|
||||
-webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
-moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
#nav-logo {
|
||||
display: block;
|
||||
height: 30px;
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
left: 20px;
|
||||
font-weight: bold;
|
||||
color: black;
|
||||
font-size: 16px;
|
||||
text-decoration: none;
|
||||
|
||||
}
|
||||
|
||||
.flybar-button {
|
||||
text-align: center;
|
||||
text-transform: uppercase;
|
||||
font-size: 12px;
|
||||
padding: 0 1em;
|
||||
line-height: 40px;
|
||||
border-right: 1px solid transparent;
|
||||
border-left: 1px solid transparent;
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
color: black;
|
||||
}
|
||||
|
||||
.flybar-nav {
|
||||
display: block;
|
||||
float: left;
|
||||
width: 150px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.flybar-language {
|
||||
display: block;
|
||||
float: left;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.flybar-language .flybar-button {
|
||||
float: left;
|
||||
clear: none;
|
||||
border-right: 1px solid transparent;
|
||||
border-left: 1px solid transparent;
|
||||
min-width: 80px;
|
||||
margin-left: -1px;
|
||||
}
|
||||
|
||||
.flybar-menu {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 41px;
|
||||
|
||||
width: 850px;
|
||||
background-color: rgba(249, 249, 249, 0.99);
|
||||
border: 1px solid rgb(187, 187, 187);
|
||||
border-top: 0;
|
||||
padding: 1em;
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
-webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
-moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.flybar-menu-overview {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 41px;
|
||||
|
||||
width: 300px;
|
||||
background-color: rgba(249, 249, 249, 0.99);
|
||||
border: 1px solid rgb(187, 187, 187);
|
||||
border-top: 0;
|
||||
padding: 1em;
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
-webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
-moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.flybar-menu-convenience {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 41px;
|
||||
|
||||
width: 575px;
|
||||
background-color: rgba(249, 249, 249, 0.99);
|
||||
border: 1px solid rgb(187, 187, 187);
|
||||
border-top: 0;
|
||||
padding: 1em;
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
-webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
-moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
#toc-menu1 {
|
||||
position:absolute;
|
||||
left:-150px;
|
||||
}
|
||||
|
||||
#toc-menu2 {
|
||||
position:absolute;
|
||||
left:-300px;
|
||||
}
|
||||
|
||||
#toc-menu3 {
|
||||
position:absolute;
|
||||
left:-450px;
|
||||
}
|
||||
|
||||
#toc-menu4 {
|
||||
position:absolute;
|
||||
left:-600px;
|
||||
}
|
||||
|
||||
#toc-menu5 {
|
||||
position:absolute;
|
||||
left:-450px;
|
||||
}
|
||||
|
||||
#language-menu {
|
||||
left: -25px;
|
||||
}
|
||||
|
||||
#language-menu li {
|
||||
display: inline-block;
|
||||
margin-right: 25px;
|
||||
}
|
||||
|
||||
.flybar-menu h3, .flybar-menu-overview h3, .flybar-menu-convenience h3 {
|
||||
text-transform: uppercase;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.flybar-menu h4, .flybar-menu-overview h4, .flybar-menu-convenience h4 {
|
||||
text-transform: uppercase;
|
||||
font-size: 90%;
|
||||
color: rgb(155, 155, 155);
|
||||
margin: 0.5em 0 0.5em 0;
|
||||
}
|
||||
|
||||
.flybar-menu ul, .flybar-menu-overview ul, .flybar-menu-convenience ul {
|
||||
margin: 0 0 1em 1em;
|
||||
}
|
||||
|
||||
.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, .flybar-nav:hover .flybar-menu-convenience,
|
||||
.flybar-nav.active .flybar-menu, .flybar-nav.active .flybar-menu-overview, .flybar-nav.active .flybar-menu-convenience{
|
||||
display: block;
|
||||
}
|
||||
|
||||
.flybar-button:hover,
|
||||
.flybar-button.active,
|
||||
.flybar-nav:hover .flybar-button,
|
||||
.flybar-nav.active .flybar-button {
|
||||
background: #eee;
|
||||
background: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#f8f8f8));
|
||||
background: -moz-linear-gradient(top, #eee, #f8f8f8);
|
||||
border-left: 1px solid rgb(187, 187, 187);
|
||||
border-right: 1px solid rgb(187, 187, 187);
|
||||
}
|
||||
|
||||
.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, .flybar-nav:hover .flybar-menu-convenience,
|
||||
.flybar-button.active {
|
||||
margin-right: -1px;
|
||||
}
|
||||
|
||||
.flybar-nav:hover .flybar-button,
|
||||
.flybar-nav.active .flybar-button {
|
||||
height: 51px;
|
||||
color: #000;
|
||||
background: -webkit-gradient(linear, left top, left bottom, from(#e5e5e5), to(#fff));
|
||||
background: -moz-linear-gradient(top, #e5e5e5, #fff);
|
||||
}
|
||||
|
||||
.toc-column1 {
|
||||
width: 200px;
|
||||
}
|
||||
|
||||
.toc-column2 {
|
||||
width: 235px;
|
||||
}
|
||||
|
||||
.toc-column3 {
|
||||
width: 200px;
|
||||
}
|
||||
|
||||
.toc-column1, .toc-column2, .toc-column3, .toc-column4, .toc-column5, .toc-column6 {
|
||||
float: left;
|
||||
}
|
||||
|
||||
.toc-section {
|
||||
width: 235px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
code {
|
||||
white-space: pre;
|
||||
white-space: -o-pre-wrap;
|
||||
white-space: -moz-pre-wrap;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
margin: 1em 0;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
|
||||
.method-section {
|
||||
clear: left;
|
||||
padding: 1em 0;
|
||||
padding-top: 60px;
|
||||
margin-left: -580px;
|
||||
}
|
||||
|
||||
.method-section:after {
|
||||
visibility: hidden;
|
||||
display: block;
|
||||
font-size: 0;
|
||||
content: " ";
|
||||
clear: both;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
.method-description {
|
||||
width: 540px;
|
||||
float: left;
|
||||
padding-right: 20px;
|
||||
color: black;
|
||||
}
|
||||
|
||||
.method-description p {
|
||||
}
|
||||
|
||||
h1 {
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.method-description h4 {
|
||||
/*font-family: monospace;*/
|
||||
}
|
||||
|
||||
.method-description h5 {
|
||||
font-size: 110%;
|
||||
color: rgb(155, 155, 155);
|
||||
text-transform: uppercase;
|
||||
clear: both;
|
||||
padding: 0.5em 0;
|
||||
}
|
||||
|
||||
.method-example {
|
||||
margin-left: 560px;
|
||||
padding-left: 20px;
|
||||
min-width: 380px;
|
||||
}
|
||||
|
||||
.method-example code {
|
||||
white-space: pre;
|
||||
white-space: -o-pre-wrap;
|
||||
white-space: -moz-pre-wrap;
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
.method-example {
|
||||
color: rgb(105, 105, 125);
|
||||
}
|
||||
|
||||
.method-example p {
|
||||
font-style: italic;
|
||||
color: rgb(105, 105, 105);
|
||||
}
|
||||
|
||||
.method-error:before {
|
||||
content: "EXAMPLE ERROR";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.method-declaration:before {
|
||||
content: "DEFINITION";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.method-request:before {
|
||||
content: "EXAMPLE REQUEST";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.method-response:before {
|
||||
content: "EXAMPLE RESPONSE";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.expected-result:before {
|
||||
content: "RESULT";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.method-response, .method-error {
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
.method-example li {
|
||||
font-family: monospace;
|
||||
color: black;
|
||||
}
|
||||
|
||||
.method-example ul {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
.method-example table {
|
||||
font-family: monospace;
|
||||
color: black;
|
||||
}
|
||||
|
||||
.method-example td {
|
||||
padding-right: 20px;
|
||||
padding-bottom: 5px;
|
||||
vertical-align: top;
|
||||
}
|
||||
.method-example table th {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.method-example code {
|
||||
color: black;
|
||||
}
|
||||
|
||||
.prompt:after {
|
||||
content: '$ ';
|
||||
color: gray;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.prompt.curl:after { content: '$ '; }
|
||||
.prompt.ruby:after { content: '>> ' }
|
||||
.prompt.python:after { content: '>>> ' }
|
||||
.prompt.php:after { content: 'php > ' }
|
||||
.prompt.java:after { content: '' }
|
||||
|
||||
.method-name {
|
||||
font-family: monospace;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.notification-request:before {
|
||||
content: "EXAMPLE NOTIFICATION";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
.notification-event:before {
|
||||
content: "EVENT";
|
||||
color: rgb(155, 155, 185);
|
||||
display: block;
|
||||
}
|
||||
|
||||
|
||||
#page-wrapper {
|
||||
background-color: white;
|
||||
color: black;
|
||||
}
|
||||
|
||||
#main-content-wrapper {
|
||||
background-color: rgb(240, 240, 255);
|
||||
|
||||
margin-left: 579px;
|
||||
padding: 0 20px 40px 20px;
|
||||
border-left: 1px solid rgb(229, 229, 238);
|
||||
}
|
||||
|
||||
#api-summary-example {
|
||||
margin-top: 48px;
|
||||
}
|
||||
|
||||
.argument-list {
|
||||
font-size: 90%;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
|
||||
.argument-list dl {
|
||||
font-size: 95%;
|
||||
padding: 1em 0;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
|
||||
.argument-list:after {
|
||||
visibility: hidden;
|
||||
display: block;
|
||||
font-size: 0;
|
||||
content: " ";
|
||||
clear: both;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
.argument-list dl:after {
|
||||
visibility: hidden;
|
||||
display: block;
|
||||
font-size: 0;
|
||||
content: " ";
|
||||
clear: both;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
.argument-list dt {
|
||||
clear:both;
|
||||
width:34%;
|
||||
float:left;
|
||||
text-align:right;
|
||||
font-weight: bold;
|
||||
margin-top: 8px;
|
||||
}
|
||||
|
||||
.event-types.argument-list dt {
|
||||
width: 48%;
|
||||
}
|
||||
|
||||
.event-types.argument-list dd {
|
||||
width: 48%;
|
||||
}
|
||||
|
||||
.argument-list dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
.argument-list dd {
|
||||
float:right;
|
||||
width: 65%;
|
||||
}
|
||||
|
||||
.argument-list dl dd {
|
||||
width: 65%;
|
||||
}
|
||||
|
||||
.argument-list dt + dd {
|
||||
margin-top: 8px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.argument-list dd dl dd dl {
|
||||
width: 95%;
|
||||
}
|
||||
|
||||
.argument-list dd dl dd dl dd {
|
||||
width: 65%;
|
||||
}
|
||||
.argument-list dd dl dd dl dt {
|
||||
width:31%;
|
||||
}
|
||||
|
||||
.argument-list dd span {
|
||||
font-style: italic;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.old-syle-anchor {display:block;height:0;width:0;}
|
||||
strong { font-weight: bold; }
|
||||
|
||||
.footer {
|
||||
position: fixed;
|
||||
bottom: 0;
|
||||
height: 30px;
|
||||
|
||||
border-top: 1px solid #ccc;
|
||||
background: #eee;
|
||||
background: -webkit-gradient(linear, left top, left bottom, from(#f8f8f8), to(#dadada));
|
||||
background: -moz-linear-gradient(top, #f8f8f8, #dadada);
|
||||
|
||||
width: 100%;
|
||||
opacity: 0.95;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.footer input[type="text"] {
|
||||
height: 14px;
|
||||
padding: 3px;
|
||||
border: 1px solid #aaa;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.suggestion-box {
|
||||
float: right;
|
||||
padding-top: 3px;
|
||||
padding-right: 10px;
|
||||
}
|
||||
|
||||
.footer input[type="submit"]:hover {
|
||||
background: -webkit-gradient(
|
||||
linear,
|
||||
center top,
|
||||
center bottom,
|
||||
from(#fefefe),
|
||||
to(#dbdbdb),
|
||||
color-stop(80%, #eeeeee),
|
||||
color-stop(0%, #eeeeee)
|
||||
);
|
||||
background: -moz-linear-gradient(
|
||||
top,
|
||||
#fff,
|
||||
#fff
|
||||
);
|
||||
}
|
||||
|
||||
.footer input[type="submit"]:active {
|
||||
background: -webkit-gradient(
|
||||
linear,
|
||||
center top,
|
||||
center bottom,
|
||||
from(#c0c0c0),
|
||||
to(#fefefe),
|
||||
color-stop(0%, #e1e1e1),
|
||||
color-stop(30%, #eeeeee),
|
||||
color-stop(80%, #fff)
|
||||
);
|
||||
background: -moz-linear-gradient(
|
||||
top,
|
||||
#c0c0c0,
|
||||
#fefefe
|
||||
);
|
||||
|
||||
border: 1px solid #a3a3a3;
|
||||
}
|
||||
|
||||
.footer input[type="submit"] {
|
||||
height: 22px;
|
||||
padding: 3px;
|
||||
font-size: 13px;
|
||||
|
||||
font-family: "proxima-nova-1","proxima-nova-2", Helvetica, Arial, sans-serif;
|
||||
color: #454545;
|
||||
text-shadow: 0px 1px 0px #fff;
|
||||
text-align: center;
|
||||
|
||||
border: 1px solid #aaa;
|
||||
background: -webkit-gradient(
|
||||
linear,
|
||||
center top,
|
||||
center bottom,
|
||||
from(#fefefe),
|
||||
to(#dbdbdb),
|
||||
color-stop(50%, #eeeeee)
|
||||
);
|
||||
background: -moz-linear-gradient(
|
||||
top,
|
||||
#fefefe,
|
||||
#dbdbdb
|
||||
);
|
||||
|
||||
border-radius: 5px;
|
||||
-moz-border-radius: 5px;
|
||||
-webkit-border-radius: 5px;
|
||||
-webkit-background-clip: padding-box;
|
||||
-webkit-backface-visibility: hidden;
|
||||
}
|
||||
|
||||
.stripe-version {
|
||||
float: left;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
\loan\?\transactions\id get exception if loan doesn't match id.... should loan be taken out here?
|
||||
template for waiver/repayment... is it same for both? no type needed?
|
||||
new loan template ... is it 2 templates... one to pick product... and 2nd to return default properties in selected product
|
||||
|
||||
|
||||
Configuration
|
||||
If you put a new currency config in and it deletes a currently in using { "selectedItems": ["USD", "GBP","XOF","ETB"] } then an exception report is returned
|
||||
Works fine using currencies (updated docs)....
|
||||
also should this be a POST?
|
||||
and should it return just an ok and empty set rather than empty notSelectedCurrencies and currencies
|
||||
should update only select currencies and not allow notSelectedCurrencies?
|
||||
|
||||
|
||||
Reference in New Issue
Block a user