POST api/recurringPackageProfiles?userId={userId}

Creates a new RecurringPackageProfile in the database

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	User Id	integer	Required

Body Parameters

Data to create a profile

RSMRecurringPackageProfileInsertViewModel

Name	Description	Type	Additional information
Links	[Required] Package Entity Links	Collection of RSMPackageEntityLinkViewModelINSERT	Required
RecurrenceRule	[Required] Rule that defines the recurrency of this profile (Recurrence Rule).	string	Required
ProfileStartDate	[Required] Start Date Of This Profile.	date	Required
RunForPeriodId	Run for period id.	integer	Required
NextOcurrence	[Required] Next Ocurrence	date	Required

Request Formats

application/json, text/json

Sample:

{
  "links": [
    {
      "packageId": 1,
      "entityId": 2,
      "includeSubEntities": true
    },
    {
      "packageId": 1,
      "entityId": 2,
      "includeSubEntities": true
    }
  ],
  "recurrenceRule": "sample string 1",
  "profileStartDate": "2024-10-14T08:19:51.6060097-04:00",
  "runForPeriodId": 1,
  "nextOcurrence": "2024-10-14T08:19:51.6060097-04:00"
}

application/xml, text/xml

Sample:

<RSMRecurringPackageProfileInsertViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RSMRecurringPackages">
  <Links>
    <RSMPackageEntityLinkViewModelINSERT>
      <EntityId>2</EntityId>
      <IncludeSubEntities>true</IncludeSubEntities>
      <PackageId>1</PackageId>
    </RSMPackageEntityLinkViewModelINSERT>
    <RSMPackageEntityLinkViewModelINSERT>
      <EntityId>2</EntityId>
      <IncludeSubEntities>true</IncludeSubEntities>
      <PackageId>1</PackageId>
    </RSMPackageEntityLinkViewModelINSERT>
  </Links>
  <NextOcurrence>2024-10-14T08:19:51.6060097-04:00</NextOcurrence>
  <ProfileStartDate>2024-10-14T08:19:51.6060097-04:00</ProfileStartDate>
  <RecurrenceRule>sample string 1</RecurrenceRule>
  <RunForPeriodId>1</RunForPeriodId>
</RSMRecurringPackageProfileInsertViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RSMRecurringPackageProfileInsertViewModel'.

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:19:51.6060097-04:00",
  "profileStartDate": "2024-10-14T08:19:51.6060097-04:00",
  "runForPeriod": {
    "id": 1,
    "name": "sample string 2"
  },
  "createdOn": "2024-10-14T08:19:51.6060097-04:00",
  "createdBy": 4,
  "modifiedOn": "2024-10-14T08:19:51.6060097-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:19:51.6060097-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:19:51.6060097-04:00</ModifiedOn>
  <NextRunDate>2024-10-14T08:19:51.6060097-04:00</NextRunDate>
  <ProfileStartDate>2024-10-14T08:19:51.6060097-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>