to_xml(options={}) public

A method to convert the the resource to an XML string.


The options parameter is handed off to the to_xml method on each attribute, so it has the same options as the to_xml methods in Active Support.

  • :indent - Set the indent level for the XML output (default is 2).
  • :dasherize - Boolean option to determine whether or not element names should replace underscores with dashes (default is false).
  • :skip_instruct - Toggle skipping the instruct! call on the XML builder that generates the XML declaration (default is false).


  my_group = SubsidiaryGroup.find(:first)
  # => <?xml version="1.0" encoding="UTF-8"?>
  #    <subsidiary_group> [...] </subsidiary_group>

  my_group.to_xml(:dasherize => true)
  # => <?xml version="1.0" encoding="UTF-8"?>
  #    <subsidiary-group> [...] </subsidiary-group>

  my_group.to_xml(:skip_instruct => true)
  # => <subsidiary_group> [...] </subsidiary_group>
Show source
Register or log in to add new notes.