Classificando por meio do elemento orderBy do XML de entrada de APIs de lista

O XML de entrada de APIs de lista suporta a classificação com base no elemento OrderBy.

Para consultas de formulário:

Edite o XML de entrada customizado de qualquer API de lista e inclua o elemento OrderBy. Inclua o elemento filho Attribute e, no atributo Name, especifique o nome do campo com base em qual você deseja classificar os resultados.

O elemento OrderBy suporta a ordenação dos atributos tanto em ordem crescente como decrescente. Por padrão, os resultados são classificados em ordem crescente. Se desejar classificar os resultados em ordem decrescente, inclua o atributo Desc no elemento Attribute e configure-o como Y.

Também é possível executar a classificação aninhada usando o elemento OrderBy.

Observação: a paginação pode não funcionar como esperado quando você classifica por colunas que contêm valores nulos ou em branco e pode resultar em ordenação imprevisível ou registros duplicados. Para obter resultados precisos, você pode usar campos com valores exclusivos e não nulos para classificação.

XML de entrada da API GetOrganizationList com o elemento orderBy

O exemplo a seguir mostra um fragmento do XML de entrada que retorna uma lista de organizações e os resultados são classificados pelo atributo OrganizationName.

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
  <OrderBy> 
     <Attribute Name="OrganizationName"/> 
   </OrderBy> 
</Organization>

XML de entrada da API GetOrganizationList com o elemento orderBy aninhado

O exemplo a seguir mostra um fragmento do XML de entrada que retorna uma lista de organizações e os resultados são classificados pelos atributos OrganizationName e LocaleCode.

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
   <OrderBy> 
     <Attribute Name="OrganizationName"/> 
     <Attribute Name="LocaleCode"/> 
    </OrderBy> 
</Organization>

XML de entrada da API GetOrganizationList com elemento orderBy e atributo desc

O exemplo a seguir mostra um fragmento do XML de entrada que retorna uma lista de organizações e os resultados são classificados pelo atributo OrganizationName na ordem decrescente.

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
   <OrderBy> 
      <Attribute Name="OrganizationName" Desc="Y"/> 
   </OrderBy> 
</Organization>