POST api/interop/Renewal

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PermitId		integer	None.
PermitCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "PermitId": 1,
  "PermitCode": "sample string 2"
}

application/xml, text/xml

Sample:

<RenewalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pass.WebApi.Models.Interop">
  <PermitCode>sample string 2</PermitCode>
  <PermitId>1</PermitId>
</RenewalRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RenewalResponse

Name	Type	Additional information
Customer	CustomerInfo	None.
PermitRenewalInfo	PermitInfo	None.
Ok	boolean	None.
Message	string	None.
ValidationErrors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Customer": {
    "CustomerType": 0,
    "Name": "sample string 1",
    "Surname": "sample string 2",
    "FiscalCode": "sample string 3",
    "CompanyName": "sample string 4",
    "VatCode": "sample string 5"
  },
  "PermitRenewalInfo": {
    "PermitId": 1,
    "PermitCode": "sample string 2",
    "PermitTypeId": 3,
    "PermitTypeCode": "sample string 4",
    "CategoryId": 1,
    "CategoryDescription": "sample string 5",
    "CategoryCode": "sample string 6",
    "PermitType": "sample string 7",
    "ZoneId": 1,
    "ZoneDescription": "sample string 8",
    "ZoneNotes": "sample string 9",
    "ValidFrom": "2026-05-24T18:08:36.5088818+02:00",
    "ValidTo": "2026-05-24T18:08:36.5088818+02:00",
    "IssuingDate": "2026-05-24T18:08:36.5088818+02:00",
    "PermitStatusId": 10,
    "PermitStatusDescription": "sample string 11",
    "TotalPrice": 1.0,
    "Costs": [
      {
        "CostDescription": "sample string 1",
        "Amount": 2.0
      },
      {
        "CostDescription": "sample string 1",
        "Amount": 2.0
      }
    ],
    "Vehicles": [
      {
        "VehicleDescription": "sample string 1",
        "Plate": "sample string 2"
      },
      {
        "VehicleDescription": "sample string 1",
        "Plate": "sample string 2"
      }
    ],
    "CreationDate": "2026-05-24T18:08:36.5088818+02:00",
    "PermitHierarchyInfo": {
      "PermitId": 1,
      "PermitCode": "sample string 1",
      "SiblingPermitId": 1,
      "ParentPermitId": 1,
      "SuperPermitId": 1,
      "RootPermitId": 1
    },
    "OperationId": 12,
    "OperationDescription": "sample string 13"
  },
  "Ok": true,
  "Message": "sample string 2",
  "ValidationErrors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<RenewalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pass.WebApi.Models.Interop">
  <Message>sample string 2</Message>
  <Ok>true</Ok>
  <ValidationErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ValidationErrors>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pass.Models.Interop">
    <d2p1:CompanyName>sample string 4</d2p1:CompanyName>
    <d2p1:CustomerType>Person</d2p1:CustomerType>
    <d2p1:FiscalCode>sample string 3</d2p1:FiscalCode>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Surname>sample string 2</d2p1:Surname>
    <d2p1:VatCode>sample string 5</d2p1:VatCode>
  </Customer>
  <PermitRenewalInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pass.Models.Interop">
    <d2p1:CategoryCode>sample string 6</d2p1:CategoryCode>
    <d2p1:CategoryDescription>sample string 5</d2p1:CategoryDescription>
    <d2p1:CategoryId>1</d2p1:CategoryId>
    <d2p1:Costs>
      <d2p1:CostInfo>
        <d2p1:Amount>2</d2p1:Amount>
        <d2p1:CostDescription>sample string 1</d2p1:CostDescription>
      </d2p1:CostInfo>
      <d2p1:CostInfo>
        <d2p1:Amount>2</d2p1:Amount>
        <d2p1:CostDescription>sample string 1</d2p1:CostDescription>
      </d2p1:CostInfo>
    </d2p1:Costs>
    <d2p1:CreationDate>2026-05-24T18:08:36.5088818+02:00</d2p1:CreationDate>
    <d2p1:IssuingDate>2026-05-24T18:08:36.5088818+02:00</d2p1:IssuingDate>
    <d2p1:OperationDescription>sample string 13</d2p1:OperationDescription>
    <d2p1:OperationId>12</d2p1:OperationId>
    <d2p1:PermitCode>sample string 2</d2p1:PermitCode>
    <d2p1:PermitHierarchyInfo>
      <d2p1:ParentPermitId>1</d2p1:ParentPermitId>
      <d2p1:PermitCode>sample string 1</d2p1:PermitCode>
      <d2p1:PermitId>1</d2p1:PermitId>
      <d2p1:RootPermitId>1</d2p1:RootPermitId>
      <d2p1:SiblingPermitId>1</d2p1:SiblingPermitId>
      <d2p1:SuperPermitId>1</d2p1:SuperPermitId>
    </d2p1:PermitHierarchyInfo>
    <d2p1:PermitId>1</d2p1:PermitId>
    <d2p1:PermitStatusDescription>sample string 11</d2p1:PermitStatusDescription>
    <d2p1:PermitStatusId>10</d2p1:PermitStatusId>
    <d2p1:PermitType>sample string 7</d2p1:PermitType>
    <d2p1:PermitTypeCode>sample string 4</d2p1:PermitTypeCode>
    <d2p1:PermitTypeId>3</d2p1:PermitTypeId>
    <d2p1:TotalPrice>1</d2p1:TotalPrice>
    <d2p1:ValidFrom>2026-05-24T18:08:36.5088818+02:00</d2p1:ValidFrom>
    <d2p1:ValidTo>2026-05-24T18:08:36.5088818+02:00</d2p1:ValidTo>
    <d2p1:Vehicles>
      <d2p1:VehicleInfo>
        <d2p1:Plate>sample string 2</d2p1:Plate>
        <d2p1:VehicleDescription>sample string 1</d2p1:VehicleDescription>
      </d2p1:VehicleInfo>
      <d2p1:VehicleInfo>
        <d2p1:Plate>sample string 2</d2p1:Plate>
        <d2p1:VehicleDescription>sample string 1</d2p1:VehicleDescription>
      </d2p1:VehicleInfo>
    </d2p1:Vehicles>
    <d2p1:ZoneDescription>sample string 8</d2p1:ZoneDescription>
    <d2p1:ZoneId>1</d2p1:ZoneId>
    <d2p1:ZoneNotes>sample string 9</d2p1:ZoneNotes>
  </PermitRenewalInfo>
</RenewalResponse>