GetRelatedLots response message
- Last UpdatedSep 06, 2023
- 3 minute read
This is an example of the full structure of a GetRelatedLots response message.
<GetRelatedLotsResponse>
<Context>
<Localization />
<Language>
<StartingFilters>
<FilterValue>
<Name>Test1</Name>
<Value isNull="false"/>
</FilterValue>
<ResultFilters/>
<FilterValue>
<Name>Test2</Name>
<Value isNull="false"/>
</FilterValue>
</Context>
<RowSets>
<RowSet>
<Fields>
<Field>
<CanShow>False</CanShow>
<Category>Standard</Category>
<ClrFormat isNull="false"/>
<ClrType>System.String</ClrType>
<DisplayName>Lot ID</DisplayName>
<DisplayOrder>10010</DisplayOrder>
<LocalizedDisplayName>Lot ID</LocalizedDisplayName>
<Name>LotId</Name>
<SubCategory>Record Information</SubCategory>
<Units isNull="false"/>
</Field>
<Rows>
<Row>
<Columns>
<Column>
<Field>LotId</Field>
<IsValidForLocation>true</IsValidForLocation>
<Value>3</Value>
</Column>
<Column>
<Field>Lot</Field>
<IsValidForLocation>true</IsValidForLocation>
<Value>L201306120200</Value>
</Column>
<Column>
<Field>Material</Field>
<IsValidForLocation>true</IsValidForLocation>
<Value>Material Model.Raw Coal</Value>
</Column>
</Columns>
</Row>
</Rows>
</RowSet>
</RowSets>
</GetRelatedLotsResponse>
Response parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |
Response parameters: StartingFilters section
Reports details about the starting filters that were applied in the request.
<StartingFilters>
<FilterValue>
<Name>Material</Name>
<Value Coal"/>
</FilterValue>
|
Parameter |
Description |
|---|---|
|
FilterValue |
Contains the values of each individual starting filter. |
|
Name |
The name of a field used as a filtering option to identify lots. For example, any field name, such as Location, SampleDateTime, Material. |
|
Value |
The value for the specified field in filtering the search results. |
Response parameters: ResultFilters section
Reports details about the result filters that were applied in the request.
<ResultFilters/>
<FilterValue>
<Name>Test2</Name>
<Value isNull="false"/>
</FilterValue>
|
Parameter |
Description |
|---|---|
|
FilterValue |
Contains the values of each individual result filter. |
|
Name |
The name of a field used as a filtering option to identify lots, such as Location, SampleDateTime, Material. |
|
Value |
The value for the specified field in filtering the search results. |
Response parameters: Fields section
Contains the set of fields in a rowset.
<RowSets>
<RowSet>
<Fields>
<Field>
<CanShow>False</CanShow>
<Category>Standard</Category>
<ClrFormat isNull="false"/>
<ClrType>System.String</ClrType>
<DisplayName>Lot ID</DisplayName>
<DisplayOrder>10010</DisplayOrder>
<LocalizedDisplayName>Lot ID</LocalizedDisplayName>
<Name>LotId</Name>
<SubCategory>Record Information</SubCategory>
<Units isNull="false"/>
</Field>
|
Parameter |
Description |
|---|---|
|
Field |
Contains details about a field in the rowset. |
|
CanShow |
Specifies whether this field can show in the client. Can be True or False. |
|
Category |
The category to group fields in, when displayed in user input forms. For example, Standard. |
|
ClrFormat |
Format for the field value. Most often applies to numerical data, or time and dates. |
|
ClrType |
This value specifies the Common Language Runtime (CLR) type. It is much like a data type; for example, System.Int32, System.String, System.DateTime. |
|
DisplayName |
The name that appears in Production Analyst.String value. For example, CustomField. |
|
DisplayOrder |
This value is a calculation that reflects the combined values of the DisplayOrderGroup and the DisplayOrderIndex to determine the order of display. |
|
LocalizedDisplayName |
The localized name that appears in Production Analyst. |
|
Name |
The name given to identify an item in Studio. String value. For example, CustomField. |
|
SubCategory |
The subcategory to group fields in, when displaying in user input forms. For example, Field Data. |
|
Units |
The units of measurement used in the field values. |
Response parameters: Columns section
The set of columns in a row.
<Columns>
<Column>
<Field>LotId</Field>
<IsValidForLocation>true</IsValidForLocation>
<Value>3</Value>
</Column>
<Column>
<Field>Lot</Field>
<IsValidForLocation>true</IsValidForLocation>
<Value>L201306120200</Value>
</Column>
</Columns>
|
Parameter |
Description |
|---|---|
|
Column |
Contains details about a column. |
|
Field |
The name of the field. |
|
IsValidForLocation |
Specifies when a field is not relevant for that location in the project. Can be True or False. |
|
Value |
The value in the field. |