IMS Web Service Reference

Method: SetMaterialGrouping

Description

Create or edit a material grouping and the associated material grouping specifications. If the given material grouping key is unknown a new material grouping will be created. Use the function GetNewMaterialGroupingKey to obtain a new material grouping key.                 Required privilege: "security.set_material_grouping".

Action

http://ims.lyngsoesystems.com/administration/SetMaterialGrouping

Input

The input of this method is the document element tns:SetMaterialGrouping having the structure defined by the following table.

Element  Type  Occurs  Description 
    1..1 
tns:Token  common:TokenType  1..1 
tns:BranchKey  common:BranchKeyType  1..1 
tns:BranchConfigurationKey  common:BranchConfigurationKeyType  1..1 
tns:MaterialGroupingKey  common:MaterialGroupingKeyType  1..1 
tns:MaterialGroupingSpecs  common:MaterialGroupingSpecInfoType  0..* 
tns:LocationKeys  common:LocationKeyType  0..* 
tns:Name  common:NameType  1..1 
tns:Description  common:LongDescriptionType  1..1 
tns:MeterMinPct  xsd:int  0..1 
tns:MeterMaxPct  xsd:int  0..1 
tns:CopiesMin  xsd:int  0..1 
tns:CopiesMax  xsd:int  0..1 
tns:AutomaticReplenish  xsd:boolean  1..1 
tns:AutomaticReplenishTarget  xsd:int  0..1 
tns:FineSortingKey  common:FineSortingKeyType  1..1 
tns:SortBySpecNo  xsd:boolean  1..1 
tns:SortByClassification  xsd:boolean  1..1 
tns:PlacementTypeKey  common:PlacementTypeKeyType  1..1 
tns:NonFloatPercentage  xsd:int  0..1 
tns:Closed  xsd:boolean  1..1 
tns:AutomaticRotation  xsd:boolean  1..1 
Output

The output of this method is the document element tns:SetMaterialGroupingResponse that is always empty.

Faults
Name  Content  Description 
InternalError  common:InternalErrorExceptionInfo 
InvalidArgument  common:InvalidArgumentExceptionInfo 
InvalidTokenException  common:InvalidTokenExceptionInfo 
InsufficientPrivileges  common:InsufficientPrivilegesExceptionInfo 
ParentNotFound  common:ParentNotFoundExceptionInfo 
IllegalMaterialGroupingSpec  common:IllegalMaterialGroupingSpecExceptionInfo 
IllegalClassificationInterval  common:IllegalClassificationIntervalExceptionInfo 
IllegalAlphabetisationInterval  common:IllegalAlphabetisationIntervalExceptionInfo