GetVersion
This method is the simplest one in EC. It simply returns the version number of Perfion.
GetVersion | |
Parameters | None |
Sample request | <Execute method="GetVersion" /> |
Sample result | <Response>
<Result>
<Version>4.5.31</Version>
</Result>
</Response> |
Table 14: GetVersion-method.
As can be seen a request is simply an Xml-document with a root-element named Execute that has a method-attribute telling which method to call. In the case GetVersion.
Notice in Table 14 how a response from EC looks. It is always a root-element named Response with either a “Result”-element if everything went well or an “Error”-element if something when wrong. A sample Response with an error can be seen in Table 15 below. The error here is provoked by the fact that we asks for product from a non-existing Channel. Without a proper channel EC does not know which settings and mappings to use and returns an error as shown here:
Sample error using GetProducts | |
Sample request | <Execute method="GetProducts" refreshconfiguration="true">
<Parameter id="Channel" value="Non-existing Channel" />
</Execute> |
Sample result | <Response>
<Error>
<Exception>ChannelDoesNotExistException</Exception>
<Message>Supplied channel 'Non-existing Channel' does not exist!</Message>
<StackTrace>(Stack trace removed for brevity)</StackTrace>
</Error>
</Response> |
Table 15: Error provoked by supplying a non-existing channel to GetProducts-method.