Search Dynamic Memory
Returns a list of Dynamic Memory files for the provided Vendor ID and parameters.
| Method Type | URI |
|---|---|
| GET |
/v90/ws/vendor/{vendorId}/dynamicMemory.ws ?memoryNameString={memoryNameString} &identifierString={identifierString} &refIdString={refIdString} &refIdString2={refIdString2} &fileId={fileId} |
Example URL: http://hostname:8080/ems/v90/ws/vendor/1/dynamicMemory?refIdString=1&refIdString2=2
URI Parameters
| Parameter | Description | Type |
|---|---|---|
| vendorId | (Required) Identifier of the Vendor in the database. | Integer |
| memoryNameString | (Optional) Dynamic Memory file name. | String |
| identifierString | (Optional) System generated unique identifier for the Dynamic Memory file. | String |
| refId1 | (Optional) Reference ID 1. Identifier of the Product in another system Like CRM/ERP. | String |
| refId2 | (Optional) Reference ID 2. | String |
| fileId | (Optional) Dynamic memory file ID. | Integer |
Sample Response
HTTP Status Code: 200
Success
Response Header:
X-Total-Count: The total number of entries. You can use X-Total-Count to calculate the total number of pages by dividing X-Total-Count by pageSize (X-Total-Count÷pageSize=number of pages). For example, suppose your application returns an X-Total-Count of 17 and the pageSize is 15. 17÷15=1.333 or 2 pages in total because each page includes a maximum of 15 entries. Similarly, suppose your application returns an X-Total-Count of 1103 and the pageSize is 15. 1103÷15=73.533 or 74 pages in total.
Response Body
<listResponse type="dynamicMemory" count="3"> <instances> <instance id="1" name="aa_dm1" type="2" fieldId="1" refId1="1" refId2="2" memoryDescription=""/> <instance id="2" name="aa1" type="2" fieldId="1" refId1="1" refId2="2" memoryDescription=""/> <instance id="3" name="e" type="2" fieldId="3" refId1="1" refId2="2" memoryDescription=""/> </instances> </listResponse>
NOTE The order of the search result is decided on the basis of MemoryId which acts as a unique identifier for each dynamic memory in the database.
Failure
HTTP Status Code: 200
Response Body
<listResponse type="dynamicMemory" count="0"></listResponse>