BrightDoor Web Services API
Click here for a complete list of operations.
AddTracking
Used for BrightDoor applications that use tracking data; NOT FOR 3RD PARTY DEVELOPER USE
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.
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 /brightbase/wsbrightdoor.asmx HTTP/1.1 Host: fullersothebys.brightdoor.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.brightdoor.com/webservices/AddTracking" <?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> <AddTracking xmlns="http://www.brightdoor.com/webservices/"> <clientID>string</clientID> <centerID>string</centerID> <username>string</username> <password>string</password> <DeviceName>string</DeviceName> <EventType>string</EventType> <Description>string</Description> <MessageBody>string</MessageBody> <OriginatorID>int</OriginatorID> <OriginatorType>string</OriginatorType> <ReferenceID>string</ReferenceID> </AddTracking> </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> <AddTrackingResponse xmlns="http://www.brightdoor.com/webservices/"> <AddTrackingResult>int</AddTrackingResult> </AddTrackingResponse> </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 /brightbase/wsbrightdoor.asmx HTTP/1.1 Host: fullersothebys.brightdoor.com 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> <AddTracking xmlns="http://www.brightdoor.com/webservices/"> <clientID>string</clientID> <centerID>string</centerID> <username>string</username> <password>string</password> <DeviceName>string</DeviceName> <EventType>string</EventType> <Description>string</Description> <MessageBody>string</MessageBody> <OriginatorID>int</OriginatorID> <OriginatorType>string</OriginatorType> <ReferenceID>string</ReferenceID> </AddTracking> </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> <AddTrackingResponse xmlns="http://www.brightdoor.com/webservices/"> <AddTrackingResult>int</AddTrackingResult> </AddTrackingResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /brightbase/wsbrightdoor.asmx/AddTracking?clientID=string¢erID=string&username=string&password=string&DeviceName=string&EventType=string&Description=string&MessageBody=string&OriginatorID=string&OriginatorType=string&ReferenceID=string HTTP/1.1 Host: fullersothebys.brightdoor.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <int xmlns="http://www.brightdoor.com/webservices/">int</int>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /brightbase/wsbrightdoor.asmx/AddTracking HTTP/1.1 Host: fullersothebys.brightdoor.com Content-Type: application/x-www-form-urlencoded Content-Length: length clientID=string¢erID=string&username=string&password=string&DeviceName=string&EventType=string&Description=string&MessageBody=string&OriginatorID=string&OriginatorType=string&ReferenceID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <int xmlns="http://www.brightdoor.com/webservices/">int</int>