POST api/documentgeneration/recreateepc

Creates a new epc document. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The create epc data contract supplied with the request.

CreateEpcDataContract
NameDescriptionTypeAdditional information
RoleId

The unique identifier of the related role resource.

 integer

None.
PropertyId

The unique identifier of the related property resource.

 integer

None.
EPCType

The epc type value.

 EnumDataContract

None.
EERCurrent

The eer current value.

 integer

None.
EERPotential

The eer potential value.

 integer

None.
EIRCurrent

The eir current value.

 integer

None.
EIRPotential

The eir potential value.

 integer

None.
EPARCurrent

The epar current value.

 integer

None.
EPARPotential

The epar potential value.

 integer

None.
CurrentEPCDocumentId

The unique identifier of the related current epc document resource.

 integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample: 
{
  "RoleId": 1,
  "PropertyId": 2,
  "EPCType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EERCurrent": 3,
  "EERPotential": 4,
  "EIRCurrent": 5,
  "EIRPotential": 6,
  "EPARCurrent": 7,
  "EPARPotential": 8,
  "CurrentEPCDocumentId": 1
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

Indicates whether supports cancellation is true.

 boolean

None.
ReportsProgress

Indicates whether reports progress is true.

 boolean

None.
InitialStatusText

The initial status text value.

 string

None.
JobReference

The job reference globally unique identifier.

 globally unique identifier

None.
Success

Indicates whether success is true.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "7df7c9c7-82fb-4210-a6bd-d5032b0235e5",
  "Success": true
}