SOAP 3 Callback Documentation
From
(Difference between revisions)
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The following callback interface is designed using VS2008 and ASMX. | + | The following callback interface is designed using VS2008 and ASMX. The WSDL for this interface, which the external party (i.e. you) will need to provide and implement, is available here: [[SOAP_3_Callback_WSDL]] |
| + | |||
| + | An implementation of a callback service is also uploaded on our [http://sourceforge.net/projects/econz-eservice project page] on Sourceforge (note, for the EService system to call your callback service, it must be [[RegisterCallback|registered]] first). This implemenation contains a callback service written in ASMX and in WCF. | ||
Need to implement '''three''' core methods (getVersion, heartBeat and eventSeq): | Need to implement '''three''' core methods (getVersion, heartBeat and eventSeq): | ||
| − | < | + | <source lang="csharp"> |
namespace soap2.nads.econz.co.nz | namespace soap2.nads.econz.co.nz | ||
{ | { | ||
| Line 20: | Line 22: | ||
{ | { | ||
// TODO: Implementation | // TODO: Implementation | ||
| + | // The heartbeat method is called every minute by the EService callback manager. | ||
| + | |||
} | } | ||
| Line 26: | Line 30: | ||
{ | { | ||
// TODO: Implementation | // TODO: Implementation | ||
| + | // This will get fired on every user interaction which changes the state of a job, i.e. create job, dispatch, etc. | ||
} | } | ||
} | } | ||
} | } | ||
| − | </ | + | </source> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | *[[CallbackVersion]] enumerand definition | |
| − | [[ | + | *[[UserIDBean]] object definition |
| + | *[[EventBean]] object definition | ||
Latest revision as of 22:06, 10 September 2015
The following callback interface is designed using VS2008 and ASMX. The WSDL for this interface, which the external party (i.e. you) will need to provide and implement, is available here: SOAP_3_Callback_WSDL
An implementation of a callback service is also uploaded on our project page on Sourceforge (note, for the EService system to call your callback service, it must be registered first). This implemenation contains a callback service written in ASMX and in WCF.
Need to implement three core methods (getVersion, heartBeat and eventSeq):
namespace soap2.nads.econz.co.nz { [WebService(Namespace = "http://soap2.nads.econz.co.nz")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] public class NADSCallbackService : System.Web.Services.WebService { [WebMethod] public CallbackVersion getVersion() { return CallbackVersion.VERSION_2; // should match the version of the callback interface } [WebMethod] public void heartBeat(int errorsSinceLastSuccess) { // TODO: Implementation // The heartbeat method is called every minute by the EService callback manager. } [WebMethod] public void eventSeq(UserIDBean externalServiceID, EventBean[] eventBeans) { // TODO: Implementation // This will get fired on every user interaction which changes the state of a job, i.e. create job, dispatch, etc. } } }
- CallbackVersion enumerand definition
- UserIDBean object definition
- EventBean object definition
