HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /xml/reply/DealGet HTTP/1.1
Host: partnerhub.pbsdealers.com
Content-Type: application/xml
Content-Length: length
<DealGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
<BuyerRef>00000000-0000-0000-0000-000000000000</BuyerRef>
<ContractSince>0001-01-01T00:00:00</ContractSince>
<ContractUntil>0001-01-01T00:00:00</ContractUntil>
<DealId>00000000-0000-0000-0000-000000000000</DealId>
<DealKey>String</DealKey>
<DealType>String</DealType>
<DeliverySince>0001-01-01T00:00:00</DeliverySince>
<DeliveryUntil>0001-01-01T00:00:00</DeliveryUntil>
<LastUpdateSince>0001-01-01T00:00:00</LastUpdateSince>
<LastUpdateUntil>0001-01-01T00:00:00</LastUpdateUntil>
<LeadRef>String</LeadRef>
<ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
<ModifiedUntil>0001-01-01T00:00:00</ModifiedUntil>
<SaleType>String</SaleType>
<SerialNumber>String</SerialNumber>
<SoldSince>0001-01-01T00:00:00</SoldSince>
<SoldUntil>0001-01-01T00:00:00</SoldUntil>
<Status>String</Status>
<SystemDeliverySince>0001-01-01T00:00:00</SystemDeliverySince>
<SystemDeliveryUntil>0001-01-01T00:00:00</SystemDeliveryUntil>
</DealGet>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DealGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
<Deals>
<Deal>
<APR>0</APR>
<Accessories>
<DealAccessory>
<Capitalized>false</Capitalized>
<Code>String</Code>
<Cost>0</Cost>
<Description>String</Description>
<GrossType>0</GrossType>
<MaxResidual>0</MaxResidual>
<Price>0</Price>
<Residual>0</Residual>
</DealAccessory>
</Accessories>
<Adjustments>
<DealVehicleAdjustment>
<AdjustmentType>Price</AdjustmentType>
<Amount>0</Amount>
<Capitalized>0</Capitalized>
<Description>String</Description>
<Upfront>0</Upfront>
</DealVehicleAdjustment>
</Adjustments>
<Allowances>
<DealAllowance>
<Amount>0</Amount>
<CapitalizedAmount>0</CapitalizedAmount>
<CertificateNumber>String</CertificateNumber>
<Code>String</Code>
<Description>String</Description>
<UpfrontAmount>0</UpfrontAmount>
</DealAllowance>
</Allowances>
<AmortizationTerm>0</AmortizationTerm>
<BackEndAllowances>
<DealAllowance>
<Amount>0</Amount>
<CapitalizedAmount>0</CapitalizedAmount>
<CertificateNumber>String</CertificateNumber>
<Code>String</Code>
<Description>String</Description>
<UpfrontAmount>0</UpfrontAmount>
</DealAllowance>
</BackEndAllowances>
<BuyerRef>00000000-0000-0000-0000-000000000000</BuyerRef>
<CashInfo>
<Deposit>0</Deposit>
<DueOnDelivery>0</DueOnDelivery>
<MSRP>0</MSRP>
<Taxes>
<DealTax>
<Amount>0</Amount>
<Name>String</Name>
<Rate>0</Rate>
</DealTax>
</Taxes>
</CashInfo>
<CashOnDelivery>0</CashOnDelivery>
<CoBuyerRefs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
</CoBuyerRefs>
<Conditions>String</Conditions>
<ContractDate>0001-01-01T00:00:00</ContractDate>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<DealActivityInfo>
<DealActivity>
<ActionedDate>0001-01-01T00:00:00</ActionedDate>
<ActivityCategory>Phone</ActivityCategory>
<ActivityName>String</ActivityName>
<ActivityRef>00000000-0000-0000-0000-000000000000</ActivityRef>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<EngagementDate>0001-01-01T00:00:00</EngagementDate>
<GreeterName>String</GreeterName>
<GreeterRef>00000000-0000-0000-0000-000000000000</GreeterRef>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsDeleted>false</IsDeleted>
<ManagerName>String</ManagerName>
<ManagerRef>00000000-0000-0000-0000-000000000000</ManagerRef>
<Notes>String</Notes>
<ResultName>String</ResultName>
<ResultRef>00000000-0000-0000-0000-000000000000</ResultRef>
<SalesRepName>String</SalesRepName>
<SalesRepRef>00000000-0000-0000-0000-000000000000</SalesRepRef>
<SalesSteps>
<DealSalesStep>
<SalesStepName>String</SalesStepName>
<SalesStepOrder>0</SalesStepOrder>
<SalesStepRef>0</SalesStepRef>
</DealSalesStep>
</SalesSteps>
</DealActivity>
</DealActivityInfo>
<DealCommissions>0</DealCommissions>
<DealId>00000000-0000-0000-0000-000000000000</DealId>
<DealInterestType>String</DealInterestType>
<DealKey>String</DealKey>
<DealTags>
<DealTagInfo>
<KeyName>String</KeyName>
<KeyValue>String</KeyValue>
</DealTagInfo>
</DealTags>
<DealType>String</DealType>
<DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
<DeliveryStepsCompleted xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</DeliveryStepsCompleted>
<Fees>
<DealFee>
<Amount>0</Amount>
<Capitalized>false</Capitalized>
<Cost>0</Cost>
<GrossType>String</GrossType>
<Name>String</Name>
<OEMType>String</OEMType>
</DealFee>
</Fees>
<FinanceInfo>
<APR>0</APR>
<AmortizationTerm>0</AmortizationTerm>
<BalanceToFinance>0</BalanceToFinance>
<Balloon>0</Balloon>
<Bank>String</Bank>
<BankInfo>
<Address>String</Address>
<BankNumber>String</BankNumber>
<City>String</City>
<Code>String</Code>
<Fax>String</Fax>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<ZipCode>String</ZipCode>
</BankInfo>
<CashOnDelivery>0</CashOnDelivery>
<Deposit>0</Deposit>
<EffectiveRate>0</EffectiveRate>
<FinanceCharges>0</FinanceCharges>
<MSRP>0</MSRP>
<Payment>0</Payment>
<PaymentBase>0</PaymentBase>
<PaymentTaxes>
<DealTax>
<Amount>0</Amount>
<Name>String</Name>
<Rate>0</Rate>
</DealTax>
</PaymentTaxes>
<PaymentTerm>0</PaymentTerm>
<PaymentTermMonths>0</PaymentTermMonths>
<PaymentsPerYear>0</PaymentsPerYear>
<Rate>0</Rate>
<Term>0</Term>
<TotalBalanceDue>0</TotalBalanceDue>
</FinanceInfo>
<Gross>
<AccessoryGross>0</AccessoryGross>
<DealGross>0</DealGross>
<FinanceGross>0</FinanceGross>
<Incentives>0</Incentives>
<Reserve>
<Amount>0</Amount>
<BaseRate>0</BaseRate>
<Factor>0</Factor>
<MidRate>0</MidRate>
</Reserve>
<VehicleGross>0</VehicleGross>
</Gross>
<Insurance>
<DealInsurance>
<Code>String</Code>
<Cost>0</Cost>
<Coverage>String</Coverage>
<Description>String</Description>
<NumberOfPayments>0</NumberOfPayments>
<PolicyNumber>String</PolicyNumber>
<Premium>0</Premium>
<Provider>String</Provider>
<RetroDays>String</RetroDays>
</DealInsurance>
</Insurance>
<LastUpdate>0001-01-01T00:00:00</LastUpdate>
<LeadRef>String</LeadRef>
<LeadSource>String</LeadSource>
<LeadType>String</LeadType>
<LeaseInfo>
<APR>0</APR>
<AmortizationTerm>0</AmortizationTerm>
<Bank>String</Bank>
<BankInfo>
<Address>String</Address>
<BankNumber>String</BankNumber>
<City>String</City>
<Code>String</Code>
<Fax>String</Fax>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<ZipCode>String</ZipCode>
</BankInfo>
<CapCost>0</CapCost>
<CapReduction>0</CapReduction>
<CapSettings>
<DealLeaseCapTaxSetting>
<CodCapitalized>false</CodCapitalized>
<LeaseCapitalized>false</LeaseCapitalized>
<Name>String</Name>
<Rate>0</Rate>
<RebateCapitalized>false</RebateCapitalized>
<TradeCapitalized>false</TradeCapitalized>
</DealLeaseCapTaxSetting>
</CapSettings>
<CapTaxes>
<DealTax>
<Amount>0</Amount>
<Name>String</Name>
<Rate>0</Rate>
</DealTax>
</CapTaxes>
<CashOnDelivery>0</CashOnDelivery>
<Depreciation>0</Depreciation>
<DriveOffLease>0</DriveOffLease>
<EffectiveRate>0</EffectiveRate>
<ExcessMileageRate>0</ExcessMileageRate>
<InceptionMileageIncluded>false</InceptionMileageIncluded>
<InceptionMileageRate>0</InceptionMileageRate>
<InceptionMilesAllowed>0</InceptionMilesAllowed>
<LeaseCalculationModel>String</LeaseCalculationModel>
<MSRP>0</MSRP>
<MileageAllowed>0</MileageAllowed>
<MileageCategory>String</MileageCategory>
<MileageCharges>0</MileageCharges>
<MileageExpected>0</MileageExpected>
<MileageRate>0</MileageRate>
<NetLease>0</NetLease>
<PayableOnDelivery>0</PayableOnDelivery>
<Payment>0</Payment>
<PaymentBase>0</PaymentBase>
<PaymentTaxes>
<DealTax>
<Amount>0</Amount>
<Name>String</Name>
<Rate>0</Rate>
</DealTax>
</PaymentTaxes>
<PaymentTerm>0</PaymentTerm>
<PaymentTermMonths>0</PaymentTermMonths>
<PaymentsPerYear>0</PaymentsPerYear>
<Rate>0</Rate>
<ResidualAdjustment>0</ResidualAdjustment>
<ResidualAmount>0</ResidualAmount>
<ResidualNet>0</ResidualNet>
<ResidualPercent>0</ResidualPercent>
<SecurityDeposit>0</SecurityDeposit>
<Term>0</Term>
<UpfrontTaxes>
<DealTax>
<Amount>0</Amount>
<Name>String</Name>
<Rate>0</Rate>
</DealTax>
</UpfrontTaxes>
</LeaseInfo>
<Notes>String</Notes>
<PaymentDate>0001-01-01T00:00:00</PaymentDate>
<PaymentTerm>0</PaymentTerm>
<PaymentTermMonths>0</PaymentTermMonths>
<PaymentsPerYear>0</PaymentsPerYear>
<Price>0</Price>
<ProspectRef>00000000-0000-0000-0000-000000000000</ProspectRef>
<ProspectType>String</ProspectType>
<Protections>
<DealProtection>
<Capitalized>false</Capitalized>
<Cost>0</Cost>
<Name>String</Name>
<OEMProductType>String</OEMProductType>
<OEMType>String</OEMType>
<Price>0</Price>
<Provider>String</Provider>
<Residual>0</Residual>
<TermMonths>0</TermMonths>
</DealProtection>
</Protections>
<Rebates>
<DealRebate>
<Amount>0</Amount>
<CapitalizedAmount>0</CapitalizedAmount>
<CertificateNumber>String</CertificateNumber>
<Code>String</Code>
<Description>String</Description>
<UpFrontAmount>0</UpFrontAmount>
</DealRebate>
</Rebates>
<SaleType>String</SaleType>
<SerialNumber>String</SerialNumber>
<SoldDate>0001-01-01T00:00:00</SoldDate>
<Status>String</Status>
<StatusInfo>
<DealStatus>
<EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
<IsSelected>false</IsSelected>
<StatusName>String</StatusName>
<StatusRef>0</StatusRef>
<StatusSystemType>String</StatusSystemType>
<UserName>String</UserName>
<UserRef>00000000-0000-0000-0000-000000000000</UserRef>
</DealStatus>
</StatusInfo>
<SystemDeliveryDate>0001-01-01T00:00:00</SystemDeliveryDate>
<SystemStatus>String</SystemStatus>
<TaxCode>String</TaxCode>
<Trades>
<DealTrade>
<ActualCashValue>0</ActualCashValue>
<Allowance>0</Allowance>
<Capitalized>0</Capitalized>
<HasMaxTradeCredit>false</HasMaxTradeCredit>
<Lien>0</Lien>
<LienHolder>
<Address>String</Address>
<City>String</City>
<Name>String</Name>
<Phone>String</Phone>
<Postal>String</Postal>
<Province>String</Province>
</LienHolder>
<Odometer>0</Odometer>
<OwnershipType>String</OwnershipType>
<Upfront>0</Upfront>
<VIN>String</VIN>
<VehicleRef>00000000-0000-0000-0000-000000000000</VehicleRef>
</DealTrade>
</Trades>
<UserRoles>
<DealUserRole>
<EmployeeRef>00000000-0000-0000-0000-000000000000</EmployeeRef>
<Name>String</Name>
<Primary>false</Primary>
<Role>String</Role>
</DealUserRole>
</UserRoles>
<VehicleInsurance>
<Address>String</Address>
<Agent>String</Agent>
<City>String</City>
<Collision>0</Collision>
<Comprehensive>0</Comprehensive>
<Fax>String</Fax>
<InsuranceCompany>String</InsuranceCompany>
<Liability>0</Liability>
<Phone>String</Phone>
<PolicyEffective>String</PolicyEffective>
<PolicyExpiry>String</PolicyExpiry>
<PolicyNumber>String</PolicyNumber>
<PostalCode>String</PostalCode>
<Province>String</Province>
<SaleNumber>String</SaleNumber>
</VehicleInsurance>
<Vehicles>
<DealVehicle>
<Cost>0</Cost>
<IsNewVehicle>false</IsNewVehicle>
<SaleOdometer>0</SaleOdometer>
<StockNumber>String</StockNumber>
<VIN>String</VIN>
<VehicleRef>00000000-0000-0000-0000-000000000000</VehicleRef>
</DealVehicle>
</Vehicles>
<Warranties>
<DealWarranty>
<Code>String</Code>
<CompanyName>String</CompanyName>
<Cost>0</Cost>
<CoveragePlan>String</CoveragePlan>
<Date>0001-01-01T00:00:00</Date>
<Deductible>0</Deductible>
<Description>String</Description>
<Expiry>0001-01-01T00:00:00</Expiry>
<Mileage>0</Mileage>
<OEMProductType>String</OEMProductType>
<OEMType>String</OEMType>
<PolicyNumber>String</PolicyNumber>
<Price>0</Price>
<Residual>0</Residual>
<Term>0</Term>
<Type>String</Type>
</DealWarranty>
</Warranties>
</Deal>
</Deals>
</DealGetResponse>