GET api/recurringPackageProfiles/search?entityId={entityId}&packageName={packageName}

Search Recurrence Profiles by package Name and entity Id.

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId	Filter by Entity Id	integer	None.
packageName	Filter by Package Name ("Contains")	string	None.

Body Parameters

None.

Response Information

Resource Description

RSMRecurringPackageProfileGetViewModel

Name	Description	Type	Additional information
Id	Id	integer	None.
Links	Package-Entity links associated with this profile.	Collection of RSMPackageEntityLinkViewModelGET	None.
RecurrenceRule	Recurrence Rule	string	None.
NextRunDate	Next Date this profile will run	date	None.
ProfileStartDate	Profile Start Date	date	None.
RunForPeriod	Run for period.	RunForLastViewModel	None.
CreatedOn	CreatedOn	date	None.
CreatedBy	CreatedBy	integer	None.
ModifiedOn	ModifiedOn	date	None.
ModifiedBy	ModifiedBy	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "links": [
    {
      "packageId": 1,
      "packageName": "sample string 2",
      "entityId": 3,
      "entityName": "sample string 4",
      "entityNumber": "sample string 5",
      "includeSubEntities": true
    },
    {
      "packageId": 1,
      "packageName": "sample string 2",
      "entityId": 3,
      "entityName": "sample string 4",
      "entityNumber": "sample string 5",
      "includeSubEntities": true
    }
  ],
  "recurrenceRule": "sample string 2",
  "nextRunDate": "2024-10-14T08:23:56.909723-04:00",
  "profileStartDate": "2024-10-14T08:23:56.909723-04:00",
  "runForPeriod": {
    "id": 1,
    "name": "sample string 2"
  },
  "createdOn": "2024-10-14T08:23:56.909723-04:00",
  "createdBy": 4,
  "modifiedOn": "2024-10-14T08:23:56.909723-04:00",
  "modifiedBy": 1
}

application/xml, text/xml

Sample:

<RSMRecurringPackageProfileGetViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RSMRecurringPackages">
  <CreatedBy>4</CreatedBy>
  <CreatedOn>2024-10-14T08:23:56.909723-04:00</CreatedOn>
  <Id>1</Id>
  <Links>
    <RSMPackageEntityLinkViewModelGET>
      <EntityId>3</EntityId>
      <EntityName>sample string 4</EntityName>
      <EntityNumber>sample string 5</EntityNumber>
      <IncludeSubEntities>true</IncludeSubEntities>
      <PackageId>1</PackageId>
      <PackageName>sample string 2</PackageName>
    </RSMPackageEntityLinkViewModelGET>
    <RSMPackageEntityLinkViewModelGET>
      <EntityId>3</EntityId>
      <EntityName>sample string 4</EntityName>
      <EntityNumber>sample string 5</EntityNumber>
      <IncludeSubEntities>true</IncludeSubEntities>
      <PackageId>1</PackageId>
      <PackageName>sample string 2</PackageName>
    </RSMPackageEntityLinkViewModelGET>
  </Links>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:23:56.909723-04:00</ModifiedOn>
  <NextRunDate>2024-10-14T08:23:56.909723-04:00</NextRunDate>
  <ProfileStartDate>2024-10-14T08:23:56.909723-04:00</ProfileStartDate>
  <RecurrenceRule>sample string 2</RecurrenceRule>
  <RunForPeriod xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </RunForPeriod>
</RSMRecurringPackageProfileGetViewModel>