BrightofficeAPI
Click here for a complete list of operations.
CreateCaseJSON
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateCaseJSON"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateCaseJSON xmlns="http://tempuri.org/">
<CaseType>string</CaseType>
<CaseParams>
<Params>
<CustomerCode>string</CustomerCode>
<SelectApplicantNumberFromCustomer>string</SelectApplicantNumberFromCustomer>
<MatterType>string</MatterType>
<Provider>string</Provider>
<ProviderProduct>string</ProviderProduct>
<ProductCode>string</ProductCode>
<ProviderRef>string</ProviderRef>
<LoanType>string</LoanType>
<TotalLoan>double</TotalLoan>
<Term>double</Term>
<TermPeriod>string</TermPeriod>
<InterestMonthly>double</InterestMonthly>
<InterestYearly>double</InterestYearly>
<AgreementStartDate>string</AgreementStartDate>
<Source>string</Source>
<SourceEmail>string</SourceEmail>
<IsSourceNeedToCreate>boolean</IsSourceNeedToCreate>
<SourceRef>string</SourceRef>
<MoneyFor>string</MoneyFor>
<SourceAffiliate>string</SourceAffiliate>
<ExitFee>double</ExitFee>
<ExitFeePerc>double</ExitFeePerc>
<InitialFee>double</InitialFee>
<InitialFeePerc>double</InitialFeePerc>
<AddFeesToTotal>boolean</AddFeesToTotal>
<SourceInitialFeePerc>double</SourceInitialFeePerc>
<SourceInitialFee>double</SourceInitialFee>
<SourceCommissionPerc>double</SourceCommissionPerc>
<AffiliateInitialFeePerc>double</AffiliateInitialFeePerc>
<AffiliateInitialFee>double</AffiliateInitialFee>
<CaseStatus>string</CaseStatus>
<UnderWriter>string</UnderWriter>
<Team>string</Team>
<Processor>string</Processor>
<UserID>string</UserID>
<AdditionalUser1>string</AdditionalUser1>
<AdditionalUser2>string</AdditionalUser2>
<CaseAssignmentBranch>string</CaseAssignmentBranch>
<CurrentAddressYears>int</CurrentAddressYears>
<CurrentAddressMonths>int</CurrentAddressMonths>
<NumberOfDependants>string</NumberOfDependants>
<LoanPurpose>string</LoanPurpose>
<MaritalStatus>string</MaritalStatus>
<Sex>string</Sex>
<OccupancyStatus>string</OccupancyStatus>
<App1PreviousAddress>
<AddressDetails xsi:nil="true" />
<AddressDetails xsi:nil="true" />
</App1PreviousAddress>
<vehiclefinance>
<Mileage>string</Mileage>
<VRM>string</VRM>
<Valuation>string</Valuation>
<VIN>string</VIN>
<Make>string</Make>
<Model>string</Model>
<EngineSize>string</EngineSize>
<Colour>string</Colour>
<FuelType>string</FuelType>
<Body>string</Body>
<EngineNumber>string</EngineNumber>
<Transmission>string</Transmission>
<C02Rating>string</C02Rating>
<Manufactured>string</Manufactured>
<TotalPreviousKeepers>string</TotalPreviousKeepers>
<DateFirstRegistered>string</DateFirstRegistered>
<DateCurrentKeeperStart>string</DateCurrentKeeperStart>
<Condition>string</Condition>
<DateofLastMOT>string</DateofLastMOT>
<MileageatLastMOT>string</MileageatLastMOT>
<CommentsonLatestMOT>string</CommentsonLatestMOT>
<Stolen>string</Stolen>
<FinanceOutstanding>string</FinanceOutstanding>
<InsuranceWriteOffDamages>string</InsuranceWriteOffDamages>
<InsuranceWriteOffTheft>string</InsuranceWriteOffTheft>
<Thefts>string</Thefts>
<SecurityWatch>string</SecurityWatch>
<PlateTransfers>string</PlateTransfers>
</vehiclefinance>
<PaymentPlanDetail>
<TotalLoan>double</TotalLoan>
<LoanTerm>int</LoanTerm>
<LoanType>string</LoanType>
<Rate>double</Rate>
<Repayment>double</Repayment>
<FirstPaymentDate>dateTime</FirstPaymentDate>
<LoanAgreementDate>dateTime</LoanAgreementDate>
<PaymentPlanDetails xsi:nil="true" />
</PaymentPlanDetail>
<App1EmploymentDetails>
<OccupationType>string</OccupationType>
<EmploymentStatus>string</EmploymentStatus>
<EmployerName>string</EmployerName>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Postcode>string</Postcode>
<EmployerTelephone>string</EmployerTelephone>
<TimeInYears>int</TimeInYears>
<TimeInMonths>int</TimeInMonths>
<FirstIncome>double</FirstIncome>
<SecondIncome>double</SecondIncome>
<OtherIncomeDescription>string</OtherIncomeDescription>
<PartTimeHoursWorked>string</PartTimeHoursWorked>
</App1EmploymentDetails>
<App1PreviousEmploymentDetails>
<EmploymentDetails xsi:nil="true" />
<EmploymentDetails xsi:nil="true" />
</App1PreviousEmploymentDetails>
<CustomerDetails>
<CustomerCode>string</CustomerCode>
<B2B>boolean</B2B>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<HouseName>string</HouseName>
<HouseNumber>string</HouseNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Address5>string</Address5>
<Postcode>string</Postcode>
<CountryCode>string</CountryCode>
<Currency>string</Currency>
<Website>string</Website>
<CustomerGroup>string</CustomerGroup>
<CompanyName>string</CompanyName>
<CompanyAddress xsi:nil="true" />
<Source>string</Source>
<SourceEmail>string</SourceEmail>
<IsSourceNeedToCreate>boolean</IsSourceNeedToCreate>
<Telephone>string</Telephone>
<Mobile>string</Mobile>
<DateofBirth>string</DateofBirth>
<Company>string</Company>
<Email>string</Email>
<LoanAmount>string</LoanAmount>
<ContactMethod xsi:nil="true" />
<OtherName>string</OtherName>
<PreviousName>string</PreviousName>
<ClientStatus>string</ClientStatus>
<Notes>string</Notes>
<Applicants xsi:nil="true" />
<BankDetail xsi:nil="true" />
<PreviousAddress xsi:nil="true" />
<SourceAddress xsi:nil="true" />
<IsDeduplicationReq>boolean</IsDeduplicationReq>
<DeduplicationCheckReq>boolean</DeduplicationCheckReq>
<NINumber>string</NINumber>
<StaffCode>string</StaffCode>
<AlternativeSalutation>string</AlternativeSalutation>
<PassportNumber>string</PassportNumber>
<MultiContacts xsi:nil="true" />
<CustomFields xsi:nil="true" />
<IsUpdateCustomerDetail>boolean</IsUpdateCustomerDetail>
</CustomerDetails>
<CaseProducts>
<CaseProduct xsi:nil="true" />
<CaseProduct xsi:nil="true" />
</CaseProducts>
<MonthlyIncome>
<MonthlyIncomeExpence xsi:nil="true" />
<MonthlyIncomeExpence xsi:nil="true" />
</MonthlyIncome>
<MonthlyExpence>
<MonthlyIncomeExpence xsi:nil="true" />
<MonthlyIncomeExpence xsi:nil="true" />
</MonthlyExpence>
<SecurityAddress>
<SecurityAddressDetails xsi:nil="true" />
<SecurityAddressDetails xsi:nil="true" />
</SecurityAddress>
<EquipmentDetails>
<EquipmentDetails xsi:nil="true" />
<EquipmentDetails xsi:nil="true" />
</EquipmentDetails>
<OtherApplicantDetails>
<QuickCaseOtherApplicants xsi:nil="true" />
<QuickCaseOtherApplicants xsi:nil="true" />
</OtherApplicantDetails>
<DynamicFieldDetail>
<DynamicFieldDetails xsi:nil="true" />
<DynamicFieldDetails xsi:nil="true" />
</DynamicFieldDetail>
<ApplicationProgressDates>
<LasContactDate>string</LasContactDate>
<RegCopiesSent>string</RegCopiesSent>
<AppointmentDate>string</AppointmentDate>
<AppointmentTime>string</AppointmentTime>
<SentToProvider>string</SentToProvider>
<PaymentDate>string</PaymentDate>
<RegSignsDueOut>string</RegSignsDueOut>
<OfferReceived>string</OfferReceived>
<SoldDate>string</SoldDate>
<ExpiryDate>string</ExpiryDate>
<AppReceived>string</AppReceived>
<Completed>string</Completed>
<AppSent>string</AppSent>
<AgreementSent>string</AgreementSent>
<AgreementRec>string</AgreementRec>
<UndDate>string</UndDate>
<MortOfferSent>string</MortOfferSent>
<MortOfferRec>string</MortOfferRec>
<BSQOut>string</BSQOut>
<BSQIn>string</BSQIn>
<SurveyInst>string</SurveyInst>
<SurveyRec>string</SurveyRec>
<LandRegistry>string</LandRegistry>
<CreditSearch>string</CreditSearch>
</ApplicationProgressDates>
<SolicitorDetails>
<SolicitorDetails xsi:nil="true" />
<SolicitorDetails xsi:nil="true" />
</SolicitorDetails>
<SourceAddress>
<Id>int</Id>
<HouseName>string</HouseName>
<HouseNumber>string</HouseNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Address5>string</Address5>
<Postcode>string</Postcode>
<TimeInYears>int</TimeInYears>
<TimeInMonths>int</TimeInMonths>
</SourceAddress>
<CalculateFinancialField>boolean</CalculateFinancialField>
</Params>
</CaseParams>
<UserInfo>
<Username>string</Username>
<Password>string</Password>
</UserInfo>
</CreateCaseJSON>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateCaseJSONResponse xmlns="http://tempuri.org/">
<CreateCaseJSONResult>
<EnquiryResult>
<SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
<Message>string</Message>
<ExceptionMessage>string</ExceptionMessage>
<IsSystemError>boolean</IsSystemError>
</EnquiryResult>
<Value>string</Value>
<OtherValue>
<UpdateFieldValue>
<FieldName>string</FieldName>
<Value>string</Value>
</UpdateFieldValue>
<UpdateFieldValue>
<FieldName>string</FieldName>
<Value>string</Value>
</UpdateFieldValue>
</OtherValue>
</CreateCaseJSONResult>
</CreateCaseJSONResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateCaseJSON xmlns="http://tempuri.org/">
<CaseType>string</CaseType>
<CaseParams>
<Params>
<CustomerCode>string</CustomerCode>
<SelectApplicantNumberFromCustomer>string</SelectApplicantNumberFromCustomer>
<MatterType>string</MatterType>
<Provider>string</Provider>
<ProviderProduct>string</ProviderProduct>
<ProductCode>string</ProductCode>
<ProviderRef>string</ProviderRef>
<LoanType>string</LoanType>
<TotalLoan>double</TotalLoan>
<Term>double</Term>
<TermPeriod>string</TermPeriod>
<InterestMonthly>double</InterestMonthly>
<InterestYearly>double</InterestYearly>
<AgreementStartDate>string</AgreementStartDate>
<Source>string</Source>
<SourceEmail>string</SourceEmail>
<IsSourceNeedToCreate>boolean</IsSourceNeedToCreate>
<SourceRef>string</SourceRef>
<MoneyFor>string</MoneyFor>
<SourceAffiliate>string</SourceAffiliate>
<ExitFee>double</ExitFee>
<ExitFeePerc>double</ExitFeePerc>
<InitialFee>double</InitialFee>
<InitialFeePerc>double</InitialFeePerc>
<AddFeesToTotal>boolean</AddFeesToTotal>
<SourceInitialFeePerc>double</SourceInitialFeePerc>
<SourceInitialFee>double</SourceInitialFee>
<SourceCommissionPerc>double</SourceCommissionPerc>
<AffiliateInitialFeePerc>double</AffiliateInitialFeePerc>
<AffiliateInitialFee>double</AffiliateInitialFee>
<CaseStatus>string</CaseStatus>
<UnderWriter>string</UnderWriter>
<Team>string</Team>
<Processor>string</Processor>
<UserID>string</UserID>
<AdditionalUser1>string</AdditionalUser1>
<AdditionalUser2>string</AdditionalUser2>
<CaseAssignmentBranch>string</CaseAssignmentBranch>
<CurrentAddressYears>int</CurrentAddressYears>
<CurrentAddressMonths>int</CurrentAddressMonths>
<NumberOfDependants>string</NumberOfDependants>
<LoanPurpose>string</LoanPurpose>
<MaritalStatus>string</MaritalStatus>
<Sex>string</Sex>
<OccupancyStatus>string</OccupancyStatus>
<App1PreviousAddress>
<AddressDetails xsi:nil="true" />
<AddressDetails xsi:nil="true" />
</App1PreviousAddress>
<vehiclefinance>
<Mileage>string</Mileage>
<VRM>string</VRM>
<Valuation>string</Valuation>
<VIN>string</VIN>
<Make>string</Make>
<Model>string</Model>
<EngineSize>string</EngineSize>
<Colour>string</Colour>
<FuelType>string</FuelType>
<Body>string</Body>
<EngineNumber>string</EngineNumber>
<Transmission>string</Transmission>
<C02Rating>string</C02Rating>
<Manufactured>string</Manufactured>
<TotalPreviousKeepers>string</TotalPreviousKeepers>
<DateFirstRegistered>string</DateFirstRegistered>
<DateCurrentKeeperStart>string</DateCurrentKeeperStart>
<Condition>string</Condition>
<DateofLastMOT>string</DateofLastMOT>
<MileageatLastMOT>string</MileageatLastMOT>
<CommentsonLatestMOT>string</CommentsonLatestMOT>
<Stolen>string</Stolen>
<FinanceOutstanding>string</FinanceOutstanding>
<InsuranceWriteOffDamages>string</InsuranceWriteOffDamages>
<InsuranceWriteOffTheft>string</InsuranceWriteOffTheft>
<Thefts>string</Thefts>
<SecurityWatch>string</SecurityWatch>
<PlateTransfers>string</PlateTransfers>
</vehiclefinance>
<PaymentPlanDetail>
<TotalLoan>double</TotalLoan>
<LoanTerm>int</LoanTerm>
<LoanType>string</LoanType>
<Rate>double</Rate>
<Repayment>double</Repayment>
<FirstPaymentDate>dateTime</FirstPaymentDate>
<LoanAgreementDate>dateTime</LoanAgreementDate>
<PaymentPlanDetails xsi:nil="true" />
</PaymentPlanDetail>
<App1EmploymentDetails>
<OccupationType>string</OccupationType>
<EmploymentStatus>string</EmploymentStatus>
<EmployerName>string</EmployerName>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Postcode>string</Postcode>
<EmployerTelephone>string</EmployerTelephone>
<TimeInYears>int</TimeInYears>
<TimeInMonths>int</TimeInMonths>
<FirstIncome>double</FirstIncome>
<SecondIncome>double</SecondIncome>
<OtherIncomeDescription>string</OtherIncomeDescription>
<PartTimeHoursWorked>string</PartTimeHoursWorked>
</App1EmploymentDetails>
<App1PreviousEmploymentDetails>
<EmploymentDetails xsi:nil="true" />
<EmploymentDetails xsi:nil="true" />
</App1PreviousEmploymentDetails>
<CustomerDetails>
<CustomerCode>string</CustomerCode>
<B2B>boolean</B2B>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<HouseName>string</HouseName>
<HouseNumber>string</HouseNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Address5>string</Address5>
<Postcode>string</Postcode>
<CountryCode>string</CountryCode>
<Currency>string</Currency>
<Website>string</Website>
<CustomerGroup>string</CustomerGroup>
<CompanyName>string</CompanyName>
<CompanyAddress xsi:nil="true" />
<Source>string</Source>
<SourceEmail>string</SourceEmail>
<IsSourceNeedToCreate>boolean</IsSourceNeedToCreate>
<Telephone>string</Telephone>
<Mobile>string</Mobile>
<DateofBirth>string</DateofBirth>
<Company>string</Company>
<Email>string</Email>
<LoanAmount>string</LoanAmount>
<ContactMethod xsi:nil="true" />
<OtherName>string</OtherName>
<PreviousName>string</PreviousName>
<ClientStatus>string</ClientStatus>
<Notes>string</Notes>
<Applicants xsi:nil="true" />
<BankDetail xsi:nil="true" />
<PreviousAddress xsi:nil="true" />
<SourceAddress xsi:nil="true" />
<IsDeduplicationReq>boolean</IsDeduplicationReq>
<DeduplicationCheckReq>boolean</DeduplicationCheckReq>
<NINumber>string</NINumber>
<StaffCode>string</StaffCode>
<AlternativeSalutation>string</AlternativeSalutation>
<PassportNumber>string</PassportNumber>
<MultiContacts xsi:nil="true" />
<CustomFields xsi:nil="true" />
<IsUpdateCustomerDetail>boolean</IsUpdateCustomerDetail>
</CustomerDetails>
<CaseProducts>
<CaseProduct xsi:nil="true" />
<CaseProduct xsi:nil="true" />
</CaseProducts>
<MonthlyIncome>
<MonthlyIncomeExpence xsi:nil="true" />
<MonthlyIncomeExpence xsi:nil="true" />
</MonthlyIncome>
<MonthlyExpence>
<MonthlyIncomeExpence xsi:nil="true" />
<MonthlyIncomeExpence xsi:nil="true" />
</MonthlyExpence>
<SecurityAddress>
<SecurityAddressDetails xsi:nil="true" />
<SecurityAddressDetails xsi:nil="true" />
</SecurityAddress>
<EquipmentDetails>
<EquipmentDetails xsi:nil="true" />
<EquipmentDetails xsi:nil="true" />
</EquipmentDetails>
<OtherApplicantDetails>
<QuickCaseOtherApplicants xsi:nil="true" />
<QuickCaseOtherApplicants xsi:nil="true" />
</OtherApplicantDetails>
<DynamicFieldDetail>
<DynamicFieldDetails xsi:nil="true" />
<DynamicFieldDetails xsi:nil="true" />
</DynamicFieldDetail>
<ApplicationProgressDates>
<LasContactDate>string</LasContactDate>
<RegCopiesSent>string</RegCopiesSent>
<AppointmentDate>string</AppointmentDate>
<AppointmentTime>string</AppointmentTime>
<SentToProvider>string</SentToProvider>
<PaymentDate>string</PaymentDate>
<RegSignsDueOut>string</RegSignsDueOut>
<OfferReceived>string</OfferReceived>
<SoldDate>string</SoldDate>
<ExpiryDate>string</ExpiryDate>
<AppReceived>string</AppReceived>
<Completed>string</Completed>
<AppSent>string</AppSent>
<AgreementSent>string</AgreementSent>
<AgreementRec>string</AgreementRec>
<UndDate>string</UndDate>
<MortOfferSent>string</MortOfferSent>
<MortOfferRec>string</MortOfferRec>
<BSQOut>string</BSQOut>
<BSQIn>string</BSQIn>
<SurveyInst>string</SurveyInst>
<SurveyRec>string</SurveyRec>
<LandRegistry>string</LandRegistry>
<CreditSearch>string</CreditSearch>
</ApplicationProgressDates>
<SolicitorDetails>
<SolicitorDetails xsi:nil="true" />
<SolicitorDetails xsi:nil="true" />
</SolicitorDetails>
<SourceAddress>
<Id>int</Id>
<HouseName>string</HouseName>
<HouseNumber>string</HouseNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<Address4>string</Address4>
<Address5>string</Address5>
<Postcode>string</Postcode>
<TimeInYears>int</TimeInYears>
<TimeInMonths>int</TimeInMonths>
</SourceAddress>
<CalculateFinancialField>boolean</CalculateFinancialField>
</Params>
</CaseParams>
<UserInfo>
<Username>string</Username>
<Password>string</Password>
</UserInfo>
</CreateCaseJSON>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateCaseJSONResponse xmlns="http://tempuri.org/">
<CreateCaseJSONResult>
<EnquiryResult>
<SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
<Message>string</Message>
<ExceptionMessage>string</ExceptionMessage>
<IsSystemError>boolean</IsSystemError>
</EnquiryResult>
<Value>string</Value>
<OtherValue>
<UpdateFieldValue>
<FieldName>string</FieldName>
<Value>string</Value>
</UpdateFieldValue>
<UpdateFieldValue>
<FieldName>string</FieldName>
<Value>string</Value>
</UpdateFieldValue>
</OtherValue>
</CreateCaseJSONResult>
</CreateCaseJSONResponse>
</soap12:Body>
</soap12:Envelope>