RetailCommonWebAPI Class [AX 2012]
The RetailCommonWebAPI class is the class grouping several over-the-web communication methods like sending an HTTP POST or GET requests and transforming the response to X++ data structures.
Syntax
class RetailCommonWebAPI
Run On
Called
Methods
Method | Description | |
---|---|---|
![]() |
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
![]() |
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
![]() |
getResponse | Get retail web access request. |
![]() |
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
![]() |
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
![]() |
makeDeleteRequest | Performs HTTP request using the DELETE method. |
![]() |
makeFormPost | Performs HTTP request using the POST method and content encoded using multipart/form-data encoding.This method allows to provide a Map of key/value pairs for data representable as a text using the _strFields parameter, as well as a Map of key/value pairs for binary data using the _docFields parameter.Optionally, a custom HTTP header can be set through the _header parameter. |
![]() |
makePostRequest | Performs HTTP request using the POST method.This method allows to provide the raw data using the _postData parameter.Note that the data will be encoded with the UTF-8 encoding.Optionally, a custom HTTP header can be set through the _header parameter.The default content type can be overriden using the optional _contentType parameter. |
![]() |
makeRequest | Performs HTTP request using the GET method. |
![]() |
new | Initializes a new instance of the RetailCommonWebAPI class. |
![]() |
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
![]() |
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
![]() |
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
![]() |
owner | Returns the instance that owns the object. (Inherited from Object.) |
![]() |
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
![]() |
toString | Returns a string that represents the current object. (Inherited from Object.) |
![]() |
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
![]() |
wait | Pauses a process. (Inherited from Object.) |
![]() |
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
![]() ![]() |
::construct | Initializes a new instance of the RetailCommonWebAPI class. |
![]() ![]() |
::convertCLRObjectToContainer | |
![]() ![]() |
::endBrowserSession | Ends web-browser session of WeBrowser .Net managed control. |
![]() ![]() |
::getList | |
![]() ![]() |
::getMap | |
![]() ![]() |
::getMapFromJsonString | Decodes JSON-encoded object tree represented as a string |
![]() ![]() |
::getMapFromQueryString | Returns a Map of the key/value pairs of the supplied request query string.The query string is expected to have the following format: para1=value1¶2=value2 So, key/value pairs must be separated with '&' characters and keys and values must be separated with '=' character. |
![]() ![]() |
::getMultipartFormData | |
![]() ![]() |
::readResponseData | |
![]() ![]() |
::writeRequestData |
Top
Inheritance Hierarchy
Object Class
RetailCommonWebAPI Class