API Version 1

General Architecture Resources

Cases

Cases have a service location and an asset that is tied to a customer.

Get a single case

GET /cases/{id}

Response 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.
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.
assignee:groupName The group name for the assignee.
assignee:id The assignee of the case when created.
assignee:name The name of the assignee.
assignee:url The Assignee URL.
atr Actual time of repair.
attachmentsURL The Cases attachments url.
authNumber Authorization Number.
billingCustomerURL The Billing Customer URL.
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.
closed Identifies whether the Case is Closed or not.
closeURL The URL to Close 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.
createdAt The date the record was created.
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.
customerURL The Customer URL.
downtime The time at which the asset was not operational.
estimateURL The Estimate URL.
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.
id The numerical record id.
invoiceAmount Invoice total.
invoiceDate Invoice Date.
invoiceNumber Invoice number.
laborTotal The total cost for Labor.
notesURL The Case notes URL.
openURL The URL to Open the Case.
originationEvent The origination of the Event.
parentCaseURL The Parent Case URL.
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.
serviceLocationURL The Service Location URL.
severity A decimal value indicating the severity of the estimate.
shippingCustomerURL The Shipping Customer URL.
shopSupplies The cost of the Shop Supplies.
status:name Current status of the case.
subcasesURL The Subcases URL.
tagNumber Tag number for the asset on the lot.
tax The amount of tax charged.
total The accumulated total.
updatedAt The date the record was last updated.
uptime The time at which the asset was operational.
URL The object URL.
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.

Response

<?xml version="1.0" encoding="UTF-8"?>
<case xmlns="http://www.decisiv.net/platform_api/0.2/Case/CaseResponse"
 xmlns:g="http://www.decisiv.net/platform_api/0.2/Case/GroupedUser"
 xmlns:ct="http://www.decisiv.net/platform_api/0.2/Case/CaseTypes"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.2/Case/CaseResponse">
    <id>id0</id>
    <URL>URL0</URL>
    <assetURL>assetURL0</assetURL>
    <customerURL>customerURL0</customerURL>
    <billingCustomerURL>billingCustomerURL0</billingCustomerURL>
    <shippingCustomerURL>shippingCustomerURL0</shippingCustomerURL>
    <serviceLocationURL>serviceLocationURL0</serviceLocationURL>
    <estimateURL>estimateURL</estimateURL>
    <notesURL>notesURL0</notesURL>
    <attachmentsURL>attachmentsURL0</attachmentsURL>
    <subcasesURL>subcasesURL0</subcasesURL>
    <closeURL>closeURL0</closeURL>
    <openURL>openURL0</openURL>
    <assignee>
        <g:id>id0</g:id>
        <g:name>name0</g:name>
    </assignee>
    <ct:primaryContact>
        <ct:name>name0</ct:name>
        <ct:phone>15558675309</ct:phone>
        <ct:relation>relation0</ct:relation>
    </ct:primaryContact>
    <ct:breakdown>
        <ct:driverName>driver name</ct:driverName>
        <ct:driverPhone>555-555-5555</ct:driverPhone>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </ct:breakdown>
    <ct:assetInformation>
        <ct:mileage>100</ct:mileage>
        <ct:trailer>
            <ct:unitNumber>unitNumber0</ct:unitNumber>
            <ct:loaded>false</ct:loaded>
        </ct:trailer>
    </ct:assetInformation>
    <cause>cause1</cause>
    <correction>correction1</correction>
    <complaint>complaint1</complaint>
    <severity>0.0</severity>
    <originationEvent>originationEvent0</originationEvent>
    <ct:customComplaintCodes>
      <ct:code>001158</ct:code>
      <ct:code>005599</ct:code>
    </ct:customComplaintCodes>
    <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>
    <ct:status>
        <ct:name>name1</ct:name>
    </ct:status>
    <poNumber>poNumber0</poNumber>
    <roNumber>roNumber0</roNumber>
    <invoiceAmount>0.00</invoiceAmount>
    <invoiceNumber>invoiceNumber0</invoiceNumber>
    <invoiceDate>2016-04-21</invoiceDate>
    <authNumber>authNumber0</authNumber>
    <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>
    <closed>false</closed>
    <createdAt>2006-05-04T18:13:51.0</createdAt>
    <updatedAt>2006-05-04T18:13:51.0</updatedAt>
</case>

