RAndRWebService Web Service

RAndRWebService

Click here for a complete list of operations.

GetRecoveryJobDetails

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 /api/v1/randrwebservice.asmx HTTP/1.1
Host: rmspublictest.apex-rms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.apex-rms.com/V1/GetRecoveryJobDetails"

<?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>
    <GetRecoveryJobDetails xmlns="http://api.apex-rms.com/V1">
      <apiLogin>string</apiLogin>
      <apiPassword>string</apiPassword>
      <jobId>int</jobId>
    </GetRecoveryJobDetails>
  </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>
    <GetRecoveryJobDetailsResponse xmlns="http://api.apex-rms.com/V1">
      <GetRecoveryJobDetailsResult>
        <JobServices>
          <ServiceDetails>
            <ServiceDriverBuddyNo>string</ServiceDriverBuddyNo>
            <ServiceVehicleBuddyNo>string</ServiceVehicleBuddyNo>
            <SubContractor>string</SubContractor>
            <MainService>boolean</MainService>
            <IssuedDateTime>dateTime</IssuedDateTime>
            <OnSceneDateTime>dateTime</OnSceneDateTime>
            <ClearDateTime>dateTime</ClearDateTime>
            <CompleteDateTime>dateTime</CompleteDateTime>
            <ServiceDriverId>short</ServiceDriverId>
            <ServiceVehicleId>int</ServiceVehicleId>
            <ServiceVehicleClass>string</ServiceVehicleClass>
            <ServiceJobSendStatuts>Unsent or Sent or Retrying or Received or Accepted or Expired or TimedOut</ServiceJobSendStatuts>
          </ServiceDetails>
          <ServiceDetails>
            <ServiceDriverBuddyNo>string</ServiceDriverBuddyNo>
            <ServiceVehicleBuddyNo>string</ServiceVehicleBuddyNo>
            <SubContractor>string</SubContractor>
            <MainService>boolean</MainService>
            <IssuedDateTime>dateTime</IssuedDateTime>
            <OnSceneDateTime>dateTime</OnSceneDateTime>
            <ClearDateTime>dateTime</ClearDateTime>
            <CompleteDateTime>dateTime</CompleteDateTime>
            <ServiceDriverId>short</ServiceDriverId>
            <ServiceVehicleId>int</ServiceVehicleId>
            <ServiceVehicleClass>string</ServiceVehicleClass>
            <ServiceJobSendStatuts>Unsent or Sent or Retrying or Received or Accepted or Expired or TimedOut</ServiceJobSendStatuts>
          </ServiceDetails>
        </JobServices>
        <JobBookedBy>string</JobBookedBy>
        <JobOrderNo>string</JobOrderNo>
        <JobOrderNo2>string</JobOrderNo2>
        <JobSalesAccName>string</JobSalesAccName>
        <JobStatus>Unallocated or Allocated or Issued or At_Scene or Clear or Cleared_Down or Complete or Ready_To_Invoice or Invoiced or Cancelled</JobStatus>
        <Symptom>string</Symptom>
        <FaultCode>string</FaultCode>
        <JobDateTime>dateTime</JobDateTime>
        <ETA>dateTime</ETA>
        <JobLocationCode>string</JobLocationCode>
        <JobLocationDesc>string</JobLocationDesc>
        <JobDestinationGpsLat>double</JobDestinationGpsLat>
        <JobDestinationGpsLng>double</JobDestinationGpsLng>
        <JobDestinationCode>string</JobDestinationCode>
        <JobDestinationDesc>string</JobDestinationDesc>
        <JobRamNotes>string</JobRamNotes>
        <JobPlannedDriver>string</JobPlannedDriver>
        <JobOnHold>boolean</JobOnHold>
        <JobAuthCode>string</JobAuthCode>
        <JobPdaNotes>string</JobPdaNotes>
        <JobLocationGpsLat>double</JobLocationGpsLat>
        <JobLocationGpsLng>double</JobLocationGpsLng>
        <LastModifiedDateTime>dateTime</LastModifiedDateTime>
        <JobContractCode>string</JobContractCode>
        <JobEdiJobNo>string</JobEdiJobNo>
        <JobSiteCode>string</JobSiteCode>
        <JobVehicleClass>string</JobVehicleClass>
        <JobPriorityFlag>boolean</JobPriorityFlag>
        <JobPriorityReason>string</JobPriorityReason>
        <JobPriorityDetail>string</JobPriorityDetail>
        <JobInvoiceNotes>string</JobInvoiceNotes>
        <JobVehicleMakeModel>string</JobVehicleMakeModel>
        <JobVehicleMake>string</JobVehicleMake>
        <JobVehicleModel>string</JobVehicleModel>
        <JobVehicleRegistration>string</JobVehicleRegistration>
        <JobVehicleColour>string</JobVehicleColour>
        <JobVehicleFuelType>string</JobVehicleFuelType>
        <JobVehicleEngineDetails>string</JobVehicleEngineDetails>
        <JobVehicleWeight>string</JobVehicleWeight>
        <JobLength>string</JobLength>
        <JobTowingTrailer>boolean</JobTowingTrailer>
        <JobOwnerName>string</JobOwnerName>
        <JobOwnerCompany>string</JobOwnerCompany>
        <JobOwnerAddress>string</JobOwnerAddress>
        <JobOwnerMemberNo>string</JobOwnerMemberNo>
        <JobOwnerPhone>string</JobOwnerPhone>
        <JobOwnerEmail>string</JobOwnerEmail>
        <JobPassengerAdult>unsignedByte</JobPassengerAdult>
        <JobPassengerChild>unsignedByte</JobPassengerChild>
        <JobVehicleFleetNo>string</JobVehicleFleetNo>
        <JobVehicleVin>string</JobVehicleVin>
      </GetRecoveryJobDetailsResult>
    </GetRecoveryJobDetailsResponse>
  </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 /api/v1/randrwebservice.asmx HTTP/1.1
