-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns a list of materials that are registered in the provider. It is also possible to return materials that have been approved in the knowledge base but are not yet registered in the provider.
Syntaxe
public string GetSupplyModels(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 |
|
RetrieveKBModels |
Logical |
Yes |
- |
- |
- |
Indicates whether to retrieve only the provider's materials (false) or to also retrieve all materials approved in the knowledge base (true). If not specified, the web service defaults to false |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields to 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 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; 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 response format.
Possible error messages
Click here to see the possible error messages that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must have full permissions in Stock Administration.