public object GetExamples()
{
var ukOffset = new TimeSpan(0, 0, 0);
var fundingVersion = "1.0";
var period = new FundingPeriod
{
Code = "AY1920",
Name = "Academic year 2019-20",
Type = PeriodType.AcademicYear,
StartDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 8, 31, 0, 0, 0, ukOffset)
};
var templateVersion = "2.1";
var stream = new StreamWithTemplateVersion
{
Code = "PESports",
Name = "PE + Sport Premium",
TemplateVersion = templateVersion,
};
var schemaVersion = "1.0";
var groupingOrg = new OrganisationGroup()
{
Type = OrganisationType.LocalAuthority,
Name = "Camden",
SearchableName = "Camden",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.LACode,
Value = "203"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = "12345678"
}
}
};
var id = $"{stream.Code}_{period.Code}_{groupingOrg.Type}_{groupingOrg.Name}_{fundingVersion}";
var financialYearPeriod1920 = new FundingPeriod
{
Code = "FY1920",
Name = "Financial Year 2019-20",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2019, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 3, 30, 0, 0, 0, ukOffset)
};
var financialYearPeriod2021 = new FundingPeriod
{
Code = "FY2021",
Name = "Financial Year 2020-21",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2020, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2021, 3, 30, 0, 0, 0, ukOffset)
};
return(new LogicalBaseModel
{
SchemaUri = "http://example.org/#schema",
SchemaVersion = schemaVersion,
Funding = new FundingProvider
{
FundingStream = stream,
FundingPeriod = period,
OrganisationGroup = groupingOrg,
Id = id,
FundingVersion = fundingVersion,
ExternalPublicationDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, new TimeSpan(1, 0, 0)),
PaymentDate = DateTimeOffset.Now,
Status = FundingStatus.Released,
StatusChangedDate = DateTimeOffset.Now,
GroupingReason = GroupingReason.Payment,
FundingValue = new FundingValue
{
FundingValueByDistributionPeriod = new List <FundingValueByDistributionPeriod>
{
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod1920.Code,
Value = 1400,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 1400,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2019,
TypeValue = "October",
ProfiledValue = 1400,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod1920.Code
}
},
}
}
},
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod2021.Code,
Value = 1000,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "FundingLineCode2",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 1000,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2020,
TypeValue = "April",
ProfiledValue = 1000,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod2021.Code
}
}
}
}
}
},
TotalValue = 2400
},
ProviderFundings = new List <ProviderFunding>
{
new ProviderFunding
{
Id = $"{stream.Code}_{period.Code}_87654321_{fundingVersion}",
FundingVersion = fundingVersion,
FundingPeriodCode = period.Code,
FundingStreamCode = stream.Code,
Organisation = new Organisation
{
Name = "Example School 1",
SearchableName = "ExampleSchool1",
ProviderType = "School",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.URN,
Value = "123453"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = "87654321"
}
}
},
FundingValue = new FundingValue
{
TotalValue = 1200,
FundingValueByDistributionPeriod = new List <FundingValueByDistributionPeriod>
{
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod1920.Code,
Value = 700,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 700,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2019,
TypeValue = "October",
ProfiledValue = 700,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod1920.Code
}
},
Calculations = new List <Calculation>
{
new Calculation
{
Name = "Number of pupils",
Type = CalculationType.PupilNumber,
TemplateCalculationId = 1,
Value = "456",
ValueFormat = CalculationValueFormat.Number,
FormulaText = "Something * something",
ReferenceData = new List <ReferenceData>
{
new ReferenceData
{
Name = "Academic year 2018 to 2019 pupil number on roll",
Value = "1",
Format = ReferenceDataValueFormat.Number,
TemplateReferenceId = 1,
}
}
},
new Calculation
{
Name = "Number of pupils",
Type = CalculationType.PupilNumber,
TemplateCalculationId = 1,
Value = "456",
ValueFormat = CalculationValueFormat.Number,
FormulaText = "Something * something",
ReferenceData = new List <ReferenceData>
{
new ReferenceData
{
Name = "Academic year 2018 to 2019 pupil number on roll",
Value = "1",
Format = ReferenceDataValueFormat.Number,
TemplateReferenceId = 2,
}
}
}
},
}
}
},
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod2021.Code,
Value = 500,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine2",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 500,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2020,
TypeValue = "April",
ProfiledValue = 500,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod2021.Code
}
}
}
}
}
}
},
},
new ProviderFunding
{
Id = $"{stream.Code}_{period.Code}_87654322_{fundingVersion}",
FundingVersion = fundingVersion,
FundingPeriodCode = period.Code,
FundingStreamCode = stream.Code,
Organisation = new Organisation
{
Name = "Example School 2",
SearchableName = "ExampleSchool2",
ProviderType = "School",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.URN,
Value = "123453"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = "87654322"
}
}
},
FundingValue = new FundingValue
{
TotalValue = 1200,
FundingValueByDistributionPeriod = new List <FundingValueByDistributionPeriod>
{
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod1920.Code,
Value = 700,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 700,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2019,
TypeValue = "October",
ProfiledValue = 700,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod1920.Code
}
}
}
}
},
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod2021.Code,
Value = 500,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine2",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 500,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2020,
TypeValue = "April",
ProfiledValue = 500,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod2021.Code
}
}
}
}
}
}
}
}
}
}
});
}
/// <summary>
/// Generate a feed from CSV files (from a spreadsheet).
/// </summary>
/// <param name="fundingPeriodStartYear">Optional - </param>
/// <param name="fundingPeriodEndYear">Optional - </param>
/// <param name="fundingPeriodCodes">Optional - The period codes to limit to (e.g. AY1920).</param>
/// <param name="organisationGroupIdentifiers">Optional - The group identifiers to limit by (e.g. UKPRN 12345678).</param>
/// <param name="organisationGroupTypes">Optional - The group types to limit to (e.g. Region, LocalAuthority).</param>
/// <param name="organisationIdentifiers">Optional - The organisation identifiers to limit to (e.g. UKPRN 12345678).</param>
/// <param name="organisationTypes">Optional - The organisation types to return.</param>
/// <param name="variationReasons">Optional - Filter to only organisations with these variation reasons types</param>
/// <param name="ukprns">Optional - Only get these UKPRNs back.</param>
/// <param name="groupingReasons">Optional - The grouping reasons we want to get back (e.g. Information and/or Payment).</param>
/// <param name="statuses">Optional - The status of the funding (e.g. Released).</param>
/// <param name="minStatusChangeDate">Optional - Only get records back that were changed after this date.</param>
/// <param name="fundingLineTypes">Optional - limit the types of lines we want to get back (e.g. Information and/or Payment).</param>
/// <param name="templateLineIds">Optional - Filter the lines to these ids only.</param>
/// <returns>An array of FeedResponseContentModel objects./returns>
public static FeedResponseContentModel[] GenerateFeed(int?fundingPeriodStartYear, int?fundingPeriodEndYear,
string[] fundingPeriodCodes, OrganisationIdentifier[] organisationGroupIdentifiers, OrganisationType[] organisationGroupTypes,
OrganisationIdentifier[] organisationIdentifiers, OrganisationType[] organisationTypes, VariationReason[] variationReasons,
string[] ukprns, GroupingReason[] groupingReasons, FundingStatus[] statuses, DateTime?minStatusChangeDate,
FundingLineType[] fundingLineTypes, string[] templateLineIds)
{
var totalList = new List <FeedResponseContentModel>();
// Check period dates
if ((fundingPeriodStartYear != null && fundingPeriodStartYear != 2019) ||
(fundingPeriodEndYear != null && fundingPeriodEndYear != 2020))
{
return(totalList.ToArray());
}
// Check period codes
if (fundingPeriodCodes?.Any() == true && fundingPeriodCodes?.Contains("AY1920") == false)
{
return(totalList.ToArray());
}
// Check statuses
if (statuses?.Any() == true && !statuses.Contains(FundingStatus.Released))
{
return(totalList.ToArray());
}
// Check feed cut off date
if (minStatusChangeDate != null && minStatusChangeDate.Value > new DateTime(2019, 3, 1))
{
return(totalList.ToArray());
}
// If we only want information type, we are out of luck
if (groupingReasons?.Any() == true && groupingReasons?.Contains(GroupingReason.Payment) == false)
{
return(totalList.ToArray());
}
var fundingVersion = "1-0";
var templateVersion = "1.0";
var schemaVersion = "1.0";
var ukOffset = new TimeSpan(0, 0, 0);
var period = new FundingPeriod
{
Code = "AY1920",
Name = "Academic year 2019-20",
Type = PeriodType.AcademicYear,
StartDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 8, 31, 0, 0, 0, ukOffset)
};
var stream = new StreamWithTemplateVersion
{
Code = "PESports",
Name = "PE + Sport Premium",
TemplateVersion = templateVersion,
};
var processFile = new ProcessPesportsCsv();
var financialYearPeriod1920 = new FundingPeriod
{
Code = "FY1920",
Name = "Financial Year 2019-20",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2019, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 3, 30, 0, 0, 0, ukOffset)
};
var financialYearPeriod2021 = new FundingPeriod
{
Code = "FY2021",
Name = "Financial Year 2020-21",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2020, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2021, 3, 30, 0, 0, 0, ukOffset)
};
var providerTypes = new List <string>
{
"MaintainedSchools",
"Academies",
"NonMaintainedSpecialSchools"
};
foreach (var providerType in providerTypes)
{
if ((providerType == "MaintainedSchools" || providerType == "NonMaintainedSpecialSchools") &&
organisationGroupTypes?.Any() == true && organisationGroupTypes?.Contains(OrganisationType.Provider) == false)
{
continue;
}
else if (providerType == "Academies" &&
organisationGroupTypes?.Any() == true && organisationGroupTypes?.Contains(OrganisationType.AcademyTrust) == false)
{
continue;
}
var groupByLa = false;
switch (providerType)
{
case "MaintainedSchools":
groupByLa = true;
break;
}
var orgGroups = processFile.GetOrgsOrOrgGroups($"{providerType}.csv", groupByLa);
totalList.AddRange(ProcessOrgGroups(orgGroups, providerType, financialYearPeriod1920, financialYearPeriod2021, period, stream, schemaVersion, fundingVersion,
organisationGroupIdentifiers, organisationIdentifiers, organisationTypes, variationReasons, ukprns, fundingLineTypes, templateLineIds)
);
}
return(totalList.ToArray());
}
/// <summary>
/// Get the provider funding from the spreadsheet
/// </summary>
/// <param name="id">The id to lookup.</param>
/// <returns>A provider funding object.</returns>
public static ProviderFunding GenerateProviderFunding(string id)
{
var idParts = id.Split('_');
var code = idParts[2].Replace("MOCKUKPRN", string.Empty);
var ukOffset = new TimeSpan(0, 0, 0);
var period = new FundingPeriod
{
Code = "AY1920",
Name = "Academic year 2019-20",
Type = PeriodType.AcademicYear,
StartDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 8, 31, 0, 0, 0, ukOffset)
};
var templateVersion = "1.0";
var stream = new StreamWithTemplateVersion
{
Code = "PESports",
Name = "PE + Sport Premium",
TemplateVersion = templateVersion,
};
var financialYearPeriod1920 = new FundingPeriod
{
Code = "FY1920",
Name = "Financial Year 2019-20",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2019, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 3, 30, 0, 0, 0, ukOffset)
};
var financialYearPeriod2021 = new FundingPeriod
{
Code = "FY2021",
Name = "Financial Year 2020-21",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2020, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2021, 3, 30, 0, 0, 0, ukOffset)
};
var processFile = new ProcessPesportsCsv();
var orgGroups = new List <OrgGroup>();
orgGroups.AddRange(processFile.GetOrgsOrOrgGroups("MaintainedSchools.csv", true));
orgGroups.AddRange(processFile.GetOrgsOrOrgGroups("Academies.csv", false));
orgGroups.AddRange(processFile.GetOrgsOrOrgGroups("MaintainedSchools.csv", false));
foreach (var orgGroup in orgGroups)
{
foreach (var provider in orgGroup.Providers)
{
if (provider.LaEstablishmentNo == code)
{
return(GetProviderFunding(provider, financialYearPeriod1920, financialYearPeriod2021, period, stream, orgGroup.Type, orgGroup.Code));
}
}
}
return(null);
}
/// <summary>
/// Process org groups into feed models.
/// </summary>
/// <param name="orgGroups">List of org groups.</param>
/// <param name="providerType">The provider types we are looking at.</param>
/// <param name="financialYearPeriod1920">Data about the first financial period.</param>
/// <param name="financialYearPeriod2021">Data about the second financial period.</param>
/// <param name="period">Period to use.</param>
/// <param name="stream">Stream to use.</param>
/// <param name="schemaVersion">Schema version number.</param>
/// <param name="fundingVersion">Funding version number.</param>
/// <param name="organisationGroupIdentifiers">Optional - The group identifiers to limit by (e.g. UKPRN 12345678).</param>
/// <param name="organisationIdentifiers">Optional - The organisation identifiers to limit to (e.g. UKPRN 12345678).</param>
/// <param name="organisationTypes">Optional - The organisation types to return.</param>
/// <param name="variationReasons">Optional - Filter to only organisations with these variation reasons types</param>
/// <param name="ukprns">Optional - Only get these UKPRNs back.</param>
/// <param name="fundingLineTypes">Optional - limit the types of lines we want to get back (e.g. Information and/or Payment).</param>
/// <param name="templateLineIds">Optional - Filter the lines to these ids only.</param>
/// <returns>A list of feed response models.</returns>
private static List <FeedResponseContentModel> ProcessOrgGroups(List <OrgGroup> orgGroups, string providerType, FundingPeriod financialYearPeriod1920,
FundingPeriod financialYearPeriod2021, FundingPeriod period, StreamWithTemplateVersion stream, string schemaVersion, string fundingVersion,
OrganisationIdentifier[] organisationGroupIdentifiers, OrganisationIdentifier[] organisationIdentifiers, OrganisationType[] organisationTypes,
VariationReason[] variationReasons, string[] ukprns, FundingLineType[] fundingLineTypes, string[] templateLineIds)
{
var returnList = new List <FeedResponseContentModel>();
// Limit by org group identifiers
if (organisationGroupIdentifiers?.Any() == true)
{
foreach (var organisationGroupIdentifier in organisationGroupIdentifiers)
{
orgGroups = orgGroups.Where(orgGroup => orgGroup.Type != organisationGroupIdentifier.Type.ToString() ||
orgGroup.Code == organisationGroupIdentifier.Value).ToList();
}
}
// Limit by org identifiers
if (organisationIdentifiers?.Any() == true)
{
foreach (var orgGroup in orgGroups)
{
orgGroup.Providers = orgGroup.Providers.Where(provider =>
organisationIdentifiers.Any(oi => oi.Type != OrganisationIdentifierType.LACode || oi.Value == provider.LaEstablishmentNo)).ToList();
}
}
foreach (var orgGroup in orgGroups)
{
var orgType = providerType == "NonMaintainedSpecialSchools" || providerType == "Academies" ?
(providerType == "NonMaintainedSpecialSchools" ? OrganisationType.Provider : OrganisationType.AcademyTrust) : OrganisationType.LocalAuthority;
var ukprn = $"MOCKUKPRN{orgGroup.Code}";
var groupingOrg = ConvertToOrganisationGroup(orgGroup, ukprn, orgType);
var id = $"{stream.Code}_{period.Code}_{groupingOrg.Type}_{ukprn}_{fundingVersion}";
var data = new FeedBaseModel
{
SchemaUri = "http://example.org/#schema",
SchemaVersion = schemaVersion,
Funding = new FundingFeed
{
Id = id,
FundingStream = stream,
FundingPeriod = period,
OrganisationGroup = groupingOrg,
FundingVersion = fundingVersion.Replace("-", "."),
ExternalPublicationDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, new TimeSpan(1, 0, 0)),
PaymentDate = DateTimeOffset.Now,
Status = FundingStatus.Released,
StatusChangedDate = DateTimeOffset.Now,
GroupingReason = GroupingReason.Payment,
ProviderFundings = GetProviderFundingIds(orgGroup, period, stream, fundingVersion, organisationTypes, variationReasons, ukprns),
FundingValue = new FundingValue
{
TotalValue = orgGroup.TotalAllocation,
FundingValueByDistributionPeriod = new List <FundingValueByDistributionPeriod>
{
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod1920.Code,
Value = orgGroup.OctoberTotal,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = orgGroup.OctoberTotal,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2019,
TypeValue = "October",
ProfiledValue = orgGroup.OctoberTotal,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod1920.Code
}
},
}
}
},
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod2021.Code,
Value = orgGroup.AprilTotal,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
TemplateLineId = 2,
Type = FundingLineType.Payment,
Value = orgGroup.AprilTotal,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2020,
TypeValue = "April",
ProfiledValue = orgGroup.AprilTotal,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod2021.Code
}
}
}
}
}
}
}
},
};
if (fundingLineTypes?.Any() == true)
{
foreach (var dperiod in data.Funding.FundingValue.FundingValueByDistributionPeriod)
{
dperiod.FundingLines = dperiod.FundingLines.Where(line => fundingLineTypes.Contains(line.Type)).ToList();
//TODO - filter at lower levels
}
}
if (templateLineIds?.Any() == true)
{
foreach (var dperiod in data.Funding.FundingValue.FundingValueByDistributionPeriod)
{
dperiod.FundingLines = dperiod.FundingLines.Where(line => templateLineIds.Contains(line.TemplateLineId.ToString())).ToList();
//TODO - filter at lower levels
}
}
var host = "http://example.org";
returnList.Add(new FeedResponseContentModel
{
Content = data,
Id = data.Funding.Id,
Author = new FeedResponseAuthor
{
Email = "*****@*****.**",
Name = "Calculate Funding Service"
},
Title = data.Funding.Id,
Updated = DateTime.Now,
Link = new FeedLink[]
{
new FeedLink
{
Href = $"{host}/api/funding/feed/byId/{data.Funding.Id}",
Rel = "self"
}
}
});
}
;
return(returnList);
}
public object GetExamples()
{
var ukOffset = new TimeSpan(0, 0, 0);
var fundingVersion = "1-0";
var period = new FundingPeriod
{
Code = "AY1920",
Name = "Academic year 2019-20",
Type = PeriodType.AcademicYear,
StartDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 8, 31, 0, 0, 0, ukOffset)
};
var templateVersion = "2.1";
var stream = new StreamWithTemplateVersion
{
Code = "PESports",
Name = "PE + Sport Premium",
TemplateVersion = templateVersion,
};
string providerId = "12345678";
var groupingOrg = new OrganisationGroup()
{
Type = OrganisationType.LocalAuthority,
Name = "Camden",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.LACode,
Value = "203"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = providerId
}
}
};
var id = $"{stream.Code}_{period.Code}_{providerId}_{fundingVersion}";
var financialYearPeriod1920 = new FundingPeriod
{
Code = "FY1920",
Name = "Financial Year 2019-20",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2019, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 3, 30, 0, 0, 0, ukOffset)
};
var financialYearPeriod2021 = new FundingPeriod
{
Code = "FY2021",
Name = "Financial Year 2020-21",
Type = PeriodType.FinancialYear,
StartDate = new DateTimeOffset(2020, 4, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2021, 3, 30, 0, 0, 0, ukOffset)
};
return(new ProviderFunding
{
Id = id,
FundingVersion = fundingVersion,
FundingPeriodCode = period.Code,
FundingStreamCode = stream.Code,
Organisation = new Organisation
{
Name = "Example School 1",
SearchableName = "ExampleSchool1",
OrganisationDetails = new OrganisationDetails()
{
DateClosed = null,
DateOpened = new DateTimeOffset(2012, 12, 2, 0, 0, 0, 0, TimeSpan.Zero),
PhaseOfEducation = "Secondary",
Status = "Open",
OpenReason = ProviderOpenReason.AcademyConverter,
CloseReason = null,
TrustName = "Trust Name",
TrustStatus = TrustStatus.SupportedByASingleAacademyTrust,
Address = new OrganisationAddress
{
Postcode = "MOCK POSTCODE",
Town = "MOCK TOWN"
}
},
ProviderType = "Academies",
ProviderSubType = "Academy alternative provision converter",
ProviderVersionId = "3",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.URN,
Value = "123453"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = providerId
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.AcademyTrustCode,
Value = "2705",
}
},
},
Variations = new Variations()
{
VariationReasons = new List <VariationReason>()
{
VariationReason.NameFieldUpdated,
VariationReason.FundingUpdated,
},
Successors = new List <ProviderInformationModel>()
{
new ProviderInformationModel()
{
ProviderVersionId = "pes2",
Ukprn = "2345333",
},
},
},
FundingValue = new FundingValue
{
TotalValue = 1200,
FundingValueByDistributionPeriod = new List <FundingValueByDistributionPeriod>
{
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod1920.Code,
Value = 700,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 700,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2019,
TypeValue = "October",
ProfiledValue = 700,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod1920.Code
}
},
Calculations = new List <Calculation>
{
new Calculation
{
Name = "Number of pupils",
Type = CalculationType.PupilNumber,
TemplateCalculationId = 1,
Value = "456",
ValueFormat = CalculationValueFormat.Number,
FormulaText = "Something * something",
ReferenceData = new List <ReferenceData>
{
new ReferenceData
{
Name = "Academic year 2018 to 2019 pupil number on roll",
Value = "1",
Format = ReferenceDataValueFormat.Number,
TemplateReferenceId = 1,
}
}
},
new Calculation
{
Name = "Number of pupils",
Type = CalculationType.PupilNumber,
TemplateCalculationId = 1,
Value = "456",
ValueFormat = CalculationValueFormat.Number,
FormulaText = "Something * something",
ReferenceData = new List <ReferenceData>
{
new ReferenceData
{
Name = "Academic year 2018 to 2019 pupil number on roll",
Value = "1",
Format = ReferenceDataValueFormat.Number,
TemplateReferenceId = 2,
}
}
}
}
}
}
},
new FundingValueByDistributionPeriod
{
DistributionPeriodCode = financialYearPeriod2021.Code,
Value = 500,
FundingLines = new List <FundingLine>
{
new FundingLine
{
Name = "Total funding line",
FundingLineCode = "TotalFundingLine2",
TemplateLineId = 1,
Type = FundingLineType.Payment,
Value = 500,
ProfilePeriods = new List <FundingLinePeriod>
{
new FundingLinePeriod
{
Occurence = 1,
Year = 2020,
TypeValue = "April",
ProfiledValue = 500,
Type = FundingLinePeriodType.CalendarMonth,
PeriodCode = financialYearPeriod2021.Code
}
}
}
}
}
}
}
});
}
public object GetExamples()
{
var ukOffset = new TimeSpan(0, 0, 0);
var fundingVersion = "1.0";
var period = new FundingPeriod
{
Code = "AY1920",
Name = "Academic year 2019-20",
Type = PeriodType.AcademicYear,
StartDate = new DateTimeOffset(2019, 9, 1, 0, 0, 0, ukOffset),
EndDate = new DateTimeOffset(2020, 8, 31, 0, 0, 0, ukOffset)
};
var templateVersion = "1.0";
var stream = new StreamWithTemplateVersion
{
Code = "PESports",
Name = "PE + Sport Premium",
TemplateVersion = templateVersion,
};
var groupingOrg = new OrganisationGroup()
{
Type = OrganisationType.LocalAuthority,
Name = "Camden",
SearchableName = "Camden",
Identifiers = new List <OrganisationIdentifier>
{
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.LACode,
Value = "203"
},
new OrganisationIdentifier
{
Type = OrganisationIdentifierType.UKPRN,
Value = "12345678"
}
}
};
var id = $"{stream.Code}_{period.Code}_{groupingOrg.Type}_{groupingOrg.Name}_{fundingVersion}";
var host = "http://example.org";
return(new FeedResponseModel
{
Id = Guid.NewGuid().ToString(),
Title = "MYESF/CFS shared funding model mock API",
Author = new FeedResponseAuthor
{
Email = "*****@*****.**",
Name = "Calculate Funding Service"
},
Updated = DateTime.Now,
Rights = "Copyright (C) 2019 Department for Education",
Link = new List <FeedLink>
{
new FeedLink
{
Href = $"{host}/api/funding/feed/2",
Rel = "self"
},
new FeedLink
{
Href = $"{host}/api/funding/feed/5",
Rel = "first"
},
new FeedLink
{
Href = $"{host}/api/funding/feed/1",
Rel = "last"
},
new FeedLink
{
Href = $"{host}/api/funding/feed/1",
Rel = "previous"
},
new FeedLink
{
Href = $"{host}/api/funding/feed/3",
Rel = "next"
}
},
AtomEntry = new FeedResponseContentModel[]
{
new FeedResponseContentModel
{
Id = id,
Author = new FeedResponseAuthor
{
Email = "*****@*****.**",
Name = "Calculate Funding Service"
},
Title = $"Feed response for {stream.Code} - {period.Code} - version {fundingVersion}",
Link = new FeedLink[]
{
new FeedLink
{
Href = $"{host}/api/funding/feed/byId/{id}",
Rel = "self"
}
},
Updated = DateTime.Now,
Content = (FeedBaseModel) new FeedBaseModelExample().GetExamples()
}
}
});
}
