CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

api docs update

Browse Source
This commit is contained in:
John Woodlock
2012-06-06 19:49:27 +10:00
parent 1d4b0fe698
commit a557367215
2 changed files with 55 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+46 -120
View File
@@ -159,7 +159,7 @@
Internet Explorer will probably treat the output as if you wanted to download a file. Internet Explorer will probably treat the output as if you wanted to download a file.
In that case just elect to open the output in a text editor.</p> In that case just elect to open the output in a text editor.</p>
<p>If you want to check out the POST, PUT and DELETE (update) examples a good approach is to take a moment to <p>If you want to check out the POST, PUT and DELETE (update) examples a good approach is to take a moment to
install a REST plugin for your browser e.g. RESTClient for FireFox</p> install a REST plugin for your browser e.g. <a href="https://addons.mozilla.org/en-US/firefox/addon/restclient/">RESTClient</a> for FireFox</p>
The REST plugins will allow you to The REST plugins will allow you to
<ul> <ul>
<li class=normalli>Select the "Verb" (e.g. POST)</li> <li class=normalli>Select the "Verb" (e.g. POST)</li>
@@ -282,8 +282,8 @@ JSON examples:
</p> </p>
<p> <p>
All API requests must be made over <a href="http://en.wikipedia.org/wiki/HTTP_Secure">HTTPS</a>. The platform has been configured to reject plain HTTP requests and to expect all API requests to be made over <a href="http://en.wikipedia.org/wiki/HTTP_Secure">HTTPS</a>.
Calls made over plain HTTP will fail. You must authenticate for all requests. All requests must be authenticated.
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
@@ -337,134 +337,60 @@ var jqxhr = $.ajax({
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Errors</h3> <h3>Errors</h3>
<p>JPW:Need to update this
Stripe uses conventional HTTP response codes to indicate
success or failure of an API request. In general,
codes in the 2xx range indicate success, codes in the
4xx range indicate an error that resulted from the
provided information (e.g. a required parameter was
missing, a charge failed, etc.), and codes in the 5xx
range indicate an error with Stripe's servers.
</p>
<p> <p>
Not all errors map cleanly onto HTTP response codes, All errors are return in JSON.
however. When a request is valid but does not complete
successfully (e.g. a card is declined), we return a 402
error code.
</p> </p>
<p>
All errors return JSON with a type (one of card_error, invalid_request_error,
or api_error) and message describing the particular problem.
</p>
<h5>Attributes</h5>
<dl class="argument-list">
<dt>type</dt>
<dd></dd>
<dd>The type of error returned (card_error, invalid_request_error, api_error)
Card errors are the most common type of error you should expect to handle.
They result when the user enters a card that can't be charged for some reason.
Invalid request errors arise when your request has invalid parameters. API
errors cover any other type of problem (e.g. a temporary problem with Stripe's servers)
and should turn up only very infrequently.</dd>
<dt>message</dt>
<dd></dd>
<dd>A user-friendly message describing the error</dd>
<dt>code</dt>
<dd>optional</dd>
<dd>For card errors, additional information
about the user-friendly message to display for this error (e.g. "Your
card was declined.")</dd>
<dt>param</dt>
<dd>optional</dd>
<dd>The parameter the error relates to if the
error is parameter-specific. You can use this to display a message near
the correct form field, for example.</dd>
</dl>
</div> </div>
<div class="method-example"> <div class="method-example">
<h6>HTTP Status Code Summary</h6> <h6>HTTP Status Code Summary</h6>
<ul> <ul>
<li><strong>200</strong> OK - Everything worked as expected.</li> <li><strong>200</strong> OK - Everything Worked.</li>
<li><strong>400</strong> Bad Request - Often missing a required parameter.</li> <li><strong>400</strong> Bad Request - Invalid Parameter or Data Integrity Issue.</li>
<li><strong>401</strong> Unauthorized - No valid API key provided.</li> <li><strong>401</strong> Authentication Error.</li>
<li><strong>402</strong> Request Failed - Parameters were valid but request failed.</li> <li><strong>403</strong> Unauthorized Request.</li>
<li><strong>404</strong> Not Found - The requested item doesn't exist.</li> <li><strong>404</strong> Resource Not Found</li>
<li><strong>500, 502, 503, 504</strong> Server errors - something went wrong on Stripe's end.</li> <li><strong>500</strong> Platform Internal Server Error.</li>
</ul> </ul>
</div> </div>
<div class="method-example"> <div class="method-example">
<h6>Errors</h6> <code class="method-response">
<h7>Invalid Request Errors</h7> <b>Error Message returned when attempting to create an Office without passing any parameters</b>
<code><strong>Type:</strong> invalid_request_error</code> {
"developerMessage": "The request was invalid. This typically will happen due to validation errors which are provided.",
<h7>API Errors</h7> "developerDocLink": "https://github.com/keithwoodlock/mifosx/wiki/HTTP-API-Error-codes",
<code><strong>Type:</strong> api_error</code> "httpStatusCode": "400",
"defaultUserMessage": "Validation errors exist.",
<h7>Card Errors</h7> "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
<code><strong>Type:</strong> card_error</code> "errors": [
<table> {
<tbody><tr> "developerMessage": "The parameter name cannot be blank.",
<th>Code</th> "defaultUserMessage": "The parameter name cannot be blank.",
<th>Details</th> "userMessageGlobalisationCode": "validation.msg.office.name.cannot.be.blank",
</tr> "parameterName": "name",
<tr> "value": null,
<td>invalid_number</td> "args": []
<td>The card number is invalid</td> },
</tr> {
<tr> "developerMessage": "The parameter openingDate cannot be blank.",
<td>incorrect_number</td> "defaultUserMessage": "The parameter openingDate cannot be blank.",
<td>The card number is incorrect</td> "userMessageGlobalisationCode": "validation.msg.office.openingDate.cannot.be.blank",
</tr> "parameterName": "openingDate",
<tr> "value": null,
<td>invalid_expiry_month</td> "args": []
<td>The card's expiration month is invalid</td> },
</tr> {
<tr> "developerMessage": "The parameter parentId cannot be blank.",
<td>invalid_expiry_year</td> "defaultUserMessage": "The parameter parentId cannot be blank.",
<td>The card's expiration year is invalid</td> "userMessageGlobalisationCode": "validation.msg.office.parentId.cannot.be.blank",
</tr> "parameterName": "parentId",
<tr> "value": null,
<td>invalid_cvc</td> "args": []
<td>The card's security code is invalid</td> }
</tr> ]
<tr> }
<td>expired_card</td> </code>
<td>The card has expired</td>
</tr>
<tr>
<td>invalid_amount</td>
<td>An invalid amount was entered</td>
</tr>
<tr>
<td>incorrect_cvc</td>
<td>The card's security code is incorrect</td>
</tr>
<tr>
<td>card_declined</td>
<td>The card was declined.</td>
</tr>
<tr>
<td>missing</td>
<td>There is no card on a customer that is being charged.</td>
</tr>
<tr>
<td>duplicate_transaction</td>
<td>A transaction with identical amount and credit card information was submitted very recently.</td>
</tr>
<tr>
<td>processing_error</td>
<td>An error occurred while processing the card.</td>
</tr>
</tbody></table>
</div> </div>
</div> </div>
api-docs/docUpdateComments.txt
+7 -6
View File
@@ -4,7 +4,7 @@ POSSIBLE CHANGES TO APP OR DOCUMENTATION
list clients notes - noteType needs a 'text' DOING list clients notes - noteType needs a 'text' DOING
createdOn & updatedOn values... do they need reformatting? DOING createdOn & updatedOn values... do they need reformatting? DOING
loan template - repaymentSchedule is null - I can't see it set in the app - used in preview schedule functionality maybe? - probably not used and will be deleted loan template - repaymentSchedule is null - I can't see it set in the app - used in preview schedule functionality maybe? - KW probably not used and will be deleted
loan retrieve DOING loan retrieve DOING
@@ -18,8 +18,8 @@ loan retrieve DOING
loanRepayments loanRepayments
Loan Transitions ... approve etc - possible done Loan Transitions ... approve etc - possible done CHECK AFTER
if "eventLocalDate" parameter added with string date then instead of parameter not support msg do get jackson conversion exception. if "eventLocalDate" parameter added with string date then instead of parameter not support msg do get jackson conversion exception. - KW might to jackson conversion exception to json.
approve loan (already closed) with approval date before submitted date approve loan (already closed) with approval date before submitted date
The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>org.mifosng.platform.loan.domain.InvalidLoanTimelineDate: The date of when loan is approved cannot be before its submittal date. The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>org.mifosng.platform.loan.domain.InvalidLoanTimelineDate: The date of when loan is approved cannot be before its submittal date.
@@ -41,7 +41,7 @@ Loan Transactions (repay and waive - and maybe reversal - but not disbursement)
"principal" : null, "interest" : null, total, "totalWaived" : null, "overpaid" : null, and the offset - are nulls ever put in? DOING "principal" : null, "interest" : null, total, "totalWaived" : null, "overpaid" : null, and the offset - are nulls ever put in? DOING
adjust: adjust:
when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>java.lang.IllegalArgumentException: Only repayment and waiver transactions can be adjusted. DONE when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>java.lang.IllegalArgumentException: Only repayment and waiver transactions can be adjusted. DOING
on create and adjust, app returns clientId can it be transaction id or loanId? on create and adjust, app returns clientId can it be transaction id or loanId?
@@ -55,8 +55,7 @@ list of loan transactions not available (except in summary - presume repayments
DOCUMENTATION REMAINING DOCUMENTATION REMAINING
maybe PlatformDomainRule should be in 400 rather than 403
Just Errors section to do in the Overview section
describe waiver CHECK RULES AFTER describe waiver CHECK RULES AFTER
@@ -81,3 +80,5 @@ inherited from loan product. KW DOING - CHECK AFTER
?DOMAIN NAME ?DOMAIN NAME