Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Client Request Elements

This section provides a detailed description of each element in a CoA/DM client request. A description is provided for each element, along with both the XML format and schema representation.

Element: attribute

In the CoA/DM client request, attributes are not differentiated by type (required, default) because they are used to provide values for both key attributes and action attributes. All attributes are represented as <attribute> nodes with a value. If the name of the attribute matches the name of an attribute in a dictionary on Steel-Belted Radius Carrier, then the value must conform to the data type of that attribute. For example, if the data type is integer, then the value must be a quoted integer. If the data type is octets or hex, the value must be either a quoted string (to be interpreted as ASCII), or a quoted string of the form “{hex}0123456789abcdef” to directly specify the binary payload of the attribute.

If the enabled attribute is set to false, then the attribute is ignored. This syntax is supported only for the convenience of Web GUI, so that attributes can be ignored without having to take them out of the XML. Using this feature is not normally required because you can simply omit the attribute.

XML Instance Representation

<attribute
enabled="boolean [0..1]"
name="string [1]"
value="string [1]"/>

Schema Component Representation

<element name="attribute">
<complexType>
<attribute name="enabled" type=" boolean "/>
<attribute name="name" type=" string " use="required"/>
<attribute name="value" type=" string " use="required"/>
</complexType>
</element>

Element: attributes

This element groups a set attribute nodes. The request can include any number of attributes nodes in order to group attributes in some arbitrary way. These groupings have no semantic meaning, but can make it easier to structure the client request. You do not need to have more than one attribute node.

XML Instance Representation

<attributes>
<attribute> ... </attribute> [1..*]
</attributes>

Schema Component Representation

<element name="attributes">
<complexType>
<sequence>
<element ref=" attribute " maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>

Element: body

This element has no semantic function and is placed in the output to mirror the structure of a SOAP request.

XML Instance Representation

<body>
<request> ... </request> [1]
</body>

Schema Component Representation

<element name="body">
<complexType>
<sequence>
<element ref=" request "/>
</sequence>
</complexType>
</element>

Element: envelope

This element has no semantic function and is placed in the output to mirror the structure of a SOAP request.

XML Instance Representation

<envelope>
<header> ... </header> [1]
<body> ... </body> [1]
</envelope>

Schema Component Representation

<element name="envelope">
<complexType>
<sequence>
<element ref=" header "/>
<element ref=" body "/>
</sequence>
</complexType>
</element>

Element: header

This element has no semantic function and is placed in the output to mirror the structure of a SOAP request.

XML Instance Representation

<header/>

Schema Component Representation

<element name="header">
<complexType/>
</element>

Element: request

This element represents the client request. Its contents become the clientRequest element in the response. (See Client Response Schema Example.) The action attribute specifies the name of an action that must match one of the actions defined in the deviceModels.xml file. For more information about action names see How Steel-Belted Radius Carrier Processes CoA/DM Messages.

The force argument specifies whether to execute the action if the number of affected sessions exceeds the defined session limit. See Setting Session Limits Using the Command Line Utility for information about the effects of setting the force argument in addition to session limits.

The session limit argument specifies the number of sessions to be maximally affected by the action. For example, a Disconnect action for user “b*” disconnects at most the number of sessions defined by session limit. If force is not specified, the action is aborted if too many sessions are matched. If force is specified, the action proceeds and only the number of sessions specified by session limit are affected.

XML Instance Representation

<request
action="string [1]"
force="boolean [0..1]"
session_limit="integer [0..1]">
<attributes> ... </attributes> [1..*]
</request>

Schema Component Representation

<element name="request">
<complexType>
<sequence>
<element ref=" attributes " maxOccurs="unbounded"/>
</sequence>
<attribute name="action" type=" string " use="required"/>
<attribute name="force" type=" boolean "/>
<attribute name="session_limit" type=" integer "/>
</complexType>
</element>

Modified: 2017-09-27