Web API - Revision history

Simon Clive at 04:48, 24 August 2012

2012-08-24T04:48:46Z

Simon Clive at 03:02, 27 February 2012

2012-02-27T03:02:19Z

Simon Clive at 02:42, 27 February 2012

2012-02-27T02:42:28Z

Simon Clive at 02:40, 27 February 2012

2012-02-27T02:40:10Z

Simon Clive at 01:52, 27 February 2012

2012-02-27T01:52:31Z

Simon Clive at 01:47, 27 February 2012

2012-02-27T01:47:27Z

Dene at 02:29, 9 August 2011

2011-08-09T02:29:05Z

Dene at 02:24, 9 August 2011

2011-08-09T02:24:16Z

Dene: Created page with " More Detail= Audit Trail List Backup Company Information Export to Report DB Multi-site Preferences Restore [[Setu..."

2011-08-09T02:22:42Z

Created page with "<menu align="center" name="myMenu"> More Detail= Audit Trail List Backup Company Information Export to Report DB Multi-site Preferences Restore [[Setu..."

New page

<menu align="center" name="myMenu">
More Detail=
[[Audit Trail List]]
[[Backup]]
[[Company Information]]
[[Export to Report DB]]
[[Multi-site]]
[[Preferences]]
[[Restore]]
[[Setup Docs Path]]
[[Utilities Reports]]
</menu>

== Overview ==

First step is to create a user, with a password inside the required ERP Data file such as the "Sample_Company" file. This user is what the web API will use to connect to the ERP database. Typically you would create in ERP a user called "WebUser" with a Password like "WebUser"

Second step from within the software development environment that you are working in, use their HTTPS component or library to send requests to the ERP Web API.

Inside this HTTPS component or library the request must contain:
- a HTTP request Username that matches the ERP Username ie "WebUser"
- a HTTP request Password that matches the ERP Password ie "WebUser"
- HTTP request custom headers must have a "database" value containing the name of the ERP database ie "Sample_Company"

To read data from the ERP Web API send a HTTP GET command using the following format:
https://[server name]/erpapi/[resource name]/[optional resource ID]

or using the samples above
https://Server1/erpapi/TCustomer/114

This will give you all of the details for customer 114 in the "Sample_Company" on "Server1"

or using the samples above
https://Server1/Sample_Company/TCustomer

This will give you a list of all of the customer in "Sample_Company" on "Server1"

To write data back to ERP send a HTTP POST command using the following format:
https://[server name]/erpapi/[resource name]

or using the samples above
https://Server1/Sample_Company/TCustomer

This will create a new customer in "Sample_Company" on "Server1"

or using the samples above
https://Server1/Sample_Company/TCustomer/114

This will edit customer 114 in the "Sample_Company" on "Server1"

If the request JSON object does not contain an ID the API will attempt to create a new instance of that particular object.
If the request JSON object does contain an ID the API will attempt to update the existing ERP object with the JSON data provided in the POST.

API Request Results.
All requests will return a HTTP respone of 200 if no errors where encountered.
If an error occures a non 200 code will be returned and the HTTP responce custom headers will contain a "errormessage" value.

When adding a new object (HTTP POST) the responce body JSON contains the ID of the newly created object, eg after adding a new customer:

{
"type":"TCustomer",
"fields":
{
"ID":115
}
}

What is a HTTP request
http://djce.org.uk/dumprequest

Example of the HTTP request for Visual Studio
http://www.codeproject.com/KB/IP/httpwebrequest_response.aspx

@@ Line 39: / Line 39: @@
 To write data back to ERP send a HTTP POST command using the following format: https://[server name]/erpapi/[resource name]