List cases

A collection of cases.

GET /cases

Query

Filtering

  • asset_id: Asset id or uuid can be used (e.g. /cases?asset_id=12345 or /cases?asset_id=7e03d16e-e1c7-11e8-9f32-f2801f1b9fd1)
  • assignee_id: User id or uuid can be used (e.g. /cases?assignee_id=12345 or /cases?assignee_id=7e03d16e-e1c7-11e8-9f32-f2801f1b9fd1)
  • created_after: Accepted format: YYYYMMDD (e.g. /cases?created_after=20190101)
  • created_before: Accepted format: YYYYMMDD (e.g. /cases?created_before=20190101)
  • closed: Accepted values are: true or false (e.g. /cases?closed=true)
  • customer_id: Customer id or uuid can be used (e.g. /cases?customer_id=12345 or /cases?customer_id=7e03d16e-e1c7-11e8-9f32-f2801f1b9fd1)
  • ro_number
  • service_location_id: Service Location id or uuid can be used (e.g. /cases?service_location_id=12345 or /cases?service_location_id=7e03d16e-e1c7-11e8-9f32-f2801f1b9fd1)
  • updated_after: Accepted format: YYYYMMDD (e.g. /cases?updated_after=20190101)
  • updated_before: Accepted format: YYYYMMDD (e.g. /cases?updated_before=20190101)

Pagination

page filter can be used to paginate the results (e.g. /cases?page=1)

Sorting

Records are sorted by created_at in descending order.

Limit

5 results

Response Attributes

See Response Attributes above

Response

<?xml version="1.0" encoding="UTF-8"?>
<cases xmlns="http://www.decisiv.net/platform_api/0.2/Case/CaseResponse"
 xmlns:ct="http://www.decisiv.net/platform_api/0.2/Case/CaseTypes"
 xmlns:g="http://www.decisiv.net/platform_api/0.2/Case/GroupedUser"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.2/Case/CaseResponse">
    <case>
        <id>id0</id>
        <URL>URL0</URL>
        <parentCaseURL>parentCaseURL0</parentCaseURL>
        <assetURL>assetURL0</assetURL>
        <customerURL>customerURL0</customerURL>
        <billingCustomerURL>billingCustomerURL0</billingCustomerURL>
        <shippingCustomerURL>shippingCustomerURL0</shippingCustomerURL>
        <serviceLocationURL>serviceLocationURL0</serviceLocationURL>
        <estimateURL>estimateURL</estimateURL>
        <notesURL>notesURL0</notesURL>
        <attachmentsURL>attachmentsURL0</attachmentsURL>
        <subcasesURL>subcasesURL0</subcasesURL>
        <closeURL>closeURL0</closeURL>
        <openURL>openURL0</openURL>
        <assignee>
            <g:id>id0</g:id>
            <g:name>name0</g:name>
        </assignee>
        <ct:primaryContact>
            <ct:name>name1</ct:name>
            <ct:phone>15558675309</ct:phone>
            <ct:relation>relation0</ct:relation>
        </ct:primaryContact>
        <ct:breakdown>
            <ct:driverName>driver name</ct:driverName>
            <ct:driverPhone>555-555-5555</ct:driverPhone>
            <ct:location>location0</ct:location>
            <ct:city>city0</ct:city>
            <ct:state>state0</ct:state>
        </ct:breakdown>
        <ct:assetInformation>
            <ct:mileage>100</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>
        <severity>0.0</severity>
        <originationEvent>originationEvent0</originationEvent>
        <ct:customComplaintCodes>
          <ct:code>001158</ct:code>
          <ct:code>005599</ct:code>
        </ct:customComplaintCodes>
        <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>
        <ct:status>
            <ct:name>name4</ct:name>
        </ct:status>
        <poNumber>poNumber0</poNumber>
        <roNumber>roNumber0</roNumber>
        <invoiceAmount>0.00</invoiceAmount>
        <invoiceNumber>invoiceNumber0</invoiceNumber>
        <invoiceDate>2016-04-21</invoiceDate>
        <authNumber>authNumber0</authNumber>
        <tagNumber>tagNumber0</tagNumber>
        <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>
        <closed>false</closed>
        <createdAt>2006-05-04T18:13:51.0</createdAt>
        <updatedAt>2006-05-04T18:13:51.0</updatedAt>
    </case>
    <case>
        <id>id1</id>
        <URL>URL1</URL>
        <parentCaseURL>parentCaseURL1</parentCaseURL>
        <assetURL>assetURL1</assetURL>
        <customerURL>customerURL0</customerURL>
        <billingCustomerURL>billingCustomerURL1</billingCustomerURL>
        <shippingCustomerURL>shippingCustomerURL1</shippingCustomerURL>
        <serviceLocationURL>serviceLocationURL1</serviceLocationURL>
        <estimateURL>estimateURL</estimateURL>
        <notesURL>notesURL1</notesURL>
        <attachmentsURL>attachmentsURL1</attachmentsURL>
        <subcasesURL>subcasesURL1</subcasesURL>
        <closeURL>closeURL1</closeURL>
        <openURL>openURL1</openURL>
        <assignee>
            <g:id>id4</g:id>
            <g:name>name5</g:name>
        </assignee>
        <ct:primaryContact>
            <ct:name>name6</ct:name>
            <ct:phone>15558675309</ct:phone>
            <ct:relation>relation1</ct:relation>
        </ct:primaryContact>
        <ct:breakdown>
            <ct:driverName>driver name</ct:driverName>
            <ct:driverPhone>555-555-5555</ct:driverPhone>
            <ct:location>location1</ct:location>
            <ct:city>city1</ct:city>
            <ct:state>state1</ct:state>
        </ct:breakdown>
        <ct:assetInformation>
            <ct:mileage>mileage1</ct:mileage>
            <ct:trailer>
                <ct:unitNumber>unitNumber1</ct:unitNumber>
                <ct:loaded>false</ct:loaded>
            </ct:trailer>
        </ct:assetInformation>
        <cause>cause1</cause>
        <correction>correction1</correction>
        <complaint>complaint1</complaint>
        <severity>0.0</severity>
        <originationEvent>originationEvent0</originationEvent>
        <ct:customComplaintCodes>
          <ct:code>001158</ct:code>
          <ct:code>005599</ct:code>
        </ct:customComplaintCodes>
        <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>
        <ct:status>
            <ct:name>name9</ct:name>
        </ct:status>
        <poNumber>poNumber1</poNumber>
        <roNumber>roNumber1</roNumber>
        <invoiceAmount>0.00</invoiceAmount>
        <invoiceNumber>invoiceNumber1</invoiceNumber>
        <invoiceDate>2016-04-21</invoiceDate>
        <authNumber>authNumber1</authNumber>
        <tagNumber>tagNumber1</tagNumber>
        <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>
        <closed>false</closed>
        <createdAt>2006-05-04T18:13:51.0</createdAt>
        <updatedAt>2006-05-04T18:13:51.0</updatedAt>
    </case>
