-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx
-
MPS Version: From 5.3.0
Description
This method returns the list of materials that are registered with the provider. It is also possible to return materials that are approved in the knowledge base but are not yet registered with the provider.
Syntax
public string GetSupplyModels(string dealerName, string dealerUserEmail, string dealerUserPassword, bool retrieveKBModels, string fieldsList)
Parameters
-
dealerName: Name of the provider;
-
dealerUserEmail: Email address of the provider user;
-
dealerUserPassword: Encrypted user password;
-
retrieveKBModels: Indicates whether to retrieve only the providers' materials (false) or also all approved materials in the knowledge base (true);
-
fieldsList: List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterDeviceID;SiteID;SiteName.
-
When no fields are specified, the response will contain the fields that are in bold in the table below.
-
Recognized return fields 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; blank for materials without a manufacturer (provider type) |
|
SupplyColorID |
Material color identifier |
|
SupplyColorName |
Material color name |
|
SystemType |
Indicates whether the material type is a system type or a type registered by the provider. (1 - system type, 0 - provider type) |
|
SupplySubFunctionTypeID |
Material type identifier |
|
SupplySubFunctionTypeName |
Material type name |
|
Description |
Material description provided by the provider |
|
InternalCode |
Internal material code provided by the provider |
|
PartNumber |
Material PartNumber |
|
Capacity |
Material page capacity |
|
SupplyModelQualityID |
Material quality identifier |
|
SupplyModelQualityName |
Material quality name |
|
Cost |
Internal material cost provided by the provider |
Click here to learn more about the format of the returns.
Possible errors returned
Click here to check the possible errors that may be returned and learn about their reasons.
Restrictions
-
To execute this method, the user must have full permission in Inventory Administration.