Request parameters
This section explains each L-Platform API request parameter in table format.
Parameter name | Item | Item description |
---|---|---|
Request parameter name (*) | Description | This item explains each parameter. |
Type | This item indicates the parameter type. | |
Value | This item indicates the value of each parameter. It also explains specific values when fixed values or actual setting ranges are given. |
* Note: Parameters enclosed in square brackets ("[ ]") are optional.
Request body
The following explains the body to be set in L-Platform API requests.
<XML>
This explains XML format request bodies.
<Parameter>
This table provides an explanation for each of the parameters:
Parameter name | Item | Item description |
---|---|---|
Request parameter name (*) | Description | This item explains each parameter. |
Type | This item indicates the parameter type. | |
Value | This item indicates the value of each parameter. It also explains specific values when fixed values or actual setting ranges are given. |
* Note: Parameters enclosed in square brackets ("[ ]") are optional.
Response
This section explains L-Platform API responses.
<Status code>
This section explains the status codes.
<XML>
This section explains responses in XML format.
<Elements>
This section explains each element in table format.
Element name | Item | Item description |
---|---|---|
Name of an element in the response | Description | This item explains each of the elements in the response. |
Type | This item indicates the type of each element in the response. | |
Number of occurrences | This item indicates the number of occurrences of each element in the response. It also explains what happens if the number of occurrences varies depending on parent/child relationships for the element. |
Sample response
This section presents a sample L-Platform API response. Responses are in XML format.
Note
In this manual, the order of tags that appear in the output results of L-Platform APIs may differ from the order of the elements listed in the response description table.