Scenario Access Data Extract – All Scenarios API

Syntax

PlanfulAPIStateFreeClient.localplanful.SegmentMemberSecurityInfo[] GetAllBudgetScenariosAccessible(ref bool hasMore, int startIndex, string LoginName, string Password, string TenantCode)

Usage

This API extracts existing scenario access data stored in Planful. Existing data is required to compare with source data to locate change records.

This API extracts data for all scenarios.

Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
<soapenv:Header/>
<soapenv:Body>
<ns:GetAllBudgetScenariosAccessible>
<ns:hasMore>true</ns:hasMore>
<ns:startIndex>0</ns:startIndex>
<ns:LoginName>benparker@planful.com</ns:LoginName>
<ns:Password>password</ns:Password>
<ns:TenantCode>TESTBASEQA</ns:TenantCode>
</ns:GetAllBudgetScenariosAccessible>
</soapenv:Body>
</soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetAllBudgetScenariosAccessibleResponse xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
  <GetAllBudgetScenariosAccessibleResult>
<SegmentMemberSecurityInfo>
<UserLogin>benbradley@planful.com</UserLogin>
<SegmentMemberCode>Budget 2009</SegmentMemberCode>
</SegmentMemberSecurityInfo>
<SegmentMemberSecurityInfo>
<UserLogin>ben@planful.com</UserLogin>
<SegmentMemberCode>Budget 2009</SegmentMemberCode>
</SegmentMemberSecurityInfo>
<SegmentMemberSecurityInfo>
<UserLogin>ben@planful.com</UserLogin>
<SegmentMemberCode>Budget 2010</SegmentMemberCode>
</SegmentMemberSecurityInfo>
  </GetAllBudgetScenariosAccessibleResult>
  <hasMore>false</hasMore>
</GetAllBudgetScenariosAccessibleResponse>
</soap:Body>
</soap:Envelope>