Requesting an empty collection returns an object of the return type

[vanpouckesven]

When requesting a collection that returns an empty result the result is actually parsed to an object that was given in the ReturnType.

Example:

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.plannerPlan)",
    "@odata.count": 0,
    "value": []
}

Results in

object(Microsoft\Graph\Model\PlannerPlan)[400]
  protected '_propDict' => 
    array (size=3)
      '@odata.context' => string 'https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.plannerPlan)' (length=82)
      '@odata.count' => int 0
      'value' => 
        array (size=0)
          empty

I think the system should handle this as an empty array. The problem can be found in the class \Microsoft\Graph\Http\GraphResponse - method getResponseAsObject - line 152 where the system checks if the variable '$values' is available. When given an empty array the system returns false and continues to parse the collection as an object, returning false results.

[vanpouckesven]

I wrote a temporary fix in my code, if one should encounter the same problem. Make sure you don't provide the returnType to the request, this makes that the system returns a GraphResponse object instead of the mapped returnType. You can then call this function to parse the response.

    protected function parseCollectionResponse(GraphResponse $graphResponse, $returnType)
    {
        $body = $graphResponse->getBody();

        $count = 0;
        if(array_key_exists('@odata.count', $body))
        {
            $count = $body['@odata.count'];
        }

        return ($count > 0) ? $graphResponse->getResponseAsObject($returnType) : [];
    }

[davidsickmiller]

Is there an ETA for this? Do you accept pull requests?

[MIchaelMainer]

@davidsickmiller I don't have an eta but I will accept a PR.