POST api/ui/claims/unsubscribewithresponse/{ResponseStatusId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ResponseStatusId

integer

Required

Body Parameters

Collection of CustomerClaimRecordForExport
NameDescriptionTypeAdditional information
ClaimReference

string

None.

CustomerId

integer

None.

Title

string

None.

FirstName

string

None.

Surname

string

None.

Address1

string

None.

Address2

string

None.

Address3

string

None.

Postcode

string

None.

County

string

None.

NI

string

None.

TaxReference

string

None.

TaxOfficeNo

string

None.

EmailAddress

string

None.

Phone

string

None.

DateUpdated

date

None.

Employer

string

None.

JobTitle

string

None.

DataReference

string

None.

TaxYears

string

None.

FirstPartyPermission

boolean

None.

ThirdPartyPermission

boolean

None.

ClaimPaid

boolean

None.

ClaimGross

decimal number

None.

DaysSinceFormsReceived

integer

None.

EnergyClubLink

string

None.

UserId

string

None.

SubmittedDirectlyToHMRC

boolean

None.

DateSignedFormPrinted

date

None.

DaysSinceSignedFormSentToHMRC

integer

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "ClaimReference": "sample string 1",
    "CustomerId": 2,
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "Surname": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "Postcode": "sample string 9",
    "County": "sample string 10",
    "NI": "sample string 11",
    "TaxReference": "sample string 12",
    "TaxOfficeNo": "sample string 13",
    "EmailAddress": "sample string 14",
    "Phone": "sample string 15",
    "DateUpdated": "2019-10-21T09:05:34.5663745",
    "Employer": "sample string 17",
    "JobTitle": "sample string 18",
    "DataReference": "sample string 19",
    "TaxYears": "sample string 20",
    "FirstPartyPermission": true,
    "ThirdPartyPermission": true,
    "ClaimPaid": true,
    "ClaimGross": 24.0,
    "DaysSinceFormsReceived": 25,
    "EnergyClubLink": "sample string 26",
    "UserId": "sample string 27",
    "SubmittedDirectlyToHMRC": true,
    "DateSignedFormPrinted": "2019-10-21T09:05:34.5663745",
    "DaysSinceSignedFormSentToHMRC": 29
  },
  {
    "ClaimReference": "sample string 1",
    "CustomerId": 2,
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "Surname": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "Postcode": "sample string 9",
    "County": "sample string 10",
    "NI": "sample string 11",
    "TaxReference": "sample string 12",
    "TaxOfficeNo": "sample string 13",
    "EmailAddress": "sample string 14",
    "Phone": "sample string 15",
    "DateUpdated": "2019-10-21T09:05:34.5663745",
    "Employer": "sample string 17",
    "JobTitle": "sample string 18",
    "DataReference": "sample string 19",
    "TaxYears": "sample string 20",
    "FirstPartyPermission": true,
    "ThirdPartyPermission": true,
    "ClaimPaid": true,
    "ClaimGross": 24.0,
    "DaysSinceFormsReceived": 25,
    "EnergyClubLink": "sample string 26",
    "UserId": "sample string 27",
    "SubmittedDirectlyToHMRC": true,
    "DateSignedFormPrinted": "2019-10-21T09:05:34.5663745",
    "DaysSinceSignedFormSentToHMRC": 29
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerClaimRecordForExport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TaxRebate.TaxRefunds">
  <CustomerClaimRecordForExport>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <ClaimGross>24</ClaimGross>
    <ClaimPaid>true</ClaimPaid>
    <ClaimReference>sample string 1</ClaimReference>
    <County>sample string 10</County>
    <CustomerId>2</CustomerId>
    <DataReference>sample string 19</DataReference>
    <DateSignedFormPrinted>2019-10-21T09:05:34.5663745+01:00</DateSignedFormPrinted>
    <DateUpdated>2019-10-21T09:05:34.5663745+01:00</DateUpdated>
    <DaysSinceFormsReceived>25</DaysSinceFormsReceived>
    <DaysSinceSignedFormSentToHMRC>29</DaysSinceSignedFormSentToHMRC>
    <EmailAddress>sample string 14</EmailAddress>
    <Employer>sample string 17</Employer>
    <EnergyClubLink>sample string 26</EnergyClubLink>
    <FirstName>sample string 4</FirstName>
    <FirstPartyPermission>true</FirstPartyPermission>
    <JobTitle>sample string 18</JobTitle>
    <NI>sample string 11</NI>
    <Phone>sample string 15</Phone>
    <Postcode>sample string 9</Postcode>
    <SubmittedDirectlyToHMRC>true</SubmittedDirectlyToHMRC>
    <Surname>sample string 5</Surname>
    <TaxOfficeNo>sample string 13</TaxOfficeNo>
    <TaxReference>sample string 12</TaxReference>
    <TaxYears>sample string 20</TaxYears>
    <ThirdPartyPermission>true</ThirdPartyPermission>
    <Title>sample string 3</Title>
    <UserId>sample string 27</UserId>
  </CustomerClaimRecordForExport>
  <CustomerClaimRecordForExport>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <ClaimGross>24</ClaimGross>
    <ClaimPaid>true</ClaimPaid>
    <ClaimReference>sample string 1</ClaimReference>
    <County>sample string 10</County>
    <CustomerId>2</CustomerId>
    <DataReference>sample string 19</DataReference>
    <DateSignedFormPrinted>2019-10-21T09:05:34.5663745+01:00</DateSignedFormPrinted>
    <DateUpdated>2019-10-21T09:05:34.5663745+01:00</DateUpdated>
    <DaysSinceFormsReceived>25</DaysSinceFormsReceived>
    <DaysSinceSignedFormSentToHMRC>29</DaysSinceSignedFormSentToHMRC>
    <EmailAddress>sample string 14</EmailAddress>
    <Employer>sample string 17</Employer>
    <EnergyClubLink>sample string 26</EnergyClubLink>
    <FirstName>sample string 4</FirstName>
    <FirstPartyPermission>true</FirstPartyPermission>
    <JobTitle>sample string 18</JobTitle>
    <NI>sample string 11</NI>
    <Phone>sample string 15</Phone>
    <Postcode>sample string 9</Postcode>
    <SubmittedDirectlyToHMRC>true</SubmittedDirectlyToHMRC>
    <Surname>sample string 5</Surname>
    <TaxOfficeNo>sample string 13</TaxOfficeNo>
    <TaxReference>sample string 12</TaxReference>
    <TaxYears>sample string 20</TaxYears>
    <ThirdPartyPermission>true</ThirdPartyPermission>
    <Title>sample string 3</Title>
    <UserId>sample string 27</UserId>
  </CustomerClaimRecordForExport>
</ArrayOfCustomerClaimRecordForExport>

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

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.