POST api/Application/Renew

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CertificateId	globally unique identifier	None.
Reference	string	Required String length: inclusive between 0 and 10
CompanyId	globally unique identifier	None.
CertificateStatusId	integer	None.
CertificateTypeId	integer	None.
IssueDate	date	None.
ExpiryDate	date	None.
StepsCompleted	integer	None.
DeclarationId	integer	None.
PaymentId	integer	None.
CertificateCategory	integer	None.
CertificationBody	string	String length: inclusive between 0 and 50
CertificationRegNo	string	String length: inclusive between 0 and 50
CanRenew	boolean	None.
UserId	globally unique identifier	None.
AuditUserId	globally unique identifier	None.
CertificateAudits	Collection of CertificateAuditDto	None.

Request Formats

application/json, text/json

Sample:

{
  "certificateId": "e59b5ed6-9a1b-4192-9ff5-956ed26204d6",
  "reference": "sample string 2",
  "companyId": "1d32180c-b45f-4563-9a04-57bcb71a53dc",
  "certificateStatusId": 4,
  "certificateTypeId": 5,
  "issueDate": "2025-06-26T15:32:57.7838073+00:00",
  "expiryDate": "2025-06-26T15:32:57.7838073+00:00",
  "stepsCompleted": 6,
  "declarationId": 7,
  "paymentId": 1,
  "certificateCategory": 1,
  "certificationBody": "sample string 8",
  "certificationRegNo": "sample string 9",
  "canRenew": true,
  "userId": "dc81ae66-fc25-434b-b421-6c4a6a3c01b8",
  "auditUserId": "1358af7f-ad48-4e95-83fa-20cde35c58f3",
  "certificateAudits": [
    {
      "certifcateAuditId": "f66c2175-f355-478d-9c34-371cdd99f18c",
      "certificateId": "5c436ad5-01e6-44e9-b142-69970cf576fa",
      "auditCode": "sample string 3",
      "auditDateTime": "2025-06-26T15:32:57.7838073+00:00",
      "userId": "0eb95677-3685-452e-90ec-6e84a560ef4a",
      "dataFrom": "sample string 6",
      "dataTo": "sample string 7",
      "eventData": "sample string 8"
    },
    {
      "certifcateAuditId": "f66c2175-f355-478d-9c34-371cdd99f18c",
      "certificateId": "5c436ad5-01e6-44e9-b142-69970cf576fa",
      "auditCode": "sample string 3",
      "auditDateTime": "2025-06-26T15:32:57.7838073+00:00",
      "userId": "0eb95677-3685-452e-90ec-6e84a560ef4a",
      "dataFrom": "sample string 6",
      "dataTo": "sample string 7",
      "eventData": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<CertificateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTO.Model">
  <AuditUserId>1358af7f-ad48-4e95-83fa-20cde35c58f3</AuditUserId>
  <CanRenew>true</CanRenew>
  <CertificateAudits>
    <CertificateAuditDto>
      <AuditCode>sample string 3</AuditCode>
      <AuditDateTime>2025-06-26T15:32:57.7838073+00:00</AuditDateTime>
      <CertifcateAuditId>f66c2175-f355-478d-9c34-371cdd99f18c</CertifcateAuditId>
      <CertificateId>5c436ad5-01e6-44e9-b142-69970cf576fa</CertificateId>
      <DataFrom>sample string 6</DataFrom>
      <DataTo>sample string 7</DataTo>
      <EventData>sample string 8</EventData>
      <UserId>0eb95677-3685-452e-90ec-6e84a560ef4a</UserId>
    </CertificateAuditDto>
    <CertificateAuditDto>
      <AuditCode>sample string 3</AuditCode>
      <AuditDateTime>2025-06-26T15:32:57.7838073+00:00</AuditDateTime>
      <CertifcateAuditId>f66c2175-f355-478d-9c34-371cdd99f18c</CertifcateAuditId>
      <CertificateId>5c436ad5-01e6-44e9-b142-69970cf576fa</CertificateId>
      <DataFrom>sample string 6</DataFrom>
      <DataTo>sample string 7</DataTo>
      <EventData>sample string 8</EventData>
      <UserId>0eb95677-3685-452e-90ec-6e84a560ef4a</UserId>
    </CertificateAuditDto>
  </CertificateAudits>
  <CertificateCategory>1</CertificateCategory>
  <CertificateId>e59b5ed6-9a1b-4192-9ff5-956ed26204d6</CertificateId>
  <CertificateStatusId>4</CertificateStatusId>
  <CertificateTypeId>5</CertificateTypeId>
  <CertificationBody>sample string 8</CertificationBody>
  <CertificationRegNo>sample string 9</CertificationRegNo>
  <CompanyId>1d32180c-b45f-4563-9a04-57bcb71a53dc</CompanyId>
  <DeclarationId>7</DeclarationId>
  <ExpiryDate>2025-06-26T15:32:57.7838073+00:00</ExpiryDate>
  <IssueDate>2025-06-26T15:32:57.7838073+00:00</IssueDate>
  <PaymentId>1</PaymentId>
  <Reference>sample string 2</Reference>
  <StepsCompleted>6</StepsCompleted>
  <UserId>dc81ae66-fc25-434b-b421-6c4a6a3c01b8</UserId>
</CertificateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.