POST api/rsmPackages/run?PackageId={PackageId}&Month={Month}&Year={Year}&UserId={UserId}&EntityId={EntityId}&IncludeSubEntities={IncludeSubEntities}&IncludeFund={IncludeFund}&IncludeExternalDocuments={IncludeExternalDocuments}

Run Package by Id, Entity Id, Month, and Year UserId required for history tracking

Request Information

URI Parameters

Name	Description	Type	Additional information
PackageId	PackageId	integer	None.
Month	Month	integer	None.
Year	Year	integer	None.
UserId	UserId	integer	None.
EntityId	EntityId	integer	None.
IncludeSubEntities	IncludeSubEntities	boolean	None.
IncludeFund	IncludeFund	boolean	None.
IncludeExternalDocuments		boolean	None.

Body Parameters

None.

Response Information

Resource Description

RSMPackageHistoryViewModel

Name	Description	Type	Additional information
Id	ID	integer	None.
PackageId	Package ID Foreign Key	integer	None.
PackageName	Package Name	string	None.
RunForFrom	Month the reports was generated on	date	None.
RunForTo	Month the reports was generated on	date	None.
StartTime	Start time	date	None.
EndTime	End time	date	None.
FileName	FileName	string	None.
EntityId	Entity Id	integer	None.
EntityNumber	Entity Number	string	None.
StatusId	Status Id	integer	None.
Message	Potential error message	string	None.
RunBy	User running package	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "packageId": 2,
  "packageName": "sample string 3",
  "runForFrom": "2024-10-14T08:24:14.6841411-04:00",
  "runForTo": "2024-10-14T08:24:14.6841411-04:00",
  "startTime": "2024-10-14T08:24:14.6841411-04:00",
  "endTime": "2024-10-14T08:24:14.6841411-04:00",
  "fileName": "sample string 7",
  "entityId": 8,
  "entityNumber": "sample string 9",
  "statusId": 10,
  "message": "sample string 11",
  "runBy": 12
}

application/xml, text/xml

Sample:

<RSMPackageHistoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <EndTime>2024-10-14T08:24:14.6841411-04:00</EndTime>
  <EntityId>8</EntityId>
  <EntityNumber>sample string 9</EntityNumber>
  <FileName>sample string 7</FileName>
  <Id>1</Id>
  <Message>sample string 11</Message>
  <PackageId>2</PackageId>
  <PackageName>sample string 3</PackageName>
  <RunBy>12</RunBy>
  <RunForFrom>2024-10-14T08:24:14.6841411-04:00</RunForFrom>
  <RunForTo>2024-10-14T08:24:14.6841411-04:00</RunForTo>
  <StartTime>2024-10-14T08:24:14.6841411-04:00</StartTime>
  <StatusId>10</StatusId>
</RSMPackageHistoryViewModel>