</cases>

Update a case

POST /cases/{id}

Request Attributes

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

Request

<?xml version="1.0" encoding="UTF-8"?>
<case xmlns="http://www.decisiv.net/platform_api/0.1/Case/CaseRequest" 
      xmlns:ct="http://www.decisiv.net/platform_api/0.1/Case/CaseTypes" 
      xmlns:g="http://www.decisiv.net/platform_api/0.1/Case/GroupedUser" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:vmrs="http://www.decisiv.net/platform_api/0.1/Case/VMRS"
      xsi:schemaLocation="http://www.decisiv.net/platform_api/0.1/Case/CaseRequest">
    <assignee>
        <g:id>id0</g:id>
    </assignee>
    <primaryContact>
        <ct:name>name0</ct:name>
        <ct:phone>15558675309</ct:phone>
        <ct:relation>relation0</ct:relation>
    </primaryContact>
    <breakdown>
        <ct:driverName>Driver Name</ct:driverName>
        <ct:driverPhone>555-555-5555</ct:driverPhone>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </breakdown>
    <assetInformation>
      <ct:mileage>100</ct:mileage>
      <ct:trailer>
        <ct:unitNumber>unitNumber</ct:unitNumber>
        <ct:loaded>true</ct:loaded>
      </ct:trailer>
    </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.

Close a case

PUT /cases/{id}/actions/close

Response

# success
Status: 202
# failure - ie. already closed
Status: 403

Open a case

Open or re-open a case.

PUT /cases/{id}/actions/open

Response

# success
Status: 202
# failure - ie. already opened
Status: 403
Sections
Get a single case List cases Update a case