POST api/Sagepay?multiSiteCost={multiSiteCost}

Request Information

URI Parameters

Name	Description	Type	Additional information
multiSiteCost		decimal number	Required

Body Parameters

ApplicationDto

Name	Type	Additional information
ApplicationId	globally unique identifier	None.
Scheme	string	String length: inclusive between 0 and 10
UserId	string	Required String length: inclusive between 0 and 128
CompanyId	globally unique identifier	None.
CompanyName	string	Required String length: inclusive between 0 and 100
AddressLine1	string	String length: inclusive between 0 and 50
AddressLine2	string	String length: inclusive between 0 and 50
AddressLine3	string	String length: inclusive between 0 and 50
Town	string	String length: inclusive between 0 and 50
County	string	String length: inclusive between 0 and 50
Country	string	String length: inclusive between 0 and 50
Postcode	string	String length: inclusive between 0 and 10
Website	string	String length: inclusive between 0 and 100
EmailAddress	string	String length: inclusive between 0 and 100
TelephoneNo	string	String length: inclusive between 0 and 25
FaxNo	string	String length: inclusive between 0 and 25
IsBesaMember	boolean	None.
PaymentStatusId	integer	None.
HVNo	string	String length: inclusive between 0 and 8
IsEliteMember	boolean	None.
EliteMembershipNo	string	String length: inclusive between 0 and 10
CertificationBody	string	String length: inclusive between 0 and 20
FGasMembershipNo	string	String length: inclusive between 0 and 20
CompanyTypeId	integer	None.
CompanySizeId	integer	None.
CompanyNatureId	integer	None.
DateEstablished	date	None.
RegistrationNo	string	String length: inclusive between 0 and 20
VatNumber	string	String length: inclusive between 0 and 15
InscopeTurnover	integer	None.
SubContractorCompanies	integer	None.
InstallationPercentage	integer	None.
ServicingPercentage	integer	None.
CommissioningPercentage	integer	None.
DecommissioningPercentage	integer	None.
OtherPercentage	integer	None.
NoOfSystems	integer	None.
HasWeighingFacilities	boolean	None.
HasHandlingProcedures	boolean	None.
WasteCarrierRegNo	string	String length: inclusive between 0 and 50
WasteCarrierExpiryDate	date	None.
WasteCarrierIssuedBy	string	String length: inclusive between 0 and 50
RecoveryNotes	string	None.
WeighingNotes	string	None.
Engineers	integer	None.
CertificatedEngineers	integer	None.
OptOutSearch	boolean	None.
OptOutMarketing	boolean	None.
DeclarationName	string	String length: inclusive between 0 and 50
DeclarationPosition	string	String length: inclusive between 0 and 100
DeclarationDate	date	None.
PrincipalFirstName	string	String length: inclusive between 0 and 50
PrincipalLastName	string	String length: inclusive between 0 and 50
PrincipalPosition	string	String length: inclusive between 0 and 100
PrincipalEmail	string	String length: inclusive between 0 and 100
PrincipalTelephoneNo	string	String length: inclusive between 0 and 25
SchemeFirstName	string	String length: inclusive between 0 and 50
SchemeLastName	string	String length: inclusive between 0 and 50
SchemeEmail	string	String length: inclusive between 0 and 100
SchemeTelephoneNo	string	String length: inclusive between 0 and 25
BillingFirstName	string	String length: inclusive between 0 and 20
BillingLastName	string	String length: inclusive between 0 and 20
BillingAddress1	string	String length: inclusive between 0 and 100
BillingAddress2	string	String length: inclusive between 0 and 100
BillingAddress3	string	String length: inclusive between 0 and 100
BillingTown	string	String length: inclusive between 0 and 50
BillingCounty	string	String length: inclusive between 0 and 50
BillingPostcode	string	String length: inclusive between 0 and 10
BillingEmail	string	String length: inclusive between 0 and 100
BillingPhone	string	String length: inclusive between 0 and 20
ChequeAmount	decimal number	None.
ChequeDate	date	None.
ChequeReference	string	String length: inclusive between 0 and 20
CreatedDate	date	None.
LastUpdatedDate	date	None.
StepsCompleted	integer	None.
Submitted	boolean	None.
Simulated	boolean	None.
MembershipStartDate	date	None.
MembershipEndDate	date	None.
ApplicationEngineers	Collection of ApplicationEngineerDto	None.

