Service Locations

Service locations are business entities that perform work on assets.

List service locations

GET /service_locations

Query

Filtering

externalId, name, address, address2, city, state, postalCode, country, phone, fax, email

Sorting

All filtering fields and createdAt and updatedAt

Limit

10 results

Response

<?xml version="1.0" encoding="UTF-8"?>
<serviceLocations xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationResponse"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationResponse">
    <serviceLocation>
        <URL>URL0</URL>
        <serviceRequestsURL>serviceRequestsURL0</serviceRequestsURL>
        <id>id0</id>
        <externalId>externalId0</externalId>
        <name>name0</name>
        <address>address0</address>
        <address2>address20</address2>
        <city>city0</city>
        <state>state0</state>
        <postalCode>postalCode0</postalCode>
        <country>country0</country>
        <phone>phone0</phone>
        <fax>fax0</fax>
        <email>email0</email>
        <createdAt>2014-06-12T12:47:55Z</createdAt>
        <updatedAt>2014-07-03T19:07:21Z</updatedAt>
    </serviceLocation>
    <serviceLocation>
        <URL>URL1</URL>
        <serviceRequestsURL>serviceRequestsURL1</serviceRequestsURL>
        <id>id1</id>
        <externalId>externalId1</externalId>
        <name>name1</name>
        <address>address1</address>
        <address2>address21</address2>
        <city>city1</city>
        <state>state1</state>
        <postalCode>postal_code1</postalCode>
        <country>country1</country>
        <phone>phone1</phone>
        <fax>fax1</fax>
        <email>email1</email>
        <createdAt>2014-06-12T12:47:55Z</createdAt>
        <updatedAt>2014-07-03T19:07:21Z</updatedAt>
    </serviceLocation>
</serviceLocations>

Get a single service location

GET /service_locations/{id}

Response

<?xml version="1.0" encoding="UTF-8"?>
<serviceLocation xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationResponse"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationResponse">
    <URL>URL0</URL>
    <serviceRequestsURL>serviceRequestsURL0</serviceRequestsURL>
    <id>id0</id>
    <externalId>externalId0</externalId>
    <name>name0</name>
    <address>address0</address>
    <address2>address20</address2>
    <city>city0</city>
    <state>state0</state>
    <postal_code>postalCode0</postal_code>
    <country>country0</country>
    <phone>phone0</phone>
    <fax>fax0</fax>
    <email>email0</email>
    <createdAt>2014-06-12T12:47:55Z</createdAt>
    <updatedAt>2014-07-03T19:07:21Z</updatedAt>
</serviceLocation>

Request service from a service location

Allows an entity to request service from a service location. An asset or parent case must be provided.

POST /service_locations/{id}/service_requests

Parameters

Name Value
assetIdentifier:id Decisiv id of the asset
assignee:id Assignee of the case when created.
asset_information:mileage Mileage of the asset when the case is created.
asset_information:trailer:unit Unit number of the trailer attached to the asset.
asset_information:trailer:loaded Status of the trailer.
primary_contact:name Full name of the primary contact.
primary_contact:phone Phone number of the primary contact.
primary_contact:relation Relation of the primary contact.
breakdown:driverName Name of driver.
breakdown:driverPhone Phone number of driver.
breakdown:location Current location of the asset.
breakdown:city Current location city of the asset.
breakdown:state Current location state of the asset.
cause Description of the cause for the case.
correction Description of the resolution for the case.
complaint Description of the complaint for the case.
customComplaintCodes:code A set of custom complaint codes (must be defined through Professional Services before use)
customerRequestedAppointmentTime Customer’s preferred appointment time.
customerRequestedCompletionTime Customer’s preferred completion time.
followup_time Time by which the customer needs to be contacted.
po_number Purchase order number.
auth_number ?????????????

Request

<?xml version="1.0" encoding="UTF-8"?>
<serviceRequest
xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/FleetServiceRequest"
  xmlns:ct="http://www.decisiv.net/platform_api/0.0.7/Case/CaseTypes"
  xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/FleetServiceRequest">
  <ct:assetIdentifier>
    <ct:id>id</ct:id>
  </ct:assetIdentifier>
  <ct:primaryContact>
    <ct:name>name1</ct:name>
    <ct:phone>15558675309</ct:phone>
    <ct:relation>relation0</ct:relation>
  </ct:primaryContact>
  <ct:breakdown>
    <ct:driverName xsi:nil="true"/>
    <ct:driverPhone xsi:nil="true"/>
    <ct:location>location0</ct:location>
    <ct:city>city0</ct:city>
    <ct:state>state0</ct:state>
  </ct:breakdown>
  <ct:assetInformation>
    <ct:mileage>1234</ct:mileage>
    <ct:trailer>
      <ct:unitNumber>1234</ct:unitNumber>
      <ct:loaded>true</ct:loaded>
    </ct:trailer>
  </ct:assetInformation>
  <complaint>complaint0</complaint>
  <downtime>2006-05-04T18:13:51.0</downtime>
  <customerRequestedAppointmentTime>2006-05-04T18:13:51.0</customerRequestedAppointmentTime>
  <customerRequestedCompletionTime>2006-05-04T18:13:51.0</customerRequestedCompletionTime>
  <followupTime>2006-05-04T18:13:51.0</followupTime>
  <poNumber>poNumber0</poNumber>
  <authNumber>authNumber0</authNumber>
</serviceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<subcase xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/SubcaseResponse"
 xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
 xmlns:ct="http://www.decisiv.net/platform_api/0.0.7/Case/CaseTypes"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/SubcaseResponse">
    <URL>URL0</URL>
    <parentCaseURL>parentCaseURL0</parentCaseURL>
    <assetURL>assetURL0</assetURL>
    <customerURL>customerURL0</customerURL>
    <billingCustomerURL>billingCustomerURL0</billingCustomerURL>
    <shippingCustomerURL>shippingCustomerURL0</shippingCustomerURL>
    <serviceLocationURL>serviceLocationURL0</serviceLocationURL>
    <notesURL>notesURL0</notesURL>
    <attachmentsURL>attachmentsURL0</attachmentsURL>
    <assignee>
        <g:id>id0</g:id>
        <g:name>name0</g:name>
    </assignee>
    <ct:primaryContact>
        <ct:name>name1</ct:name>
        <ct:phone>phone0</ct:phone>
        <ct:relation>relation0</ct:relation>
    </ct:primaryContact>
    <ct:breakdown>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </ct:breakdown>
    <ct:assetInformation>
        <ct:mileage>1234</ct:mileage>
        <ct:trailer>
            <ct:unitNumber>unitNumber0</ct:unitNumber>
            <ct:loaded>false</ct:loaded>
        </ct:trailer>
    </ct:assetInformation>
    <cause>cause0</cause>
    <correction>correction0</correction>
    <complaint>complaint0</complaint>
    <ct:customComplaintCodes>
      <ct:code>YMMV</ct:code>
      <ct:code>YOLO</ct:code>
    </ct:customComplaintCodes>
    <customerRequestedAppointmentTime>2006-05-04T18:13:51.0</customerRequestedAppointmentTime>
    <serviceLocationSuggestedAppointmentTime>2006-05-04T18:13:51.0</serviceLocationSuggestedAppointmentTime>
    <confirmedAppointmentTime>2006-05-04T18:13:51.0</confirmedAppointmentTime>
    <customerRequestedCompletionTime>2006-05-04T18:13:51.0</customerRequestedCompletionTime>
    <followupTime>2006-05-04T18:13:51.0</followupTime>
    <etr>2006-05-04T18:13:51.0</etr>
    <atr>2006-05-04T18:13:51.0</atr>
    <status>status0</status>
    <po_number>po_number0</po_number>
    <ro_number>ro_number0</ro_number>
    <shopSupplies>0.00</shopSupplies>
    <hazWaste>0.00</hazWaste>
    <freight>0.00</freight>
    <tax>0.00</tax>
    <partsTotal>0.00</partsTotal>
    <laborTotal>0.00</laborTotal>
    <coreTotal>0.00</coreTotal>
    <total>0.00</total>
    <createdAt>2014-06-12T12:47:55Z</createdAt>
    <updatedAt>2014-07-03T19:07:21Z</updatedAt>
</subcase>

Create a case for an service location

Create a case for a service location in your group.

POST /service_locations/{id}/cases

Request Attributes

Name Value
assetArrived The time at which the asset arrived at the service location.
assetCheckInTime The time at which the asset was checked in at the service location.
assetIdentifier:id The Decisiv Asset Id.
assetInformation:mileage The mileage of the asset when the case is created.
assetInformation:trailer:loaded The status of the trailer.
assetInformation:trailer:unitNumber The unit number of the trailer attached to the asset.
atr Actual time of repair.
authNumber Authorization Number.
breakdown:city The current location city of the asset.
breakdown:driverName The driver’s name.
breakdown:driverPhone The driver’s phone number.
breakdown:location The current location of the asset.
breakdown:state The current location state of the asset.
cause The description of the cause for the case.
complaint The description of the complaint.
confirmedAppointmentTime Confirmed appointment time.
coreTotal The total cost for Core parts.
correction The description of the resolution for the case.
customComplaintCodes:code A set of custom complaint codes (must be defined through Professional Services before use).
customerRequestedAppointmentTime The customer’s preferred appointment time.
customerRequestedCompletionTime The customer’s preferred completion time.
downtime The time at which the asset was not operational.
etr Estimated time of repair.
followupTime The time by which the customer needs to be contacted.
freight The cost for Freight.
hazWaste The cost for Hazardous Waste.
invoiceAmount Invoice total.
invoiceDate Invoice Date.
invoiceNumber Invoice number.
laborTotal The total cost for Labor.
partsTotal The total cost for Parts.
poNumber Purchase order number.
primaryContact:name The full name of the primary contact.
primaryContact:phone The phone number of the primary contact.
primaryContact:relation The relation of the primary contact.
roNumber Repair order number.
serviceLocationSuggestedAppointmentTime Service location’s preferred appointment time.
severity A decimal value indicating the severity of the estimate.
shopSupplies The cost of the Shop Supplies.
status:name Current status of the case.
tagNumber Tag number for the asset on the lot.
tax The amount of tax charged.
total The accumulated total.
uptime The time at which the asset was operational.
vmrs:code14 Reason for repair.
vmrs:code15 Work Accomplished.
vmrs:code16 Repair priority.
vmrs:code17 Repair site.
vmrs:code82 Operator Report.
vmrs:complaintCode33 Component code for the complaint.
vmrs:complaintCode79 Position code for the complaint.
vmrs:correctionCode33 Component code for the correction.
vmrs:correctionCode79 Position code for the correction.