-or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TInvoice]]
+or using the samples above [[Web API Examples|https://Server1/Sample_Company/TInvoice]]
 This will create a new Invoice in "Sample_Company" on "Server1"
-or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TInvoice/1768]]
+or using the samples above [[Web API Examples|https://Server1/Sample_Company/TInvoice/1768]]
 This will edit Invoice 1768 in the "Sample_Company" on "Server1"
@@ Line 56: / Line 56: @@
 { "type":"TInvoice", "fields": { "ID":1768 } }
 <br>

@@ Line 27: / Line 27: @@
 To read data from the ERP Web API send a HTTP GET command using the following format: https://[server name]/erpapi/[resource name]/[optional resource ID]
-or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TCustomer]]
+or using the samples above [[Web API Examples|https://Server1/Sample_Company/TCustomer]]
 This will give you a list of all of the customer in "Sample_Company" on "Server1"<br>
-or using the samples above [[Web_API_Examples|https://Server1/erpapi/TCustomer/5]]
+or using the samples above [[Web API Examples|https://Server1/erpapi/TCustomer/5]]
 This will give you all of the details for customer 5 in the "Sample_Company" on "Server1"
@@ Line 39: / Line 39: @@
 To write data back to ERP send a HTTP POST command using the following format: https://[server name]/erpapi/[resource name]
-or using the samples above https://Server1/Sample_Company/TInvoice
+or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TInvoice]]
 This will create a new Invoice in "Sample_Company" on "Server1"
-or using the samples above https://Server1/Sample_Company/TInvoice/1768
+or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TInvoice/1768]]
 This will edit Invoice 1768 in the "Sample_Company" on "Server1"
@@ Line 53: / Line 53: @@
 API Request Results. All requests will return a HTTP respone of 200 if no errors where encountered. If an error occures a non 200 code will be returned and the HTTP responce custom headers will contain a "errormessage" value.
-When adding a new object (HTTP POST) the responce body JSON contains the ID of the newly created object, eg after adding a new customer:
+When adding a new object (HTTP POST) the responce body JSON contains the ID of the newly created object, eg after adding a new Invoice:
 { "type":"TInvoice", "fields": { "ID":1768 } }

@@ Line 23: / Line 23: @@
 Inside this HTTPS component or library the request must contain: - a HTTP request Username that matches the ERP Username ie "WebUser" - a HTTP request Password that matches the ERP Password ie "WebUser" - HTTP request custom headers must have a "database" value containing the name of the ERP database ie "Sample_Company"
+<br>
 To read data from the ERP Web API send a HTTP GET command using the following format: https://[server name]/erpapi/[resource name]/[optional resource ID]
-or using the samples above https://Server1/Sample_Company/TCustomer
+or using the samples above [[Web_API_Examples|https://Server1/Sample_Company/TCustomer]]
 This will give you a list of all of the customer in "Sample_Company" on "Server1"<br>
-or using the samples above https://Server1/erpapi/TCustomer/5
+or using the samples above [[Web_API_Examples|https://Server1/erpapi/TCustomer/5]]
 This will give you all of the details for customer 5 in the "Sample_Company" on "Server1"
+<br>
 To write data back to ERP send a HTTP POST command using the following format: https://[server name]/erpapi/[resource name]
 or using the samples above https://Server1/Sample_Company/TInvoice
 This will create a new Invoice in "Sample_Company" on "Server1"
 or using the samples above https://Server1/Sample_Company/TInvoice/1768
 This will edit Invoice 1768 in the "Sample_Company" on "Server1"
+<br>
 If the request JSON object does not contain an ID the API will attempt to create a new instance of that particular object. If the request JSON object does contain an ID the API will attempt to update the existing ERP object with the JSON data provided in the POST.

@@ Line 14: / Line 14: @@
 == Overview  ==
 '''Creating the communication link'''
 '''First step''' is to create a user, with a password inside the required ERP Data file such as the "Sample_Company" file. This user is what the web API will use to connect to the ERP database. Typically you would create in ERP a user called "WebUser" with a Password like "WebUser"
@@ Line 23: / Line 23: @@
 To read data from the ERP Web API send a HTTP GET command using the following format: https://[server name]/erpapi/[resource name]/[optional resource ID]
 or using the samples above https://Server1/Sample_Company/TCustomer
 This will give you a list of all of the customer in "Sample_Company" on "Server1"
 To write data back to ERP send a HTTP POST command using the following format: https://[server name]/erpapi/[resource name]
@@ Line 50: / Line 54: @@
 { "type":"TCustomer", "fields": { "ID":115 } }
 '''What is a HTTP request http://djce.org.uk/dumprequest'''
 '''What is a HTTP request http://djce.org.uk/dumprequest'''
 '''Example of the HTTP request for Visual Studio http://www.codeproject.com/KB/IP/httpwebrequest_response.aspx'''

@@ Line 1: / Line 1: @@
-<menu align="center" name="myMenu">
+<menu name="myMenu" align="center">
 More Detail=
 [[Audit Trail List]]
@@ Line 10: / Line 10: @@
 [[Setup Docs Path]]
 [[Utilities Reports]]
 </menu>
@@ Line 28: / Line 29: @@
 This will give you a list of all of the customer in "Sample_Company" on "Server1"
+<br>
-−
 or using the samples above https://Server1/erpapi/TCustomer/114