Request Formats

application/json, text/json

Sample:

{
  "applicationId": "767e2b9e-a8f7-4c0b-ac65-e224f2fdcbdc",
  "scheme": "sample string 2",
  "userId": "sample string 3",
  "companyId": "9ab4325d-4b1b-41f1-8c40-f08c8c657a73",
  "companyName": "sample string 4",
  "addressLine1": "sample string 5",
  "addressLine2": "sample string 6",
  "addressLine3": "sample string 7",
  "town": "sample string 8",
  "county": "sample string 9",
  "country": "sample string 10",
  "postcode": "sample string 11",
  "website": "sample string 12",
  "emailAddress": "sample string 13",
  "telephoneNo": "sample string 14",
  "faxNo": "sample string 15",
  "isBesaMember": true,
  "paymentStatusId": 1,
  "hvNo": "sample string 17",
  "isEliteMember": true,
  "eliteMembershipNo": "sample string 19",
  "certificationBody": "sample string 20",
  "fGasMembershipNo": "sample string 21",
  "companyTypeId": 1,
  "companySizeId": 1,
  "companyNatureId": 1,
  "dateEstablished": "2025-05-01T08:04:25.4266904+00:00",
  "registrationNo": "sample string 22",
  "vatNumber": "sample string 23",
  "inscopeTurnover": 1,
  "subContractorCompanies": 1,
  "installationPercentage": 1,
  "servicingPercentage": 1,
  "commissioningPercentage": 1,
  "decommissioningPercentage": 1,
  "otherPercentage": 1,
  "noOfSystems": 1,
  "hasWeighingFacilities": true,
  "hasHandlingProcedures": true,
  "wasteCarrierRegNo": "sample string 26",
  "wasteCarrierExpiryDate": "2025-05-01T08:04:25.4266904+00:00",
  "wasteCarrierIssuedBy": "sample string 27",
  "recoveryNotes": "sample string 28",
  "weighingNotes": "sample string 29",
  "engineers": 1,
  "certificatedEngineers": 1,
  "optOutSearch": true,
  "optOutMarketing": true,
  "declarationName": "sample string 32",
  "declarationPosition": "sample string 33",
  "declarationDate": "2025-05-01T08:04:25.4266904+00:00",
  "principalFirstName": "sample string 34",
  "principalLastName": "sample string 35",
  "principalPosition": "sample string 36",
  "principalEmail": "sample string 37",
  "principalTelephoneNo": "sample string 38",
  "schemeFirstName": "sample string 39",
  "schemeLastName": "sample string 40",
  "schemeEmail": "sample string 41",
  "schemeTelephoneNo": "sample string 42",
  "billingFirstName": "sample string 43",
  "billingLastName": "sample string 44",
  "billingAddress1": "sample string 45",
  "billingAddress2": "sample string 46",
  "billingAddress3": "sample string 47",
  "billingTown": "sample string 48",
  "billingCounty": "sample string 49",
  "billingPostcode": "sample string 50",
  "billingEmail": "sample string 51",
  "billingPhone": "sample string 52",
  "chequeAmount": 1.0,
  "chequeDate": "2025-05-01T08:04:25.4266904+00:00",
  "chequeReference": "sample string 53",
  "createdDate": "2025-05-01T08:04:25.4266904+00:00",
  "lastUpdatedDate": "2025-05-01T08:04:25.4266904+00:00",
  "stepsCompleted": 1,
  "submitted": true,
  "simulated": true,
  "membershipStartDate": "2025-05-01T08:04:25.4266904+00:00",
  "membershipEndDate": "2025-05-01T08:04:25.4266904+00:00",
  "applicationEngineers": [
    {
      "applicationEngineerId": "e4e32f71-1c71-4100-9b46-bfd7ed1d2caf",
      "applicationId": "b41a4d51-f42c-4aeb-8a21-63bffe52eb77",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "dateOfBirth": "2025-05-01T08:04:25.4423891+00:00",
      "niNo": "sample string 5",
      "qualificationNo": "sample string 6",
      "qualificationTypeId": 1,
      "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
      "eliteQualificationTypeId": 1,
      "acribSkillcardNo": "sample string 7",
      "acribSkillcardExpiryDate": "2025-05-01T08:04:25.4423891+00:00",
      "qualificationRegistration": "sample string 8",
      "acribRegistration": "sample string 9",
      "skillcard": "sample string 10",
      "additionalQualifications": [
        {
          "applicationEngineerQualificationId": 1,
          "applicationEngineerId": "e9daa360-6399-488e-a241-faf08f4741f7",
          "qualificationNo": "sample string 3",
          "qualificationTypeId": 4,
          "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
          "additional": true,
          "awardingBody": "sample string 6"
        },
        {
          "applicationEngineerQualificationId": 1,
          "applicationEngineerId": "e9daa360-6399-488e-a241-faf08f4741f7",
          "qualificationNo": "sample string 3",
          "qualificationTypeId": 4,
          "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
          "additional": true,
          "awardingBody": "sample string 6"
        }
      ]
    },
    {
      "applicationEngineerId": "e4e32f71-1c71-4100-9b46-bfd7ed1d2caf",
      "applicationId": "b41a4d51-f42c-4aeb-8a21-63bffe52eb77",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "dateOfBirth": "2025-05-01T08:04:25.4423891+00:00",
      "niNo": "sample string 5",
      "qualificationNo": "sample string 6",
      "qualificationTypeId": 1,
      "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
      "eliteQualificationTypeId": 1,
      "acribSkillcardNo": "sample string 7",
      "acribSkillcardExpiryDate": "2025-05-01T08:04:25.4423891+00:00",
      "qualificationRegistration": "sample string 8",
      "acribRegistration": "sample string 9",
      "skillcard": "sample string 10",
      "additionalQualifications": [
        {
          "applicationEngineerQualificationId": 1,
          "applicationEngineerId": "e9daa360-6399-488e-a241-faf08f4741f7",
          "qualificationNo": "sample string 3",
          "qualificationTypeId": 4,
          "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
          "additional": true,
          "awardingBody": "sample string 6"
        },
        {
          "applicationEngineerQualificationId": 1,
          "applicationEngineerId": "e9daa360-6399-488e-a241-faf08f4741f7",
          "qualificationNo": "sample string 3",
          "qualificationTypeId": 4,
          "dateAwarded": "2025-05-01T08:04:25.4423891+00:00",
          "additional": true,
          "awardingBody": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApplicationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTO.Model">
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <AddressLine3>sample string 7</AddressLine3>
  <ApplicationEngineers>
    <ApplicationEngineerDto>
      <AcribRegistration>sample string 9</AcribRegistration>
      <AcribSkillcardExpiryDate>2025-05-01T08:04:25.4423891+00:00</AcribSkillcardExpiryDate>
      <AcribSkillcardNo>sample string 7</AcribSkillcardNo>
      <AdditionalQualifications>
        <ApplicationEngineerQualificationDto>
          <Additional>true</Additional>
          <ApplicationEngineerId>e9daa360-6399-488e-a241-faf08f4741f7</ApplicationEngineerId>
          <ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
          <AwardingBody>sample string 6</AwardingBody>
          <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
          <QualificationNo>sample string 3</QualificationNo>
          <QualificationTypeId>4</QualificationTypeId>
        </ApplicationEngineerQualificationDto>
        <ApplicationEngineerQualificationDto>
          <Additional>true</Additional>
          <ApplicationEngineerId>e9daa360-6399-488e-a241-faf08f4741f7</ApplicationEngineerId>
          <ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
          <AwardingBody>sample string 6</AwardingBody>
          <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
          <QualificationNo>sample string 3</QualificationNo>
          <QualificationTypeId>4</QualificationTypeId>
        </ApplicationEngineerQualificationDto>
      </AdditionalQualifications>
      <ApplicationEngineerId>e4e32f71-1c71-4100-9b46-bfd7ed1d2caf</ApplicationEngineerId>
      <ApplicationId>b41a4d51-f42c-4aeb-8a21-63bffe52eb77</ApplicationId>
      <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
      <DateOfBirth>2025-05-01T08:04:25.4423891+00:00</DateOfBirth>
      <EliteQualificationTypeId>1</EliteQualificationTypeId>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <NINo>sample string 5</NINo>
      <QualificationNo>sample string 6</QualificationNo>
      <QualificationRegistration>sample string 8</QualificationRegistration>
      <QualificationTypeId>1</QualificationTypeId>
      <Skillcard>sample string 10</Skillcard>
    </ApplicationEngineerDto>
    <ApplicationEngineerDto>
      <AcribRegistration>sample string 9</AcribRegistration>
      <AcribSkillcardExpiryDate>2025-05-01T08:04:25.4423891+00:00</AcribSkillcardExpiryDate>
      <AcribSkillcardNo>sample string 7</AcribSkillcardNo>
      <AdditionalQualifications>
        <ApplicationEngineerQualificationDto>
          <Additional>true</Additional>
          <ApplicationEngineerId>e9daa360-6399-488e-a241-faf08f4741f7</ApplicationEngineerId>
          <ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
          <AwardingBody>sample string 6</AwardingBody>
          <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
          <QualificationNo>sample string 3</QualificationNo>
          <QualificationTypeId>4</QualificationTypeId>
        </ApplicationEngineerQualificationDto>
        <ApplicationEngineerQualificationDto>
          <Additional>true</Additional>
          <ApplicationEngineerId>e9daa360-6399-488e-a241-faf08f4741f7</ApplicationEngineerId>
          <ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
          <AwardingBody>sample string 6</AwardingBody>
          <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
          <QualificationNo>sample string 3</QualificationNo>
          <QualificationTypeId>4</QualificationTypeId>
        </ApplicationEngineerQualificationDto>
      </AdditionalQualifications>
      <ApplicationEngineerId>e4e32f71-1c71-4100-9b46-bfd7ed1d2caf</ApplicationEngineerId>
      <ApplicationId>b41a4d51-f42c-4aeb-8a21-63bffe52eb77</ApplicationId>
      <DateAwarded>2025-05-01T08:04:25.4423891+00:00</DateAwarded>
      <DateOfBirth>2025-05-01T08:04:25.4423891+00:00</DateOfBirth>
      <EliteQualificationTypeId>1</EliteQualificationTypeId>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <NINo>sample string 5</NINo>
      <QualificationNo>sample string 6</QualificationNo>
      <QualificationRegistration>sample string 8</QualificationRegistration>
      <QualificationTypeId>1</QualificationTypeId>
      <Skillcard>sample string 10</Skillcard>
    </ApplicationEngineerDto>
  </ApplicationEngineers>
  <ApplicationId>767e2b9e-a8f7-4c0b-ac65-e224f2fdcbdc</ApplicationId>
  <BillingAddress1>sample string 45</BillingAddress1>
  <BillingAddress2>sample string 46</BillingAddress2>
  <BillingAddress3>sample string 47</BillingAddress3>
  <BillingCounty>sample string 49</BillingCounty>
  <BillingEmail>sample string 51</BillingEmail>
  <BillingFirstName>sample string 43</BillingFirstName>
  <BillingLastName>sample string 44</BillingLastName>
  <BillingPhone>sample string 52</BillingPhone>
  <BillingPostcode>sample string 50</BillingPostcode>
  <BillingTown>sample string 48</BillingTown>
  <CertificatedEngineers>1</CertificatedEngineers>
  <CertificationBody>sample string 20</CertificationBody>
  <ChequeAmount>1</ChequeAmount>
  <ChequeDate>2025-05-01T08:04:25.4266904+00:00</ChequeDate>
  <ChequeReference>sample string 53</ChequeReference>
  <CommissioningPercentage>1</CommissioningPercentage>
  <CompanyId>9ab4325d-4b1b-41f1-8c40-f08c8c657a73</CompanyId>
  <CompanyName>sample string 4</CompanyName>
  <CompanyNatureId>1</CompanyNatureId>
  <CompanySizeId>1</CompanySizeId>
  <CompanyTypeId>1</CompanyTypeId>
  <Country>sample string 10</Country>
  <County>sample string 9</County>
  <CreatedDate>2025-05-01T08:04:25.4266904+00:00</CreatedDate>
  <DateEstablished>2025-05-01T08:04:25.4266904+00:00</DateEstablished>
  <DeclarationDate>2025-05-01T08:04:25.4266904+00:00</DeclarationDate>
  <DeclarationName>sample string 32</DeclarationName>
  <DeclarationPosition>sample string 33</DeclarationPosition>
  <DecommissioningPercentage>1</DecommissioningPercentage>
  <EliteMembershipNo>sample string 19</EliteMembershipNo>
  <EmailAddress>sample string 13</EmailAddress>
  <Engineers>1</Engineers>
  <FGasMembershipNo>sample string 21</FGasMembershipNo>
  <FaxNo>sample string 15</FaxNo>
  <HVNo>sample string 17</HVNo>
  <HasHandlingProcedures>true</HasHandlingProcedures>
  <HasWeighingFacilities>true</HasWeighingFacilities>
  <InscopeTurnover>1</InscopeTurnover>
  <InstallationPercentage>1</InstallationPercentage>
  <IsBesaMember>true</IsBesaMember>
  <IsEliteMember>true</IsEliteMember>
  <LastUpdatedDate>2025-05-01T08:04:25.4266904+00:00</LastUpdatedDate>
  <MembershipEndDate>2025-05-01T08:04:25.4266904+00:00</MembershipEndDate>
  <MembershipStartDate>2025-05-01T08:04:25.4266904+00:00</MembershipStartDate>
  <NoOfSystems>1</NoOfSystems>
  <OptOutMarketing>true</OptOutMarketing>
  <OptOutSearch>true</OptOutSearch>
  <OtherPercentage>1</OtherPercentage>
  <PaymentStatusId>1</PaymentStatusId>
  <Postcode>sample string 11</Postcode>
  <PrincipalEmail>sample string 37</PrincipalEmail>
  <PrincipalFirstName>sample string 34</PrincipalFirstName>
  <PrincipalLastName>sample string 35</PrincipalLastName>
  <PrincipalPosition>sample string 36</PrincipalPosition>
  <PrincipalTelephoneNo>sample string 38</PrincipalTelephoneNo>
  <RecoveryNotes>sample string 28</RecoveryNotes>
  <RegistrationNo>sample string 22</RegistrationNo>
  <Scheme>sample string 2</Scheme>
  <SchemeEmail>sample string 41</SchemeEmail>
  <SchemeFirstName>sample string 39</SchemeFirstName>
  <SchemeLastName>sample string 40</SchemeLastName>
  <SchemeTelephoneNo>sample string 42</SchemeTelephoneNo>
  <ServicingPercentage>1</ServicingPercentage>
  <Simulated>true</Simulated>
  <StepsCompleted>1</StepsCompleted>
  <SubContractorCompanies>1</SubContractorCompanies>
  <Submitted>true</Submitted>
  <TelephoneNo>sample string 14</TelephoneNo>
  <Town>sample string 8</Town>
  <UserId>sample string 3</UserId>
  <VatNumber>sample string 23</VatNumber>
  <WasteCarrierExpiryDate>2025-05-01T08:04:25.4266904+00:00</WasteCarrierExpiryDate>
  <WasteCarrierIssuedBy>sample string 27</WasteCarrierIssuedBy>
  <WasteCarrierRegNo>sample string 26</WasteCarrierRegNo>
  <Website>sample string 12</Website>
  <WeighingNotes>sample string 29</WeighingNotes>
</ApplicationDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>