Request

<?xml version="1.0" encoding="UTF-8"?>
<case xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/CaseRequest"
      xmlns:ct="http://www.decisiv.net/platform_api/0.0.7/Case/CaseTypes"
      xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/CaseRequest">
    <ct:assetIdentifier>
      <ct:id>1234</ct:id>
    </ct:assetIdentifier>
    <assignee>
        <g:id>id0</g:id>
    </assignee>
    <ct:primaryContact>
        <ct:name>name1</ct:name>
        <ct:phone>phone0</ct:phone>
        <ct:relation>relation0</ct:relation>
    </ct:primaryContact>
    <ct:breakdown>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </ct:breakdown>
    <ct:assetInformation>
      <ct:mileage>1234</ct:mileage>
      <ct:trailer>
        <ct:unitNumber>unitNumber</ct:unitNumber>
        <ct:loaded>true</ct:loaded>
      </ct:trailer>
    </ct:assetInformation>
    <cause>cause0</cause>
    <correction>correction0</correction>
    <complaint>complaint0</complaint>
    <downtime>2006-05-04T18:13:51.0</downtime>
    <uptime>2006-05-04T18:13:51.0</uptime>
    <customerRequestedAppointmentTime>2006-05-04T18:13:51.0</customerRequestedAppointmentTime>
    <serviceLocationSuggestedAppointmentTime>2006-05-04T18:13:51.0</serviceLocationSuggestedAppointmentTime>
    <confirmedAppointmentTime>2006-05-04T18:13:51.0</confirmedAppointmentTime>
    <customerRequestedCompletionTime>2006-05-04T18:13:51.0</customerRequestedCompletionTime>
    <followupTime>2006-05-04T18:13:51.0</followupTime>
    <assetArrived>2006-05-04T18:13:51.0</assetArrived>
    <assetCheckInTime>2006-05-04T18:13:51.0</assetCheckInTime>
    <etr>2006-05-04T18:13:51.0</etr>
    <atr>2006-05-04T18:13:51.0</atr>
    <poNumber>poNumber0</poNumber>
    <roNumber>roNumber0</roNumber>
    <invoiceAmount>0.00</invoiceAmount>
    <invoiceNumber>invoiceNumber0</invoiceNumber>
    <authNumber>authNumber0</authNumber>
    <tagNumber>tagNumber0</tagNumber>
</case>

Response

A single case response.

List users for a service location

GET /service_locations/{id}/users

Response

<?xml version="1.0" encoding="UTF-8"?>
<users xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
 xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/UsersResponse"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/Users">
    <user>
        <g:id>id0</g:id>
        <g:URL>URL0</g:URL>
        <g:name>name0</g:name>
        <g:groupName>groupName</g:groupName>
    </user>
    <user>
        <g:id>id1</g:id>
        <g:URL>URL1</g:URL>
        <g:name>name1</g:name>
        <g:groupName>groupName</g:groupName>
    </user>
</users>

List departments for a service location

GET /service_locations/{id}/departments

Response

<?xml version="1.0" encoding="UTF-8"?>
<departments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:d="http://www.decisiv.net/platform_api/0.0.7/Case/Department"
xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationDepartments">
    <department>
        <d:code>code0</d:code>
        <d:description>description0</d:description>
    </department>
    <department>
        <d:code>code1</d:code>
        <d:description>description1</d:description>
    </department>
</departments>

Get a single department by code

GET /service_locations/{id}/departments/{code}

Response

<?xml version="1.0" encoding="UTF-8"?>
<department xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:d="http://www.decisiv.net/platform_api/0.0.7/Case/Department"
xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationDepartments">
    <d:code>code0</d:code>
    <d:description>description0</d:description>
</department>

List program types for a service location

GET /service_locations/{id}/program_types

Response

<?xml version="1.0" encoding="UTF-8"?>
<programTypes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:pt="http://www.decisiv.net/platform_api/0.0.7/Case/ProgramType"
xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/ServiceLocationProgramTypes">
    <programType>
        <pt:description>description0</pt:description>
    </programType>
    <programType>
        <pt:description>description1</pt:description>
    </programType>
</programTypes>