-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.39.0
Summary
This method returns a list of supplies compatible with a printer's slot.
Syntax
public string GetCompatibleSupplyModelsFromSlot(string properties)
Setting Properties
The content of string properties must be text in JSON format containing the properties listed below. For example:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
You don't need to worry about whether property names are uppercase or lowercase; the Web Service is Case-Insensitive.
Properties accepted by the method
|
Property |
Type |
Required |
Allows null |
Allows empty |
Maximum size |
Description |
|
DealerName |
Text |
Yes |
- |
- |
- |
Provider name |
|
DealerUserEmail |
Text |
Yes |
- |
- |
- |
Provider user email |
|
DealerUserPassword |
Text |
Yes |
- |
- |
- |
Encrypted user password |
|
EnterprisePrinterDeviceSlotID |
Número |
Yes |
- |
- |
- |
The number for a printer slot. Retrieved using the GetPrintersSlots method |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
A list of the fields that will be returned by the method. They must be specified separated by a semicolon (;). Example: “SupplyModelID;BrandID;BrandName” When no fields are specified, the response will contain the fields shown in bold in the table below |
Return fields recognized in FieldsList
|
Field name |
Description |
|
SupplyModelID |
Supply model identifier (material) in the system |
|
BrandID |
Material manufacturer identifier; for materials without a manufacturer (provider type), the value 0 is returned |
|
BrandName |
Material manufacturer name; left blank for materials without a manufacturer (provider type) |
|
SupplySlotID |
Slot identifier |
|
SupplySubFunctionTypeID |
Material type identifier |
|
SupplySubFunctionTypeName |
Material Type Name |
|
SupplyColorID |
Material Color ID |
|
SupplyColorName |
Material Color Name |
|
PartNumber |
Material PartNumber |
|
Capacity |
Material Page Capacity |
|
SupplyModelQualityID |
Material Quality ID |
|
SupplyModelQualityName |
Material Quality Name |
|
Description |
Material Description provided by the provider |
|
PartnerModelCode |
Internal Material Code provided by the provider |
Click here to learn more about the response format.
Possible error codes
Click here to view the possible error codes that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must have at least Restricted Replenishment Flow permission in the provider;
-
The user must have monitoring permission in the company or at the site where the printer is located.