|
|
Line 16: |
Line 16: |
|
==Code Snippets== |
|
==Code Snippets== |
|
*Add header of '''"SOTC_AUTH"''', and assign value of '''AccessToken'''. |
|
*Add header of '''"SOTC_AUTH"''', and assign value of '''AccessToken'''. |
|
|
*'''1455''' is the Id that can be obtained with [[AOTG API: Get List of AR Invoice]], or after [[AOTG API: Create AR Invoice]] |
|
<br/> |
|
<br/> |
|
{{AOTGApiCodeSnippetTab |
|
{{AOTGApiCodeSnippetTab |
|
|Python= |
|
|Python= |
|
<syntaxhighlight lang="Python"> |
|
<syntaxhighlight lang="Python"> |
|
|
import requests |
|
|
|
|
|
url = "http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455" |
|
|
|
|
|
payload = "" |
|
|
headers = { |
|
|
'Content-Type': "application/json", |
|
|
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
'cache-control': "no-cache" |
|
|
} |
|
|
|
|
|
response = requests.request("GET", url, data=payload, headers=headers) |
|
|
|
|
|
print(response.text) |
|
</syntaxhighlight> |
|
</syntaxhighlight> |
|
|PHPHttp= |
|
|PHPHttp= |
|
<syntaxhighlight lang="PHP"> |
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
$request = new HttpRequest(); |
|
|
$request->setUrl('http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455'); |
|
|
$request->setMethod(HTTP_METH_GET); |
|
|
|
|
|
$request->setHeaders(array( |
|
|
'cache-control' => 'no-cache', |
|
|
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d', |
|
|
'Content-Type' => 'application/json' |
|
|
)); |
|
|
|
|
|
try { |
|
|
$response = $request->send(); |
|
|
|
|
|
echo $response->getBody(); |
|
|
} catch (HttpException $ex) { |
|
|
echo $ex; |
|
|
} |
|
</syntaxhighlight> |
|
</syntaxhighlight> |
|
|RestSharp= |
|
|RestSharp= |
|
<syntaxhighlight lang="C#"> |
|
<syntaxhighlight lang="C#"> |
|
|
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455"); |
|
|
var request = new RestRequest(Method.GET); |
|
|
request.AddHeader("cache-control", "no-cache"); |
|
|
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d"); |
|
|
request.AddHeader("Content-Type", "application/json"); |
|
|
IRestResponse response = client.Execute(request); |
|
</syntaxhighlight> |
|
</syntaxhighlight> |
|
|PHPcURL= |
|
|PHPcURL= |
|
<syntaxhighlight lang="PHP"> |
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
$curl = curl_init(); |
|
|
|
|
|
curl_setopt_array($curl, array( |
|
|
CURLOPT_PORT => "8080", |
|
|
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455", |
|
|
CURLOPT_RETURNTRANSFER => true, |
|
|
CURLOPT_ENCODING => "", |
|
|
CURLOPT_MAXREDIRS => 10, |
|
|
CURLOPT_TIMEOUT => 30, |
|
|
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, |
|
|
CURLOPT_CUSTOMREQUEST => "GET", |
|
|
CURLOPT_POSTFIELDS => "", |
|
|
CURLOPT_HTTPHEADER => array( |
|
|
"Content-Type: application/json", |
|
|
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
"cache-control: no-cache" |
|
|
), |
|
|
)); |
|
|
|
|
|
$response = curl_exec($curl); |
|
|
$err = curl_error($curl); |
|
|
|
|
|
curl_close($curl); |
|
|
|
|
|
if ($err) { |
|
|
echo "cURL Error #:" . $err; |
|
|
} else { |
|
|
echo $response; |
|
|
} |
|
</syntaxhighlight> |
|
</syntaxhighlight> |
|
}} |
|
}} |
Line 36: |
Line 107: |
|
200 OK |
|
200 OK |
|
====Response Successful Body==== |
|
====Response Successful Body==== |
|
|
'''Id''' can be used for checking the status of result. |
|
|
'''Id''' and '''Name''' are required to retrieve result (data). |
|
<syntaxhighlight lang="json-object" highlight="2,3"> |
|
<syntaxhighlight lang="json-object" highlight="2,3"> |
|
|
{ |
|
|
"Id": "t590eef-2337b-562f-8990-803cbc0b48636", |
|
|
"Name": "GetARInvoice", |
|
|
"StartTimestamp": "2019-03-05T01:39:20.7232199Z", |
|
|
"EndTimestamp": "2019-03-05T01:39:20.7232199Z" |
|
|
} |
|
|
</syntaxhighlight> |
|
|
|
|
|
|
<br/> |
|
|
==Check Status== |
|
|
===Code Snippets=== |
|
|
{{AOTGApiCodeSnippetTab |
|
|
|Python= |
|
|
<syntaxhighlight lang="Python"> |
|
|
import requests |
|
|
|
|
|
url = "http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636" |
|
|
|
|
|
payload = "" |
|
|
headers = { |
|
|
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
'cache-control': "no-cache" |
|
|
} |
|
|
|
|
|
response = requests.request("GET", url, data=payload, headers=headers) |
|
|
|
|
|
print(response.text) |
|
</syntaxhighlight> |
|
</syntaxhighlight> |
|
|
|PHPHttp= |
|
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
|
$request = new HttpRequest(); |
|
|
$request->setUrl('http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636'); |
|
|
$request->setMethod(HTTP_METH_GET); |
|
|
|
|
|
$request->setHeaders(array( |
|
|
'cache-control' => 'no-cache', |
|
|
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d' |
|
|
)); |
|
|
|
|
|
try { |
|
|
$response = $request->send(); |
|
|
|
|
|
echo $response->getBody(); |
|
|
} catch (HttpException $ex) { |
|
|
echo $ex; |
|
|
} |
|
|
</syntaxhighlight> |
|
|
|RestSharp= |
|
|
<syntaxhighlight lang="C#"> |
|
|
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636"); |
|
|
var request = new RestRequest(Method.GET); |
|
|
request.AddHeader("cache-control", "no-cache"); |
|
|
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d"); |
|
|
IRestResponse response = client.Execute(request); |
|
|
</syntaxhighlight> |
|
|
|PHPcURL= |
|
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
$curl = curl_init(); |
|
|
|
|
|
curl_setopt_array($curl, array( |
|
|
CURLOPT_PORT => "8080", |
|
|
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636", |
|
|
CURLOPT_RETURNTRANSFER => true, |
|
|
CURLOPT_ENCODING => "", |
|
|
CURLOPT_MAXREDIRS => 10, |
|
|
CURLOPT_TIMEOUT => 30, |
|
|
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, |
|
|
CURLOPT_CUSTOMREQUEST => "GET", |
|
|
CURLOPT_POSTFIELDS => "", |
|
|
CURLOPT_HTTPHEADER => array( |
|
|
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
"cache-control: no-cache" |
|
|
), |
|
|
)); |
|
|
|
|
|
$response = curl_exec($curl); |
|
|
$err = curl_error($curl); |
|
|
|
|
|
curl_close($curl); |
|
|
|
|
|
if ($err) { |
|
|
echo "cURL Error #:" . $err; |
|
|
} else { |
|
|
echo $response; |
|
|
} |
|
|
</syntaxhighlight> |
|
|
}} |
|
|
|
|
|
====Response of Status==== |
|
|
<syntaxhighlight lang="json-object"> |
|
|
{ |
|
|
"RequestId": "t590eef-2337b-562f-8990-803cbc0b48636", |
|
|
"Status": "Completed" |
|
|
} |
|
|
</syntaxhighlight> |
|
|
|
|
|
<br/> |
|
|
==Get Data (Result)== |
|
|
===Code Snippets=== |
|
|
{{AOTGApiCodeSnippetTab |
|
|
|Python= |
|
|
<syntaxhighlight lang="Python"> |
|
|
import requests |
|
|
|
|
|
url = "http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result" |
|
|
|
|
|
payload = "" |
|
|
headers = { |
|
|
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
'cache-control': "no-cache" |
|
|
} |
|
|
|
|
|
response = requests.request("GET", url, data=payload, headers=headers) |
|
|
|
|
|
print(response.text) |
|
|
</syntaxhighlight> |
|
|
|PHPHttp= |
|
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
$request = new HttpRequest(); |
|
|
$request->setUrl('http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result'); |
|
|
$request->setMethod(HTTP_METH_GET); |
|
|
|
|
|
$request->setHeaders(array( |
|
|
'cache-control' => 'no-cache', |
|
|
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d' |
|
|
)); |
|
|
|
|
|
try { |
|
|
$response = $request->send(); |
|
|
|
|
|
echo $response->getBody(); |
|
|
} catch (HttpException $ex) { |
|
|
echo $ex; |
|
|
} |
|
|
</syntaxhighlight> |
|
|
|RestSharp= |
|
|
<syntaxhighlight lang="C#"> |
|
|
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result"); |
|
|
var request = new RestRequest(Method.GET); |
|
|
request.AddHeader("cache-control", "no-cache"); |
|
|
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d"); |
|
|
IRestResponse response = client.Execute(request); |
|
|
</syntaxhighlight> |
|
|
|PHPcURL= |
|
|
<syntaxhighlight lang="PHP"> |
|
|
<?php |
|
|
|
|
|
$curl = curl_init(); |
|
|
|
|
|
curl_setopt_array($curl, array( |
|
|
CURLOPT_PORT => "8080", |
|
|
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result", |
|
|
CURLOPT_RETURNTRANSFER => true, |
|
|
CURLOPT_ENCODING => "", |
|
|
CURLOPT_MAXREDIRS => 10, |
|
|
CURLOPT_TIMEOUT => 30, |
|
|
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, |
|
|
CURLOPT_CUSTOMREQUEST => "GET", |
|
|
CURLOPT_POSTFIELDS => "", |
|
|
CURLOPT_HTTPHEADER => array( |
|
|
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d", |
|
|
"cache-control: no-cache" |
|
|
), |
|
|
)); |
|
|
|
|
|
$response = curl_exec($curl); |
|
|
$err = curl_error($curl); |
|
|
|
|
|
curl_close($curl); |
|
|
|
|
|
if ($err) { |
|
|
echo "cURL Error #:" . $err; |
|
|
} else { |
|
|
echo $response; |
|
|
} |
|
|
</syntaxhighlight> |
|
|
}} |
|
|
|
|
|
====Response of Status==== |
|
|
<syntaxhighlight lang="json-object"> |
|
|
{ |
|
|
"RequestId": "t590eef-2337b-562f-8990-803cbc0b48636", |
|
|
"Status": "Completed" |
|
|
} |
|
|
</syntaxhighlight> |
|
|
|
|
|
|
|
|
<DRAFT>
Incompleted!
Get AR Invoice
Get an AR Invoice from account book.
API Method
Http Method: GET
Method: /api/public/v1/ARInvoice/GetARInvoice/{id}
Content-Type: application/json
Parameters: id
Id of the AR Invoice
API Request Flow
- Submit GetARInvoice request to retrieve one AR Invoice in account book.
- Check the successful request status, if the data is completed (ready).
- Retrieve the data with Result method.
Code Snippets
<?php
$request = new HttpRequest();
$request->setUrl('http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d',
'Content-Type' => 'application/json'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests
url = "http://aotg.cloud:8080/api/public/v1/ARInvoice/GetARInvoice/1455"
payload = ""
headers = {
'Content-Type': "application/json",
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
'cache-control': "no-cache"
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
Reponse
Response Successful HTTP Request
200 OK
Response Successful Body
Id can be used for checking the status of result.
Id and Name are required to retrieve result (data).
{
"Id": "t590eef-2337b-562f-8990-803cbc0b48636",
"Name": "GetARInvoice",
"StartTimestamp": "2019-03-05T01:39:20.7232199Z",
"EndTimestamp": "2019-03-05T01:39:20.7232199Z"
}
Check Status
Code Snippets
<?php
$request = new HttpRequest();
$request->setUrl('http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d");
IRestResponse response = client.Execute(request);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests
url = "http://aotg.cloud:8080/api/public/v1/Result/t590eef-2337b-562f-8990-803cbc0b48636"
payload = ""
headers = {
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
'cache-control': "no-cache"
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
Response of Status
{
"RequestId": "t590eef-2337b-562f-8990-803cbc0b48636",
"Status": "Completed"
}
Get Data (Result)
Code Snippets
<?php
$request = new HttpRequest();
$request->setUrl('http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'SOTC_AUTH' => 'SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
var client = new RestClient("http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("SOTC_AUTH", "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d");
IRestResponse response = client.Execute(request);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"SOTC_AUTH: SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests
url = "http://aotg.cloud:8080/api/public/v1/Result/GetARInvoice/t590eef-2337b-562f-8990-803cbc0b48636/result"
payload = ""
headers = {
'SOTC_AUTH': "SAMc13a36d2-a139-e911-b8b3-000d3aa04f3d",
'cache-control': "no-cache"
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
Response of Status
{
"RequestId": "t590eef-2337b-562f-8990-803cbc0b48636",
"Status": "Completed"
}
See Also AOTG API