BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

AddDelegateToTrainingCourse

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/AddDelegateToTrainingCourse"

<?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>
    <AddDelegateToTrainingCourse xmlns="http://tempuri.org/">
      <details>
        <Customer>
          <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>
            <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>
          </CompanyAddress>
          <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>
            <string>string</string>
            <string>string</string>
          </ContactMethod>
          <OtherName>string</OtherName>
          <PreviousName>string</PreviousName>
          <ClientStatus>string</ClientStatus>
          <Notes>string</Notes>
          <Applicants>
            <AdditionalApplicantDetails xsi:nil="true" />
            <AdditionalApplicantDetails xsi:nil="true" />
          </Applicants>
          <BankDetail>
            <CustomerBankDetails xsi:nil="true" />
            <CustomerBankDetails xsi:nil="true" />
          </BankDetail>
          <PreviousAddress>
            <AddressDetails xsi:nil="true" />
            <AddressDetails xsi:nil="true" />
          </PreviousAddress>
          <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>
          <IsDeduplicationReq>boolean</IsDeduplicationReq>
          <DeduplicationCheckReq>boolean</DeduplicationCheckReq>
          <NINumber>string</NINumber>
          <StaffCode>string</StaffCode>
          <AlternativeSalutation>string</AlternativeSalutation>
          <PassportNumber>string</PassportNumber>
          <MultiContacts>
            <MultiContact xsi:nil="true" />
            <MultiContact xsi:nil="true" />
          </MultiContacts>
          <CustomFields>
            <CustomFieldDetails xsi:nil="true" />
            <CustomFieldDetails xsi:nil="true" />
          </CustomFields>
          <IsUpdateCustomerDetail>boolean</IsUpdateCustomerDetail>
        </Customer>
        <LearnerDelegate>
          <DelegateCode>string</DelegateCode>
          <CustomerCode>string</CustomerCode>
          <Title>string</Title>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <DateofBirth>string</DateofBirth>
          <HouseNumber>string</HouseNumber>
          <HouseName>string</HouseName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <PostCode>string</PostCode>
          <Status>string</Status>
          <Notes>string</Notes>
          <Source>string</Source>
          <StaffName>string</StaffName>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <JobTitle>string</JobTitle>
          <JobType>string</JobType>
          <Course>
            <Code>string</Code>
            <CustomPrice>string</CustomPrice>
            <DelegateCourseStatus>string</DelegateCourseStatus>
            <Notes>string</Notes>
            <Price>double</Price>
            <VATCode>string</VATCode>
            <VATAmount>string</VATAmount>
            <DiscountAmount>double</DiscountAmount>
            <OrderNumber>string</OrderNumber>
            <PurchaseOrder>string</PurchaseOrder>
            <BookingReference>string</BookingReference>
            <DelegatePointsUsed>int</DelegatePointsUsed>
            <IsUsePoint>boolean</IsUsePoint>
            <ExtensionCost>double</ExtensionCost>
            <ExtensionVATCode>string</ExtensionVATCode>
            <CourseExpiryDate>dateTime</CourseExpiryDate>
          </Course>
          <DelegatePointsAvailable>int</DelegatePointsAvailable>
          <CustomField>
            <CustomFieldDetails xsi:nil="true" />
            <CustomFieldDetails xsi:nil="true" />
          </CustomField>
          <MoodleUserId>string</MoodleUserId>
          <MoodlePassword>string</MoodlePassword>
          <AssignAdditionalCustomer>boolean</AssignAdditionalCustomer>
        </LearnerDelegate>
      </details>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </AddDelegateToTrainingCourse>
  </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>
    <AddDelegateToTrainingCourseResponse xmlns="http://tempuri.org/">
      <AddDelegateToTrainingCourseResult>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
        <CustomerCode>string</CustomerCode>
        <DelegateCode>string</DelegateCode>
        <TrainingCourse>string</TrainingCourse>
        <TrainingCourseDelegateId>int</TrainingCourseDelegateId>
        <QualificationID>int</QualificationID>
      </AddDelegateToTrainingCourseResult>
    </AddDelegateToTrainingCourseResponse>
  </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>
    <AddDelegateToTrainingCourse xmlns="http://tempuri.org/">
      <details>
        <Customer>
          <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>
            <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>
          </CompanyAddress>
          <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>
            <string>string</string>
            <string>string</string>
          </ContactMethod>
          <OtherName>string</OtherName>
          <PreviousName>string</PreviousName>
          <ClientStatus>string</ClientStatus>
          <Notes>string</Notes>
          <Applicants>
            <AdditionalApplicantDetails xsi:nil="true" />
            <AdditionalApplicantDetails xsi:nil="true" />
          </Applicants>
          <BankDetail>
            <CustomerBankDetails xsi:nil="true" />
            <CustomerBankDetails xsi:nil="true" />
          </BankDetail>
          <PreviousAddress>
            <AddressDetails xsi:nil="true" />
            <AddressDetails xsi:nil="true" />
          </PreviousAddress>
          <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>
          <IsDeduplicationReq>boolean</IsDeduplicationReq>
          <DeduplicationCheckReq>boolean</DeduplicationCheckReq>
          <NINumber>string</NINumber>
          <StaffCode>string</StaffCode>
          <AlternativeSalutation>string</AlternativeSalutation>
          <PassportNumber>string</PassportNumber>
          <MultiContacts>
            <MultiContact xsi:nil="true" />
            <MultiContact xsi:nil="true" />
          </MultiContacts>
          <CustomFields>
            <CustomFieldDetails xsi:nil="true" />
            <CustomFieldDetails xsi:nil="true" />
          </CustomFields>
          <IsUpdateCustomerDetail>boolean</IsUpdateCustomerDetail>
        </Customer>
        <LearnerDelegate>
          <DelegateCode>string</DelegateCode>
          <CustomerCode>string</CustomerCode>
          <Title>string</Title>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <DateofBirth>string</DateofBirth>
          <HouseNumber>string</HouseNumber>
          <HouseName>string</HouseName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <PostCode>string</PostCode>
          <Status>string</Status>
          <Notes>string</Notes>
          <Source>string</Source>
          <StaffName>string</StaffName>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <JobTitle>string</JobTitle>
          <JobType>string</JobType>
          <Course>
            <Code>string</Code>
            <CustomPrice>string</CustomPrice>
            <DelegateCourseStatus>string</DelegateCourseStatus>
            <Notes>string</Notes>
            <Price>double</Price>
            <VATCode>string</VATCode>
            <VATAmount>string</VATAmount>
            <DiscountAmount>double</DiscountAmount>
            <OrderNumber>string</OrderNumber>
            <PurchaseOrder>string</PurchaseOrder>
            <BookingReference>string</BookingReference>
            <DelegatePointsUsed>int</DelegatePointsUsed>
            <IsUsePoint>boolean</IsUsePoint>
            <ExtensionCost>double</ExtensionCost>
            <ExtensionVATCode>string</ExtensionVATCode>
            <CourseExpiryDate>dateTime</CourseExpiryDate>
          </Course>
          <DelegatePointsAvailable>int</DelegatePointsAvailable>
          <CustomField>
            <CustomFieldDetails xsi:nil="true" />
            <CustomFieldDetails xsi:nil="true" />
          </CustomField>
          <MoodleUserId>string</MoodleUserId>
          <MoodlePassword>string</MoodlePassword>
          <AssignAdditionalCustomer>boolean</AssignAdditionalCustomer>
        </LearnerDelegate>
      </details>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </AddDelegateToTrainingCourse>
  </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>
    <AddDelegateToTrainingCourseResponse xmlns="http://tempuri.org/">
      <AddDelegateToTrainingCourseResult>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
        <CustomerCode>string</CustomerCode>
        <DelegateCode>string</DelegateCode>
        <TrainingCourse>string</TrainingCourse>
        <TrainingCourseDelegateId>int</TrainingCourseDelegateId>
        <QualificationID>int</QualificationID>
      </AddDelegateToTrainingCourseResult>
    </AddDelegateToTrainingCourseResponse>
  </soap12:Body>
</soap12:Envelope>