Advanced LoadCollection with properties

Parameters

Headers

Request data

None

Response data in XML format

<MGRestResponse
	xmlns="http://schemas.datacontract.org/2004/07/"
	xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <item>
      <p>1</p>
      <p>sa</p>
    </item>
  </Items>
  <Message i:nil="true"/>
  <MessageCode>0</MessageCode>
</MGRestResponse>

Response data in JSON format

{
   "Items": [
      [ "1", "sa" ]
   ],
   "Message": null,
   "MessageCode": 0
}

Response data in JSON Stream format

{
   "Message": "Success",
   "MessageCode": 0,
   "Items": [
      {
         "UserId": 1,
         "Username": "sa"
      }
   ]
}

Response data in Full Schema format

<NewDataSet>
  <xs:schema id="NewDataSet" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="UserNames" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="UserNames">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="UserId" msdata:Caption="sUserID" type="xs:decimal"/>
                <xs:element name="Username" msdata:Caption="sUsername" type="xs:string"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <UserNames>
    <UserId>1</UserId>
    <Username>sa</Username>
  </UserNames>
</NewDataSet>

Example

This example code retrieves the user ID, username, and user description of the 'sa' user from the Users table. Notice that the properties are provided as a query parameter.

string xml = string.Empty;
 
using ( HttpClient client = new HttpClient() )
{
   // optionally, you can use json as the response type
   string ido = "UserNames";
   string properties = "UserId, Username, UserDesc";
   string filter = "Username%20LIKE%20'sa'";
   string requestUrl = $"http://server/IDORequestService/MGRESTService.svc/xml/{ido}/adv?props={properties}&filter={filter}";
 
   // provide token in the Authorization header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
      "Authorization",
      "b/XdI6IQzCviZOGJ0E+002DoKUFOPmVDkwpQDbQj…==" );
 
   HttpResponseMessage response = client.GetAsync( requestUrl ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      xml = result.Result;
   }
}