-
Web Service URL: https://[SERVER_ADDRESS]/PrintHostsWS/PrintHostsData.asmx
-
MPS Version: From 5.40.0
Description
This method returns the partner's print hosts.
Syntax
public string GetPrintHosts(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 |
- |
- |
- |
Provider user email |
|
EnterpriseID |
Número |
No |
- |
- |
- |
Company ID number. Obtained via the GetEnterprises method |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields to be returned by the method. They must be specified separated by the ‘;’ character. Example: EnterpriseID;PrintHostID;MachineName. 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 |
|
PrintHostID |
Print host ID in the system |
|
PrintHostKey |
Print host key |
|
ConfigMode |
Indicates the print host's operating mode (0 - cloud, 1 - migrating, 2 - local) |
|
MachineName |
Name of the server where the print host is installed |
|
OperationalSystem |
Operating system of the server where the print host is installed |
|
PrintHostVersion |
Print host version |
|
Removed |
Indicates whether the print host has been removed |
|
Uninstalled |
Indicates whether the print host has been uninstalled |
|
Deactivated |
Indicates whether the print host has been disabled |
|
CustomFields |
When requested, all additional fields configured for the print host are returned |
Return
Click here to learn more about the return format.
Possible return errors
Click here to see the possible errors that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must be an Administrator on the provider.