Powershell Invoke-RestMethod 将 XML 响应转换为 JSON 文本

Question

I am trying to use the Invoke-RestMethod command to grab the XML response from a SOAP endpoint and convert it to JSON text. From what I have read, the Invoke-RestMethod should be converting the response to a custom object for me so this should be really simple... This is what I am trying....

$APIRequest = Invoke-RestMethod -Method Post -Uri $SOAPEndpointURL -Headers $requestHeader -Body $requestBody
$JSONResponse = ConvertTo-Json $APIRequest.Envelope -Depth 9

But this is what i get as the resulting JSON text?

[ [ [ [ [ [ [ [] ], [], [ [] ], [], [ [] ], [ [] ], [ [] ], [ [] ], [ [] ], [ [] ], [ [] ], [ [] ], [ [] ], [], [], [ [] ], [ [] ], [ [] ], [ [] ], [], [ [] ], [ [] ], [ [] ], [ [] ], [], [ [] ], [ [] ], [ [] ], [ [] ] ] ], [ [] ], [] ] ] ] ]

Can anyone suggest a standard way to do this without trying to interpret the XML response manually as XML text?

If I update my request to create an output file too then I can see the proper XML response in the file.

$APIRequest = Invoke-RestMethod -Method Post -Uri $SOAPEndpointURL -Headers $requestHeader -Body $requestBody #-OutFile "C:\SOAPResponse.txt"

If I change my conversion to not have the "-Depth 9" then the result is now this which is confusing?

[ [ [ "System.Xml.XmlElement" ] ] ]

To provide more detail, this is what the XML looks like when I call the end point using PostMan.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetCustomerListResponse>
            <GetCustomerListResult>
                <Data>
                    <Customer>
                        <AddressLine1>123 Yellow Street</AddressLine1>
                        <AddressLine2/>
                        <AddressPostCode>1234</AddressPostCode>
                        <AddressState/>
                        <AddressSuburb>Sydney</AddressSuburb>
                        <Email>test@test.com</Email>
                        <PgnRowNo>1</PgnRowNo>
                    </Customer>
                </Data>
                <Error>0</Error>
                <ErrorMessage i:nil="true"/>
            </GetCustomerListResult>
        </GetCustomerListResponse>
    </s:Body>
</s:Envelope>

Answer 1

PowerShell doesn't offer direct conversion of XML to JSON out of the box.

You'll need to process the XML returned by the API and turn it into one of the types ConvertTo-Json can handle, like hashtable.

See an example below:

# fetch XML
$xmlData = Invoke-RestMethod https://www.nasa.gov/rss/dyn/breaking_news.rss

# extract fields of interest
$hashtables = $xmlData | %{ @{ Id = $_.Identifier; Text = $_.InnerText } }

# convert hashtables into JSON
$hashtables | ConvertTo-Json

Answer 2

Using the newtonsoft serializer.
_{(Depending on your system/PowerShell version newtonsoft might already been available, otherwise see: How do I use Json.NET to parse json in PowerShell? )}

$Xml = [Xml]@"
<?xml version="1.0" encoding="utf-8"?>
<Book>
  <projects>
    <project name="Book1" date="2009-01-20">
      <editions>
        <edition language="English">En.Book1.com</edition>
        <edition language="German">Ge.Book1.Com</edition>
        <edition language="French">Fr.Book1.com</edition>
        <edition language="Polish">Pl.Book1.com</edition>
      </editions>
    </project>
  </projects>
</Book>
"@

[Newtonsoft.Json.JsonConvert]::SerializeXmlNode($Xml, 1)
{
  "?xml": {
    "@version": "1.0",
    "@encoding": "utf-8"
  },
  "Book": {
    "projects": {
      "project": {
        "@name": "Book1",
        "@date": "2009-01-20",
        "editions": {
          "edition": [
            {
              "@language": "English",
              "#text": "En.Book1.com"
            },
            {
              "@language": "German",
              "#text": "Ge.Book1.Com"
            },
            {
              "@language": "French",
              "#text": "Fr.Book1.com"
            },
            {
              "@language": "Polish",
              "#text": "Pl.Book1.com"
            }
          ]
        }
      }
    }
  }
}