POST api/me/orders/{orderId}/documents/appeals

This method should be used to force generation of documents and reports for a specific order

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	Id of existing order	integer	Required

Body Parameters

Collection of AppealDocumentRequestModel

Name	Description	Type	Additional information
PropertyAddressId		integer	None.
SelectedBundles		Collection of integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "propertyAddressId": 1,
    "selectedBundles": [
      1,
      2
    ]
  },
  {
    "propertyAddressId": 1,
    "selectedBundles": [
      1,
      2
    ]
  }
]

text/html

Sample:

[{"propertyAddressId":1,"selectedBundles":[1,2]},{"propertyAddressId":1,"selectedBundles":[1,2]}]

application/xml, text/xml

Sample:

<ArrayOfAppealDocumentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.DocumentGeneration">
  <AppealDocumentRequestModel>
    <PropertyAddressId>1</PropertyAddressId>
    <SelectedBundles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SelectedBundles>
  </AppealDocumentRequestModel>
  <AppealDocumentRequestModel>
    <PropertyAddressId>1</PropertyAddressId>
    <SelectedBundles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SelectedBundles>
  </AppealDocumentRequestModel>
</ArrayOfAppealDocumentRequestModel>

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 'List`1'.

Response Information

Resource Description

Collection of

Collection of OrderDocumentModel

Name	Type	Additional information
Id	integer	None.
AgencyCaseId	integer	None.
OrderId	integer	None.
OrderNumber	string	None.
UserId	integer	None.
UserName	string	None.
ProductBundleId	integer	None.
BundleName	string	None.
ProductId	integer	None.
ProductName	string	None.
DocumentId	integer	None.
DocumentName	string	None.
Description	string	None.
AppealYear	integer	None.
DocumentTemplateUri	string	None.
DocumentUri	string	None.
IsReport	boolean	None.
PreviewImageUrl	string	None.
CountyId	integer	None.
CountyName	string	None.
AgencyId	integer	None.
AgencyName	string	None.
AddedDate	date	None.
OrderDate	date	None.
ImprovementId	integer	None.
UserPropertyCaseId	integer	None.
ClientCanView	boolean	None.
IsSignatureRequired	boolean	None.
RegenerationAllowed	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "agencyCaseId": 1,
    "orderId": 2,
    "orderNumber": "sample string 3",
    "userId": 4,
    "userName": "sample string 5",
    "productBundleId": 6,
    "bundleName": "sample string 7",
    "productId": 8,
    "productName": "sample string 9",
    "documentId": 10,
    "documentName": "sample string 11",
    "description": "sample string 12",
    "appealYear": 13,
    "documentTemplateUri": "sample string 14",
    "documentUri": "sample string 15",
    "isReport": true,
    "previewImageUrl": "sample string 17",
    "countyId": 18,
    "countyName": "sample string 19",
    "agencyId": 20,
    "agencyName": "sample string 21",
    "addedDate": "2025-05-20T16:21:24.9703727-05:00",
    "orderDate": "2025-05-20T16:21:24.9703727-05:00",
    "improvementId": 1,
    "userPropertyCaseId": 24,
    "clientCanView": true,
    "isSignatureRequired": true,
    "regenerationAllowed": true
  },
  {
    "id": 1,
    "agencyCaseId": 1,
    "orderId": 2,
    "orderNumber": "sample string 3",
    "userId": 4,
    "userName": "sample string 5",
    "productBundleId": 6,
    "bundleName": "sample string 7",
    "productId": 8,
    "productName": "sample string 9",
    "documentId": 10,
    "documentName": "sample string 11",
    "description": "sample string 12",
    "appealYear": 13,
    "documentTemplateUri": "sample string 14",
    "documentUri": "sample string 15",
    "isReport": true,
    "previewImageUrl": "sample string 17",
    "countyId": 18,
    "countyName": "sample string 19",
    "agencyId": 20,
    "agencyName": "sample string 21",
    "addedDate": "2025-05-20T16:21:24.9703727-05:00",
    "orderDate": "2025-05-20T16:21:24.9703727-05:00",
    "improvementId": 1,
    "userPropertyCaseId": 24,
    "clientCanView": true,
    "isSignatureRequired": true,
    "regenerationAllowed": true
  }
]

