Get Master Data

Query master data from PDI including customers, products, sites, tank types, and terminals.

Operation

getMasterData

Resource

masterData

Parameters

Parameter	Type	Required	Default	Description
Filter	options	No	all	Filter which type of master data to return
Mode	options	No	0	The retrieval mode for master data

Filter Options

Value	Description
all	Return all master data types
customers	Return only customer records
products	Return only product records
sites	Return only site records
tankTypes	Return only tank type records
terminals	Return only terminal records

Mode Options

Value	Description
0	Retrieve all data
1	Retrieve only changed data

Options

Option	Type	Default	Description
Include Debug Info	boolean	false	Whether to include raw request/response data for debugging

Response

Success

{
  "success": true,
  "filter": "customers",
  "data": [
    {
      "CustomerID": "CUST001",
      "CustomerName": "Acme Corp",
      "CustomerType": "Commercial",
      "Address": "123 Main St",
      "City": "Dallas",
      "State": "TX",
      "ZipCode": "75201"
    }
  ],
  "httpStatusCode": 200
}

Error

{
  "success": false,
  "error": "Failed to parse response: Invalid XML",
  "httpStatusCode": 500
}

Error Handling

• Missing API URL: PDI credential is missing apiUrl
• Missing Password: PDI credential is missing password
• Missing Partner ID: PDI credential is missing partnerId
• SOAP Fault: Error returned from PDI SOAP service
• Parse Error: Failed to parse XML response