Purpose: The purpose of the GetServiceOrder method is to allow a user to download the repair order as a fillable PDF.
Environment: This can be turned on directly by autoVHC, or via the integration settings on the site.
Method: GetServiceOrder
Sequence Diagram:
Request Structure:
Example Code: Click here to download
<?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>
<GetServiceOrderDocument xmlns="http://autovhc.co.uk/">
<Request>
<Locale>string</Locale>
<LocationCode>string</LocationCode>
<JobCardNumber>string</JobCardNumber>
</Request>
</GetServiceOrderDocument>
</soap:Body>
</soap:Envelope>
GetServiceOrderDocumentRequest | ||||
PropertyName | PropertyType | Example | Description | Mandatory |
Locale | String | en-GB | Culture code | Yes |
LocationCode | String | M1 | Used by some DMS require this to identify specific dealer data | Yes |
JobCardNumber | String | 11522565 | DMS Work order number | Yes |
Response Structure:
Example Code: Click here to download
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetServiceOrderDocumentResponse xmlns="http://autovhc.co.uk/">
<GetServiceOrderDocumentResult>
<Message>File retrieved Successfully</Message>
<Success>True</Success>
<ServiceOrderDocument>
<JobCardNumber>RO07987202</JobCardNumber>
<Document>JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADUpCi9Qcm9kdWNlciAo/v8AUQB0ACAANAAuADgALgA3KQovQ3JlYXRpb25EYXRlIChEOjIwMTkwNzI2MTA1MzA1KzAyJzAwJykKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovU0EgdHJ1ZQovU00gMC4wMgovY2EgMS4wCi9DQSAxLjAKL0FJUyBmYWxzZQovU01hc2sgL05vbmU+PgplbmRvYmoKNCAwIG9iagpbL1BhdHRlcm4gL0RldmljZVJHQl0KZW5kb2JqCjkgMCBvYmoKPDwKL1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDIgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9QYXJlbnQgMiAwIFIKL0NvbnRlbnRzIDEwIDAgUgovUmVzb3VyY2VzIDEyIDAgUgovQW5ub3RzIDEzIDAgUgovTWVkaWFCb3ggWzAgMCA1OTUgODQyXQo+PgplbmRvYmoKMTIgMCBvYmoKPDwKL0NvbG9yU3BhY2UgPDwKL1BDU3AgNCAwIFIKL0NTcCAvRGV2aWNlUkdCCi9DU3BnIC9EZXZpY2VHcmF5Cj4+Ci9FeHRHU3RhdGUgPDwKL0dTYSAzIDAgUgo+PgovUGF0dGVybiA8PAo+PgovRm9udCA8PAovRjYgNiAwIFIKL0Y3IDcgMCBSCi9GOCA4IDAgUgo+PgovWE9iamVjdCA8PAo+Pgo+PgplbmRvYmoKMTMgMCBvYmoKWyBdCmVuZG9iagoxMCAwIG9iago8PAovTGVuZ3RoIDExIDAgUgovRmlsdGVyIC9GbGF0ZURlY29kZQo+PgpzdHJlYW0KeJztXV2v3LYRfb+/Yp8L2BZJUZSAooB9YxfoQwHDBvpQ9KFImhZBEzTNQ/9+RVLScnkkce/1GZp20qBJrOyemSHn43BIal/98cPfL//85fLq8cN/Lt8u/3z88NC9dLaL/7v4v16kD/T4cvn3y6jM8u+Xb398+Pny88P7h/fz39d/+u/++OCUe+k/o+z8x3+nf1RdP7wcJjWN8/Mu/6P/8L8e/vK7y08z4KpiVOiXb396eBWVn/9b93LsOq2NNir+9+zPs279MF50N0u0en7w3388fD+r+ImYg55VHr1RmgkZ1FRNq+mMloAMlveWZrmAmlJ+5DHnv6vG/Yis5jrpApBsPyKrqcdLr9xF6Y6mperHi5kc09s9pFdzbFpJO8SxHHhjadTAVtNDsqdcQM3eiEByvUhCyb6P00NM7Haiq+kh2V4koKbjO6ZTbC+SUFKvXmRoagqUCg9p+NXHq9l89fGGkxHJZgvUs4Bp+DWSbLpUjWQ7u4Dpa5Fsvu5y40fCbIFKHjANnx2QTZdiB+z4ETDd8UNShnFw40fC7IXDOJ6rB0jDhZzokzOxJ2fslpHkkcEAaaiQAmTQQ1oBfmn4/JLPBq0EY2XzSzIXDJhWgF9yTRfjgmRnFzB9pW4CkGQ2SI0fCbMFuGDAtAL8kmu6GBckx4+A6Y4fkkJskBo/EmbrNX54HCZgWn7fjeyXHtIJ8CLL50V8FuMkmBabF5E5TMB0AryIa7oYhyE7u4DpK+UQgCSzGGr8SJgtwGECphPgRVzTxTgMOX4ETHf8kBRiMdT4kT</Document>
</ServiceOrderDocument>
</GetServiceOrderDocumentResult>
</GetServiceOrderDocumentResponse>
</soap:Body>
</soap:Envelope>
GetServiceOrderDocumentResponse | ||||
PropertyName | PropertyType | Example | Description | Mandatory |
Message | String | File retrieved succesfully | Success or Failure message | Yes |
Success | Boolean | True | True or False | Yes |
ServiceOrderDocument | (See Below) |
ServiceOrderDocument | ||||
PropertyName | PropertyType | Example | Description | Mandatory |
JobCardNumber | String | 11522565 | DMS Work order number | Yes |
Document | String | Please see above code | A version of the document in hexidecimal format | Yes |