ListAuthorities

Owned by Nate Edwards
Last updated: Jun 02, 2020 by Patrick Murphy
6 min read

Summary: Provides a list of all authorities

Soap Action: http://ns.esha.com/2013/genesisapi/ListAuthorities

Request Type: AuthoritiesListRequest

  • StartIndex (Optional)
    • Type: Int
    • The index offset. If empty, index starts at 1.
  • PageSize (Optional)
    • Type: Int
    • The number of foods to return in the response. If empty, all records are returned.

Response Type: AuthoritiesListResponse

  • Authorities
    • AuthorityDto[]
    • List of authorities request.
  • Status
    • Type: exlx:ResultStatus
    • The ResultStatus of the given response
  • ResponseVersion
    • Type: exlx:XmlVersion
    • The version of the given response.


SOAP Request 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://ns.esha.com/2013/genesisapi">
   <soap:Header/>
   <soap:Body>
      <gen:AuthoritiesListRequest>
         <gen:StartIndex>1</gen:StartIndex>
         <gen:PageSize>4</gen:PageSize>
      </gen:AuthoritiesListRequest>
   </soap:Body>
</soap:Envelope>
SOAP Response 
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://ns.esha.com/2013/genesisapi/listauthoritiesresponse</a:Action>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AuthoritiesListResponse xmlns="http://ns.esha.com/2013/genesisapi">
         <Authorities>
            <Authority>
               <Id xmlns="http://ns.esha.com/2013/exlx">bbf4846d-8400-43bb-944d-6021fda98225</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">United States</Value>
               </Name>
               <Iso3166Alpha2 xmlns="http://ns.esha.com/2013/exlx">US</Iso3166Alpha2>
               <Iso3166Alpha3 xmlns="http://ns.esha.com/2013/exlx">USA</Iso3166Alpha3>
               <Iso3166Numeric xmlns="http://ns.esha.com/2013/exlx">840</Iso3166Numeric>
            </Authority>
            <Authority>
               <Id xmlns="http://ns.esha.com/2013/exlx">bbf4846d-1240-43bb-944d-6021fda98225</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">Canada</Value>
               </Name>
               <Iso3166Alpha2 xmlns="http://ns.esha.com/2013/exlx">CA</Iso3166Alpha2>
               <Iso3166Alpha3 xmlns="http://ns.esha.com/2013/exlx">CAN</Iso3166Alpha3>
               <Iso3166Numeric xmlns="http://ns.esha.com/2013/exlx">124</Iso3166Numeric>
            </Authority>
            <Authority>
               <Id xmlns="http://ns.esha.com/2013/exlx">bbf4846d-4840-43bb-944d-6021fda98225</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">Mexico</Value>
               </Name>
               <Iso3166Alpha2 xmlns="http://ns.esha.com/2013/exlx">MX</Iso3166Alpha2>
               <Iso3166Alpha3 xmlns="http://ns.esha.com/2013/exlx">MEX</Iso3166Alpha3>
               <Iso3166Numeric xmlns="http://ns.esha.com/2013/exlx">484</Iso3166Numeric>
            </Authority>
            <Authority>
               <Id xmlns="http://ns.esha.com/2013/exlx">bbf4846d-9000-43bb-944d-6021fda98225</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">European Union</Value>
               </Name>
               <Iso3166Alpha2 xmlns="http://ns.esha.com/2013/exlx">EU</Iso3166Alpha2>
               <Iso3166Alpha3 xmlns="http://ns.esha.com/2013/exlx">EUE</Iso3166Alpha3>
               <Iso3166Numeric xmlns="http://ns.esha.com/2013/exlx">900</Iso3166Numeric>
            </Authority>
         </Authorities>
         <ResponseVersion>1.0.0.0</ResponseVersion>
         <Status>
            <StatusMessage>Ok</StatusMessage>
            <StatusCode>200</StatusCode>
         </Status>
      </AuthoritiesListResponse>
   </s:Body>
</s:Envelope>
REST Request 
POST http://localhost:80/rest/FoodQueryService.svc/ListAuthorities HTTP/1.1
Content-Type: text/plain
Host: localhost:80

request={"StartIndex":1, "PageSize":10}
REST Response 
{
    "Authorities": [
        {
            "Name": {
                "en-US": "United States"
            },
            "Iso3166Alpha2": "US",
            "Iso3166Alpha3": "USA",
            "Iso3166Numeric": 840,
            "Iso3166NumericSpecified": true,
            "Id": "bbf4846d-8400-43bb-944d-6021fda98225",
            "IdSpecified": true
        },
        {
            "Name": {
                "en-US": "Canada"
            },
            "Iso3166Alpha2": "CA",
            "Iso3166Alpha3": "CAN",
            "Iso3166Numeric": 124,
            "Iso3166NumericSpecified": true,
            "Id": "bbf4846d-1240-43bb-944d-6021fda98225",
            "IdSpecified": true
        },
        {
            "Name": {
                "en-US": "Mexico"
            },
            "Iso3166Alpha2": "MX",
            "Iso3166Alpha3": "MEX",
            "Iso3166Numeric": 484,
            "Iso3166NumericSpecified": true,
            "Id": "bbf4846d-4840-43bb-944d-6021fda98225",
            "IdSpecified": true
        },
        {
            "Name": {
                "en-US": "European Union"
            },
            "Iso3166Alpha2": "EU",
            "Iso3166Alpha3": "EUE",
            "Iso3166Numeric": 900,
            "Iso3166NumericSpecified": true,
            "Id": "bbf4846d-9000-43bb-944d-6021fda98225",
            "IdSpecified": true
        }
    ],
    "Status": {
        "StatusMessage": 200,
        "StatusCode": 200,
        "StatusDetail": null
    },
    "ResponseVersion": {}
}