BrightofficeAPI

Click here for a complete list of operations.

UpdateDelegateDetails

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

<?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>
    <UpdateDelegateDetails xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <options>
        <Code>string</Code>
        <Title>string</Title>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Telephone>string</Telephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <WorkTelephone>string</WorkTelephone>
        <WorkEmail>string</WorkEmail>
        <DelegateConfirmationStatusCode>string</DelegateConfirmationStatusCode>
        <DelegateConfirmationStatusDescription>string</DelegateConfirmationStatusDescription>
        <PointsAvailable>int</PointsAvailable>
        <DelegateAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </DelegateAddress>
        <YearsAtAddress>string</YearsAtAddress>
        <Owner>string</Owner>
        <Source>string</Source>
        <JobType>string</JobType>
        <Nationality>string</Nationality>
        <Salutation>string</Salutation>
        <JobTitle>string</JobTitle>
        <OldReference>string</OldReference>
        <Status>string</Status>
        <NINumber>string</NINumber>
        <PayrollReference>string</PayrollReference>
        <DateofBirth>string</DateofBirth>
        <DelegateType>
          <string>string</string>
          <string>string</string>
        </DelegateType>
      </options>
    </UpdateDelegateDetails>
  </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>
    <UpdateDelegateDetailsResponse xmlns="http://tempuri.org/">
      <UpdateDelegateDetailsResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </UpdateDelegateDetailsResult>
    </UpdateDelegateDetailsResponse>
  </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>
    <UpdateDelegateDetails xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <options>
        <Code>string</Code>
        <Title>string</Title>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Telephone>string</Telephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <WorkTelephone>string</WorkTelephone>
        <WorkEmail>string</WorkEmail>
        <DelegateConfirmationStatusCode>string</DelegateConfirmationStatusCode>
        <DelegateConfirmationStatusDescription>string</DelegateConfirmationStatusDescription>
        <PointsAvailable>int</PointsAvailable>
        <DelegateAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </DelegateAddress>
        <YearsAtAddress>string</YearsAtAddress>
        <Owner>string</Owner>
        <Source>string</Source>
        <JobType>string</JobType>
        <Nationality>string</Nationality>
        <Salutation>string</Salutation>
        <JobTitle>string</JobTitle>
        <OldReference>string</OldReference>
        <Status>string</Status>
        <NINumber>string</NINumber>
        <PayrollReference>string</PayrollReference>
        <DateofBirth>string</DateofBirth>
        <DelegateType>
          <string>string</string>
          <string>string</string>
        </DelegateType>
      </options>
    </UpdateDelegateDetails>
  </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>
    <UpdateDelegateDetailsResponse xmlns="http://tempuri.org/">
      <UpdateDelegateDetailsResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </UpdateDelegateDetailsResult>
    </UpdateDelegateDetailsResponse>
  </soap12:Body>
</soap12:Envelope>