Happy Business Starts Here

0 Kudos

API documentation fails to document invalid field combinations

Issue:  If I run a query for Subscription object as an example:

<ns1:query>
<ns1:queryString>select Id,AccountId,AncestorAccountId,AutoRenew,CancelledDate,ContractAcceptanceDate,ContractEffectiveDate,CreatedById,CreatedDate,CreatorAccountId,CreatorInvoiceOwnerId,Currency,InitialTerm,InvoiceOwnerId,IsInvoiceSeparate,Name,Notes,OriginalCreatedDate,OriginalId,PreviousSubscriptionId,RenewalTerm,ServiceActivationDate,Status,SubscriptionEndDate,SubscriptionStartDate,TermEndDate,TermStartDate,TermType,UpdatedById,UpdatedDate,Version from Subscription</ns1:queryString>
</ns1:query>


<faultcode>fns:INVALID_FIELD</faultcode>
<faultstring>invalid field for query: Subscription.AncestorAccountId</faultstring>
<detail>

 

Then, referencing to http://apidocs.developer.zuora.com/index.php/Subscription, AncestorAccountId do not have detailed explanation have this value became invalid for my query. Subscription object is just an example and it is also happening to other objects and we need to update our documentation. DE7599 is created to inform our Technical Writer to do the necessary minimal update to make sure our API documentation will be helpful.

2 Comments
Community Manager
Status changed to: More Feedback Needed
 
Community Manager
Status changed to: Under Consideration