text/html

Sample:

[{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T16:21:24.9703727-05:00","orderDate":"2025-05-20T16:21:24.9703727-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true},{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T16:21:24.9703727-05:00","orderDate":"2025-05-20T16:21:24.9703727-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true}]

application/xml, text/xml

Sample:

<ArrayOfOrderDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos.DocGen">
  <OrderDocumentModel>
    <AddedDate>2025-05-20T16:21:24.9703727-05:00</AddedDate>
    <AgencyCaseId>1</AgencyCaseId>
    <AgencyId>20</AgencyId>
    <AgencyName>sample string 21</AgencyName>
    <AppealYear>13</AppealYear>
    <BundleName>sample string 7</BundleName>
    <ClientCanView>true</ClientCanView>
    <CountyId>18</CountyId>
    <CountyName>sample string 19</CountyName>
    <Description>sample string 12</Description>
    <DocumentId>10</DocumentId>
    <DocumentName>sample string 11</DocumentName>
    <DocumentTemplateUri>sample string 14</DocumentTemplateUri>
    <DocumentUri>sample string 15</DocumentUri>
    <Id>1</Id>
    <ImprovementId>1</ImprovementId>
    <IsReport>true</IsReport>
    <IsSignatureRequired>true</IsSignatureRequired>
    <OrderDate>2025-05-20T16:21:24.9703727-05:00</OrderDate>
    <OrderId>2</OrderId>
    <OrderNumber>sample string 3</OrderNumber>
    <PreviewImageUrl>sample string 17</PreviewImageUrl>
    <ProductBundleId>6</ProductBundleId>
    <ProductId>8</ProductId>
    <ProductName>sample string 9</ProductName>
    <RegenerationAllowed>true</RegenerationAllowed>
    <UserId>4</UserId>
    <UserName>sample string 5</UserName>
    <UserPropertyCaseId>24</UserPropertyCaseId>
  </OrderDocumentModel>
  <OrderDocumentModel>
    <AddedDate>2025-05-20T16:21:24.9703727-05:00</AddedDate>
    <AgencyCaseId>1</AgencyCaseId>
    <AgencyId>20</AgencyId>
    <AgencyName>sample string 21</AgencyName>
    <AppealYear>13</AppealYear>
    <BundleName>sample string 7</BundleName>
    <ClientCanView>true</ClientCanView>
    <CountyId>18</CountyId>
    <CountyName>sample string 19</CountyName>
    <Description>sample string 12</Description>
    <DocumentId>10</DocumentId>
    <DocumentName>sample string 11</DocumentName>
    <DocumentTemplateUri>sample string 14</DocumentTemplateUri>
    <DocumentUri>sample string 15</DocumentUri>
    <Id>1</Id>
    <ImprovementId>1</ImprovementId>
    <IsReport>true</IsReport>
    <IsSignatureRequired>true</IsSignatureRequired>
    <OrderDate>2025-05-20T16:21:24.9703727-05:00</OrderDate>
    <OrderId>2</OrderId>
    <OrderNumber>sample string 3</OrderNumber>
    <PreviewImageUrl>sample string 17</PreviewImageUrl>
    <ProductBundleId>6</ProductBundleId>
    <ProductId>8</ProductId>
    <ProductName>sample string 9</ProductName>
    <RegenerationAllowed>true</RegenerationAllowed>
    <UserId>4</UserId>
    <UserName>sample string 5</UserName>
    <UserPropertyCaseId>24</UserPropertyCaseId>
  </OrderDocumentModel>
</ArrayOfOrderDocumentModel>