POST api/FilePlans/PostFilePlan
Request Information
URI Parameters
None.
Body Parameters
FilePlanViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| FileplanName | string |
None. |
|
| Description | string |
None. |
|
| FileplanType | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | string |
None. |
|
| FileReferenceId | string |
None. |
|
| Year | string |
None. |
|
| Department | string |
None. |
|
| Division | string |
None. |
|
| Section | string |
None. |
|
| Subject | string |
None. |
|
| FormCode | string |
None. |
|
| FileId | integer |
None. |
|
| Preservation | string |
None. |
|
| Period | string |
None. |
|
| DisappearDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"FileplanName": "sample string 2",
"Description": "sample string 3",
"FileplanType": "sample string 4",
"CreatedBy": "sample string 5",
"CreatedOn": "sample string 6",
"FileReferenceId": "sample string 7",
"Year": "sample string 8",
"Department": "sample string 9",
"Division": "sample string 10",
"Section": "sample string 11",
"Subject": "sample string 12",
"FormCode": "sample string 13",
"FileId": 14,
"Preservation": "sample string 15",
"Period": "sample string 16",
"DisappearDate": "2026-07-31T15:17:33.4700626-07:00"
}
application/xml, text/xml
Sample:
<FilePlanViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BILLING.BAL.DMSViewModels"> <CreatedBy>sample string 5</CreatedBy> <CreatedOn>sample string 6</CreatedOn> <Department>sample string 9</Department> <Description>sample string 3</Description> <DisappearDate>2026-07-31T15:17:33.4700626-07:00</DisappearDate> <Division>sample string 10</Division> <FileId>14</FileId> <FileReferenceId>sample string 7</FileReferenceId> <FileplanName>sample string 2</FileplanName> <FileplanType>sample string 4</FileplanType> <FormCode>sample string 13</FormCode> <ID>1</ID> <Period>sample string 16</Period> <Preservation>sample string 15</Preservation> <Section>sample string 11</Section> <Subject>sample string 12</Subject> <Year>sample string 8</Year> </FilePlanViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
FilePlan| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| FileplanName | string |
None. |
|
| Description | string |
None. |
|
| FileplanType | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
|
| FileReferenceId | string |
None. |
|
| Year | string |
None. |
|
| Department | string |
None. |
|
| Section | string |
None. |
|
| Subject | string |
None. |
|
| Division | string |
None. |
|
| FormCode | string |
None. |
|
| Type | string |
None. |
|
| FileId | string |
None. |
|
| Preservation | string |
None. |
|
| Period | string |
None. |
|
| DisappearDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": 1,
"FileplanName": "sample string 2",
"Description": "sample string 3",
"FileplanType": "sample string 4",
"CreatedBy": "sample string 5",
"CreatedOn": "2026-07-31T15:17:33.500063-07:00",
"FileReferenceId": "sample string 6",
"Year": "sample string 7",
"Department": "sample string 8",
"Section": "sample string 9",
"Subject": "sample string 10",
"Division": "sample string 11",
"FormCode": "sample string 12",
"Type": "sample string 13",
"FileId": "sample string 14",
"Preservation": "sample string 15",
"Period": "sample string 16",
"DisappearDate": "2026-07-31T15:17:33.5010636-07:00"
}
application/xml, text/xml
Sample:
<FilePlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BILLING.DAL.DataModel"> <CreatedBy>sample string 5</CreatedBy> <CreatedOn>2026-07-31T15:17:33.500063-07:00</CreatedOn> <Department>sample string 8</Department> <Description>sample string 3</Description> <DisappearDate>2026-07-31T15:17:33.5010636-07:00</DisappearDate> <Division>sample string 11</Division> <FileId>sample string 14</FileId> <FileReferenceId>sample string 6</FileReferenceId> <FileplanName>sample string 2</FileplanName> <FileplanType>sample string 4</FileplanType> <FormCode>sample string 12</FormCode> <ID>1</ID> <Period>sample string 16</Period> <Preservation>sample string 15</Preservation> <Section>sample string 9</Section> <Subject>sample string 10</Subject> <Type>sample string 13</Type> <Year>sample string 7</Year> </FilePlan>