- 1 Minute to read
- Print
- Dark
- PDF
Segment1_Retrieve
- 1 Minute to read
- Print
- Dark
- PDF
Retrieves the collection of Segment1 objects that meet the filter criteria supplied. Each segment1 object returned from this method corresponds to a data row of segment1 in the database.
Syntax
Usage
Use the Segment1_Retrieve call to retrieve Segment1 data. When a Client application invokes the Segment1_Retrieve call, it passes the segment1 filter criteria in collection of Segment1Filter objects to filter the data rows.
Upon invocation, the Web Service queries the database for segment1 data rows with the specified filter criteria and returns the collection of segment1 objects. Each segment1 object corresponds to a data row in the database. The Client application can then use methods on the collection of segment1 objects to iterate through the collection and retrieve information. The Client application must be logged in with sufficient access rights to query segment1 objects.
Arguments List
The following table provides a list of arguments that are required for the Segment1_Retrieve method call:
Name | Type | Description |
---|---|---|
Segment1Filter | Segment1F | Collection of segment1 filter objects to filter the segment1 data rows during retrieval. |
Response
The Segment1_Retrieve method call returns a collection of Segment1 objects, which contain the data values of segment1 data rows in the database. In recent updates, the retrieved data will also have the IDs of all the Leaf, Roll-Up, and Parent Members.
Parent Code, Parent Name
There are two separate fields (i.e., columns) for Parent Code and Parent Name.
Sample Code