Host: rmspublictest.apex-rms.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>
    <GetRecoveryJobDetails xmlns="http://api.apex-rms.com/V1">
      <apiLogin>string</apiLogin>
      <apiPassword>string</apiPassword>
      <jobId>int</jobId>
    </GetRecoveryJobDetails>
  </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>
    <GetRecoveryJobDetailsResponse xmlns="http://api.apex-rms.com/V1">
      <GetRecoveryJobDetailsResult>
        <JobServices>
          <ServiceDetails>
            <ServiceDriverBuddyNo>string</ServiceDriverBuddyNo>
            <ServiceVehicleBuddyNo>string</ServiceVehicleBuddyNo>
            <SubContractor>string</SubContractor>
            <MainService>boolean</MainService>
            <IssuedDateTime>dateTime</IssuedDateTime>
            <OnSceneDateTime>dateTime</OnSceneDateTime>
            <ClearDateTime>dateTime</ClearDateTime>
            <CompleteDateTime>dateTime</CompleteDateTime>
            <ServiceDriverId>short</ServiceDriverId>
            <ServiceVehicleId>int</ServiceVehicleId>
            <ServiceVehicleClass>string</ServiceVehicleClass>
            <ServiceJobSendStatuts>Unsent or Sent or Retrying or Received or Accepted or Expired or TimedOut</ServiceJobSendStatuts>
          </ServiceDetails>
          <ServiceDetails>
            <ServiceDriverBuddyNo>string</ServiceDriverBuddyNo>
            <ServiceVehicleBuddyNo>string</ServiceVehicleBuddyNo>
            <SubContractor>string</SubContractor>
            <MainService>boolean</MainService>
            <IssuedDateTime>dateTime</IssuedDateTime>
            <OnSceneDateTime>dateTime</OnSceneDateTime>
            <ClearDateTime>dateTime</ClearDateTime>
            <CompleteDateTime>dateTime</CompleteDateTime>
            <ServiceDriverId>short</ServiceDriverId>
            <ServiceVehicleId>int</ServiceVehicleId>
            <ServiceVehicleClass>string</ServiceVehicleClass>
            <ServiceJobSendStatuts>Unsent or Sent or Retrying or Received or Accepted or Expired or TimedOut</ServiceJobSendStatuts>
          </ServiceDetails>
        </JobServices>
        <JobBookedBy>string</JobBookedBy>
        <JobOrderNo>string</JobOrderNo>
        <JobOrderNo2>string</JobOrderNo2>
        <JobSalesAccName>string</JobSalesAccName>
        <JobStatus>Unallocated or Allocated or Issued or At_Scene or Clear or Cleared_Down or Complete or Ready_To_Invoice or Invoiced or Cancelled</JobStatus>
        <Symptom>string</Symptom>
        <FaultCode>string</FaultCode>
        <JobDateTime>dateTime</JobDateTime>
        <ETA>dateTime</ETA>
        <JobLocationCode>string</JobLocationCode>
        <JobLocationDesc>string</JobLocationDesc>
        <JobDestinationGpsLat>double</JobDestinationGpsLat>
        <JobDestinationGpsLng>double</JobDestinationGpsLng>
        <JobDestinationCode>string</JobDestinationCode>
        <JobDestinationDesc>string</JobDestinationDesc>
        <JobRamNotes>string</JobRamNotes>
        <JobPlannedDriver>string</JobPlannedDriver>
        <JobOnHold>boolean</JobOnHold>
        <JobAuthCode>string</JobAuthCode>
        <JobPdaNotes>string</JobPdaNotes>
        <JobLocationGpsLat>double</JobLocationGpsLat>
        <JobLocationGpsLng>double</JobLocationGpsLng>
        <LastModifiedDateTime>dateTime</LastModifiedDateTime>
        <JobContractCode>string</JobContractCode>
        <JobEdiJobNo>string</JobEdiJobNo>
        <JobSiteCode>string</JobSiteCode>
        <JobVehicleClass>string</JobVehicleClass>
        <JobPriorityFlag>boolean</JobPriorityFlag>
        <JobPriorityReason>string</JobPriorityReason>
        <JobPriorityDetail>string</JobPriorityDetail>
        <JobInvoiceNotes>string</JobInvoiceNotes>
        <JobVehicleMakeModel>string</JobVehicleMakeModel>
        <JobVehicleMake>string</JobVehicleMake>
        <JobVehicleModel>string</JobVehicleModel>
        <JobVehicleRegistration>string</JobVehicleRegistration>
        <JobVehicleColour>string</JobVehicleColour>
        <JobVehicleFuelType>string</JobVehicleFuelType>
        <JobVehicleEngineDetails>string</JobVehicleEngineDetails>
        <JobVehicleWeight>string</JobVehicleWeight>
        <JobLength>string</JobLength>
        <JobTowingTrailer>boolean</JobTowingTrailer>
        <JobOwnerName>string</JobOwnerName>
        <JobOwnerCompany>string</JobOwnerCompany>
        <JobOwnerAddress>string</JobOwnerAddress>
        <JobOwnerMemberNo>string</JobOwnerMemberNo>
        <JobOwnerPhone>string</JobOwnerPhone>
        <JobOwnerEmail>string</JobOwnerEmail>
        <JobPassengerAdult>unsignedByte</JobPassengerAdult>
        <JobPassengerChild>unsignedByte</JobPassengerChild>
        <JobVehicleFleetNo>string</JobVehicleFleetNo>
        <JobVehicleVin>string</JobVehicleVin>
      </GetRecoveryJobDetailsResult>
    </GetRecoveryJobDetailsResponse>
  </soap12:Body>
</soap12:Envelope>