-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.39.0
Description
This method returns a list of printers and their slots.
Syntax
public string GetPrintersSlots(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 |
|
EnterpriseID |
Number |
No |
- |
- |
- |
Company ID (required when specifying the PrinterDeviceID). Obtained via the GetEnterprises method |
|
PrinterDeviceID |
Number |
No |
- |
- |
- |
Printer ID. Obtained via the GetPrinters method |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields that will be returned by the method. They must be specified by separating them with the ‘;’ character. Example: EnterpriseID;PrinterDeviceID;EnterprisePrinterDeviceSlotID. 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 |
|
EnterpriseID |
Company ID in the system |
|
PrinterDeviceID |
Printer ID in the system. This ID is valid only for the company specified in the call, as the same ID may be used by another company |
|
EnterprisePrinterDeviceSlotID |
Printer slot ID |
|
SupplySubFunctionTypeID |
Material type ID |
|
SupplySubFunctionTypeName |
Material type name |
|
SupplyColorID |
Material color identifier |
|
SupplyColorName |
Material color name |
|
Position |
Printer slot position |
|
Flow |
Indicates whether it is in the replenishment flow |
Click here to learn more about the response format.
Possible errors returned
Click here to view the possible errors 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.