Appendix

Response parameters

method materials

• Rows - Collection of Material objects. Object.
• Material.Cas - CAS number. String. Up to 20 chars.

• • Material.CwNo - CW numbers, CW ID. String, Up to 15 chars.
  • Material.Id - Material Id. Number.
  • Material.IsGold - Flag showing is there is a Gold material written for CW ID. True/false.
  • Material.MaterialData - Object defining material Properties, mostly internal, but some fields can be used for sorting and filtering the results or visualisation of material properties. Collection of Objects.

• • • Material.MaterialData.RN - Internal. Number.
    • Material.MaterialData.RATE - Relevance number. how close the match is to the search string. Can be used for sorting and filtering results. Number.
    • Material.MaterialData.CW - CW Id. Number.
    • Material.MaterialData.Name - Matrial name. String. Up to 200 chars.
    • Material.MaterialData.Synonym_Name - Synonyms. String. Up to 4000 chars.
    • Material.MaterialData.CAS - CAS. String. 20 chars.
    • Material.MaterialData.ISCWGOLD - Internal Gold flag. 1 or 0.
    • Material.MaterialData.GID - Internal. Verndor group name. String.
    • Material.MaterialData.Document_Name - Inetrnal. Name of a document if available. String.
    • Material.MaterialData.Is_Exact_Match - Internal. Indicates if a result is exact match. 1 or 0.
    • Material.MaterialData.Mat_RowId - Internal. Number
    • Material.MaterialData.DGC - Inetrnal. Dangerous Goods Class. String. 20 chars.
    • Material.MaterialData.DANSTATE - Dangerous state indicator. String. 20 chars.
    • Material.MaterialData.HAZSTATE - Hazardour indicator. String. "Hazardous" or "Non hazardous".
    • Material.MaterialData.ISSDT - Latest issues date of a document. Date. Formatt accordingly to domain settings.
    • Material.MaterialData.PG - Packaging group. String. "I", "II", or "III".
    • Material.MaterialData.PHYSSTATE - Physical state. String. Examples: Liquid, Solid, Gaz, etc. Up to 50 chars.
    • Material.MaterialData.PURE - Indicator if a material is a pure chemical. True/False.
    • Material.MaterialData.R_CODE - List of R codes. String. Upt to 4000 chars.
    • Material.MaterialData.SUBRISK - Sub risk. String. Up to 20 chars,
    • Material.MaterialData.STRIPPED_NAME - Internal. Used for search. String. 250 chars.
    • Material.MaterialData.UN - UN number. String, Up to 20 chars.
    • Material.MaterialMaterial.Data.SEARCH_NAME - Internal. Used for search. String. 250 chars.
    • Material.MaterialData.PREFRRED_NAME - Preferred name as pspecified by user and selected by engine (one of many). Steing. 250 chars.
    • Material.MaterialData.PREFRRED_NAMES - Preferred names list. String. Up to 4000 chars.
    • Material.MaterialData.SORT_NAME - Internal. Used for sorting. String. 250 chars.
    • Material.MaterialData.IS_HIDDEN- a flag indicating if a material is hidden (visible only to users with a permission). 1 or 0.
    • Material.MaterialData.RED_FLAG - Inidicates if a chemical has been red flagged. 1 or 0.
    • Material.MaterialData.VENDORNAMES - Names of vendors available in user Own collection. String. 4000 chars.
    • Material.MaterialData.VENDOR_NAME - Name of a venodr selected by engine (one of many). String. 250 chars.
    • Material.MaterialData.HAZRATE - Indicator of a hazard rating. 1 char.
    • Material.MaterialData.DOCUMENTS_COUNT - Count of document available / related to the material. Number.
    • Material.MaterialData.TAG_IDS - Tag id numbers. List of numbers.
    • Material.MaterialData.IS_VGD - Flag indicating data extracted. Internal. 1 or 0.

Use cases

Getting data for a material found using Search

If the client needs to find a material first and only then request data or document then the following sequence of calls would be required:

1. materials - search by name or cas, with or without vendor
2. materialsdata OR pdfreport - use cw number obtained from materials call 

GET   http://dev.chemwatch.net/api/v1/FolderIdByFullPath?path=ENTERPRISE/FOLDERS/benz