Skip to content
Browse files

updates equipments api

  • Loading branch information...
1 parent 07e4d97 commit 82c0f95979da4a8d2221c346c673ab274a401b6e @joshrendek joshrendek committed
Showing with 276 additions and 235 deletions.
  1. +276 −235 docs/equipments.md
View
511 docs/equipments.md
@@ -11,93 +11,93 @@ GET /api/equipments.json
```json
[
- {
- equipment: {
- equipment_size_id: 16,
- warranty_base_months: null,
- contact_name: "",
- miscellaneous_6: null,
- assigned_use_id: 1,
- next_pm_cycle: " 2A 1B 2A 1C",
- ein_date: "2003/07/11",
- prev_pm_cycle: "A",
- billing_suffix: "001",
- miscellaneous_3: null,
- equipment_cab_id: null,
- employee_job_class: "00000",
- equipment_number: "ST028439",
- begin_odometer: 15,
- do_number: "0",
- equipment_code: null,
- warranty_drive_months: null,
- fleet_card_number: null,
- replace_units: 120000,
- contact_email: null,
- id: 113,
- warranty_extended_units: null,
- miscellaneous_8: null,
- acquisition_cost: 26555,
- equipment_id: null,
- miscellaneous_10: null,
- fleet_code: "3600",
- equipment_specification_id: 74,
- gross_weight_rating: 0,
- transmission: "",
- meter_type: "MILES",
- property_number: "",
- warranty_base_units: null,
- miscellaneous_5: null,
- schedule: null,
- pm_schedule_id: 14,
- purchase_method_id: 13,
- type_id: null,
- warranty_drive_units: null,
- ein_time: "14:08:07",
- location_id: 19,
- miscellaneous_2: null,
- created_at: "2011-12-21T17:22:23-05:00",
- replace_months: 144,
- serial_number: "1FMPU16L43LC47241",
- equipment_status_id: 2,
- people_first_id: "0",
- updated_at: "2012-03-27T14:38:16-04:00",
- ein_pid: "9650",
- equipment_drive_id: null,
- tank_capacity: null,
- additional_description: null,
- insurance_rate: "0.0",
- logs_available: 1,
- miscellaneous_7: null,
- begin_service_on: "2003-06-27",
- requires_cdl: null,
- warranty_start_on: null,
- tag: "",
- purchase_requisition: "0",
- date_received_on: "2003-06-27",
- expansion_option: null,
- organization_code_id: null,
- assigned_org_unit: "",
- miscellaneous_4: null,
- unit_charge: null,
- daily_charge: "0.00",
- employee_name: "",
- is_archived: false,
- fire_status_id: null,
- shop_id: 35,
- city_id: 398,
- ancestry: null,
- agency_id: 5,
- miscellaneous_1: "",
- warranty_end_on: null,
- meter_life: 79051,
- engine_size_id: 2,
- miscellaneous_9: null,
- vehicle_equivalent_unit: null,
- warranty_extended_months: null
+{
+ "equipment": {
+ "equipment_size_id": 16,
+ "warranty_base_months": null,
+ "contact_name": "",
+ "miscellaneous_6": null,
+ "assigned_use_id": 1,
+ "next_pm_cycle": " 2A 1B 2A 1C",
+ "ein_date": "2003/07/11",
+ "prev_pm_cycle": "A",
+ "billing_suffix": "001",
+ "miscellaneous_3": null,
+ "equipment_cab_id": null,
+ "employee_job_class": "00000",
+ "equipment_number": "ST028439",
+ "begin_odometer": 15,
+ "do_number": "0",
+ "equipment_code": null,
+ "warranty_drive_months": null,
+ "fleet_card_number": null,
+ "replace_units": 120000,
+ "contact_email": null,
+ "id": 113,
+ "warranty_extended_units": null,
+ "miscellaneous_8": null,
+ "acquisition_cost": 26555,
+ "equipment_id": null,
+ "miscellaneous_10": null,
+ "fleet_code": "3600",
+ "equipment_specification_id": 74,
+ "gross_weight_rating": 0,
+ "transmission": "",
+ "meter_type": "MILES",
+ "property_number": "",
+ "warranty_base_units": null,
+ "miscellaneous_5": null,
+ "schedule": null,
+ "pm_schedule_id": 14,
+ "purchase_method_id": 13,
+ "type_id": null,
+ "warranty_drive_units": null,
+ "ein_time": "14:08:07",
+ "location_id": 19,
+ "miscellaneous_2": null,
+ "created_at": "2011-12-21T17:22:23-05:00",
+ "replace_months": 144,
+ "serial_number": "1FMPU16L43LC47241",
+ "equipment_status_id": 2,
+ "people_first_id": "0",
+ "updated_at": "2012-03-27T14:38:16-04:00",
+ "ein_pid": "9650",
+ "equipment_drive_id": null,
+ "tank_capacity": null,
+ "additional_description": null,
+ "insurance_rate": "0.0",
+ "logs_available": 1,
+ "miscellaneous_7": null,
+ "begin_service_on": "2003-06-27",
+ "requires_cdl": null,
+ "warranty_start_on": null,
+ "tag": "",
+ "purchase_requisition": "0",
+ "date_received_on": "2003-06-27",
+ "expansion_option": null,
+ "organization_code_id": null,
+ "assigned_org_unit": "",
+ "miscellaneous_4": null,
+ "unit_charge": null,
+ "daily_charge": "0.00",
+ "employee_name": "",
+ "is_archived": false,
+ "fire_status_id": null,
+ "shop_id": 35,
+ "city_id": 398,
+ "ancestry": null,
+ "agency_id": 5,
+ "miscellaneous_1": "",
+ "warranty_end_on": null,
+ "meter_life": 79051,
+ "engine_size_id": 2,
+ "miscellaneous_9": null,
+ "vehicle_equivalent_unit": null,
+ "warranty_extended_months": null
}
+}
]
-
```
## Show a single piece of equipment
@@ -108,164 +108,205 @@ GET /api/equipments/:id.json
### Parameters
**id**: the Equipments id field
+### Optional return values
+**shop**
+**equipment_cab**
+**equipment_drive**
+**pm_schedule**
+**engine_size**
+**organization_code**
+**purchase_method**
+**city**
+**equipment_status**
+
+
### Example Response
**Status**: 200 OK
```json
{
- equipment: {
- equipment_size_id: 16,
- warranty_base_months: null,
- contact_name: "",
- miscellaneous_6: null,
- assigned_use_id: 1,
- next_pm_cycle: " 2A 1B 2A 1C",
- ein_date: "2003/07/11",
- prev_pm_cycle: "A",
- billing_suffix: "001",
- miscellaneous_3: null,
- equipment_cab_id: null,
- employee_job_class: "00000",
- equipment_number: "ST028439",
- begin_odometer: 15,
- do_number: "0",
- equipment_code: null,
- warranty_drive_months: null,
- fleet_card_number: null,
- replace_units: 120000,
- contact_email: null,
- id: 113,
- warranty_extended_units: null,
- shop: {
- location: {
- city: "",
- division_id: 9,
- labor_rate: "0.0",
- is_archived: false,
- id: 35,
- location_code: "PM01",
- ancestry: null,
- agency_id: 5,
- county: null,
- zip: "",
- street_address: "",
- updated_at: "2011-12-22T15:58:30-05:00",
- name: "DEFAULT",
- location_type: "SHOP",
- state: "",
- created_at: "2011-12-22T15:58:30-05:00"
- }
- },
- miscellaneous_8: null,
- acquisition_cost: 26555,
- equipment_id: null,
- miscellaneous_10: null,
- fleet_code: "3600",
- equipment_specification_id: 74,
- gross_weight_rating: 0,
- transmission: "",
- meter_type: "MILES",
- property_number: "",
- warranty_base_units: null,
- city: {
- city: {
- id: 398,
- updated_at: "2011-12-21T17:16:32-05:00",
- name: "BARTOW",
- county_id: 57,
- created_at: "2011-12-21T17:16:32-05:00"
- }
- },
- miscellaneous_5: null,
- schedule: null,
- pm_schedule_id: 14,
- assigned_use: {
- id: 1,
- updated_at: "2011-11-16T14:10:35-05:00",
- name: "Pool vehicle",
- created_at: "1949-12-31T19:00:00-05:00",
- code: "A1"
- },
- purchase_method_id: 13,
- type_id: null,
- warranty_drive_units: null,
- ein_time: "14:08:07",
- location_id: 19,
- miscellaneous_2: null,
- created_at: "2011-12-21T17:22:23-05:00",
- replace_months: 144,
- serial_number: "1FMPU16L43LC47241",
- equipment_status_id: 2,
- people_first_id: "0",
- updated_at: "2012-03-27T14:38:16-04:00",
- ein_pid: "9650",
- equipment_drive_id: null,
- tank_capacity: null,
- additional_description: null,
- insurance_rate: "0.0",
- logs_available: 1,
- miscellaneous_7: null,
- begin_service_on: "2003-06-27",
- location: {
- city: null,
- division_id: 9,
- labor_rate: null,
- is_archived: false,
- id: 19,
- location_code: "0080",
- ancestry: null,
- agency_id: 5,
- county: null,
- zip: null,
- street_address: null,
- updated_at: "2012-02-24T16:30:01-05:00",
- name: "BARTOW",
- location_type: null,
- state: null,
- created_at: "2011-12-20T19:21:59-05:00"
- },
- requires_cdl: null,
- warranty_start_on: null,
- tag: "",
- purchase_requisition: "0",
- date_received_on: "2003-06-27",
- expansion_option: null,
- organization_code_id: null,
- assigned_org_unit: "",
- employee_name: "",
- daily_charge: "0.00",
- miscellaneous_4: null,
- unit_charge: null,
- is_archived: false,
- fire_status_id: null,
- city_id: 398,
- ancestry: null,
- agency_id: 5,
- miscellaneous_1: "",
- shop_id: 35,
- warranty_end_on: null,
- meter_life: 79051,
- engine_size_id: 2,
- pm_schedule: {
- pm_schedule: {
- unit_interval: 5000,
- service_sequence: " 2A 1B 2A 1C",
- pm_cycle: "30 / 30000",
- is_archived: false,
- id: 14,
- agency_id: null,
- pm_code: "F(5MO/5,000MILES)",
- month_interval: 5,
- meter_type: "MILES",
- updated_at: "2012-02-07T13:49:59-05:00",
- created_at: "2011-12-20T16:04:37-05:00"
- }
- },
- miscellaneous_9: null,
- vehicle_equivalent_unit: null,
- warranty_extended_months: null
+ "equipment": {
+ "equipment_size_id": 16,
+ "warranty_base_months": null,
+ "contact_name": "",
+ "miscellaneous_6": null,
+ "assigned_use_id": 1,
+ "next_pm_cycle": " 2A 1B 2A 1C",
+ "ein_date": "2003/07/11",
+ "equipment_status": {
+ "equipment_status": {
+ "id": 2,
+ "updated_at": "2011-12-20T19:14:25-05:00",
+ "name": "OPERATIONAL",
+ "created_at": "2011-12-20T19:14:25-05:00",
+ "code": "O"
+ }
+ },
+ "prev_pm_cycle": "A",
+ "billing_suffix": "001",
+ "miscellaneous_3": null,
+ "equipment_cab_id": null,
+ "employee_job_class": "00000",
+ "equipment_number": "ST028439",
+ "begin_odometer": 15,
+ "do_number": "0",
+ "equipment_code": null,
+ "warranty_drive_months": null,
+ "replace_units": 120000,
+ "fleet_card_number": null,
+ "contact_email": null,
+ "id": 113,
+ "warranty_extended_units": null,
+ "shop": {
+ "location": {
+ "city": "",
+ "division_id": 9,
+ "labor_rate": "0.0",
+ "is_archived": false,
+ "id": 35,
+ "location_code": "PM01",
+ "ancestry": null,
+ "agency_id": 5,
+ "county": null,
+ "zip": "",
+ "street_address": "",
+ "updated_at": "2011-12-22T15:58:30-05:00",
+ "name": "DEFAULT",
+ "location_type": "SHOP",
+ "state": "",
+ "created_at": "2011-12-22T15:58:30-05:00"
+ }
+ },
+ "miscellaneous_8": null,
+ "acquisition_cost": 26555,
+ "equipment_id": null,
+ "miscellaneous_10": null,
+ "fleet_code": "3600",
+ "equipment_specification_id": 74,
+ "gross_weight_rating": 0,
+ "transmission": "",
+ "meter_type": "MILES",
+ "property_number": "",
+ "warranty_base_units": null,
+ "city": {
+ "city": {
+ "id": 398,
+ "updated_at": "2011-12-21T17:16:32-05:00",
+ "name": "BARTOW",
+ "county_id": 57,
+ "created_at": "2011-12-21T17:16:32-05:00"
+ }
+ },
+ "miscellaneous_5": null,
+ "schedule": null,
+ "pm_schedule_id": 14,
+ "assigned_use": {
+ "id": 1,
+ "updated_at": "2011-11-16T14:10:35-05:00",
+ "name": "Pool vehicle",
+ "created_at": "1949-12-31T19:00:00-05:00",
+ "code": "A1"
+ },
+ "purchase_method_id": 13,
+ "type_id": null,
+ "warranty_drive_units": null,
+ "ein_time": "14:08:07",
+ "location_id": 19,
+ "miscellaneous_2": null,
+ "created_at": "2011-12-21T17:22:23-05:00",
+ "replace_months": 144,
+ "serial_number": "1FMPU16L43LC47241",
+ "equipment_status_id": 2,
+ "people_first_id": "0",
+ "updated_at": "2012-03-27T14:38:16-04:00",
+ "ein_pid": "9650",
+ "equipment_drive_id": null,
+ "tank_capacity": null,
+ "additional_description": null,
+ "insurance_rate": "0.0",
+ "logs_available": 1,
+ "miscellaneous_7": null,
+ "begin_service_on": "2003-06-27",
+ "location": {
+ "city": null,
+ "division_id": 9,
+ "labor_rate": null,
+ "is_archived": false,
+ "id": 19,
+ "location_code": "0080",
+ "ancestry": null,
+ "agency_id": 5,
+ "county": null,
+ "zip": null,
+ "street_address": null,
+ "updated_at": "2012-02-24T16:30:01-05:00",
+ "name": "BARTOW",
+ "location_type": null,
+ "state": null,
+ "created_at": "2011-12-20T19:21:59-05:00"
+ },
+ "requires_cdl": null,
+ "warranty_start_on": null,
+ "tag": "",
+ "purchase_requisition": "0",
+ "engine_size": {
+ "engine_size": {
+ "is_archived": false,
+ "id": 2,
+ "engine_size_type": "BY LITERS",
+ "updated_at": "2011-12-21T17:17:37-05:00",
+ "name": "8 LITERS",
+ "created_at": "2011-12-21T17:17:37-05:00"
+ }
+ },
+ "expansion_option": null,
+ "date_received_on": "2003-06-27",
+ "organization_code_id": null,
+ "assigned_org_unit": "",
+ "employee_name": "",
+ "daily_charge": "0.00",
+ "miscellaneous_4": null,
+ "unit_charge": null,
+ "is_archived": false,
+ "fire_status_id": null,
+ "city_id": 398,
+ "ancestry": null,
+ "agency_id": 5,
+ "miscellaneous_1": "",
+ "shop_id": 35,
+ "warranty_end_on": null,
+ "meter_life": 79051,
+ "engine_size_id": 2,
+ "pm_schedule": {
+ "pm_schedule": {
+ "unit_interval": 5000,
+ "service_sequence": " 2A 1B 2A 1C",
+ "pm_cycle": "30 / 30000",
+ "is_archived": false,
+ "id": 14,
+ "agency_id": null,
+ "pm_code": "F(5MO/5,000MILES)",
+ "month_interval": 5,
+ "meter_type": "MILES",
+ "updated_at": "2012-02-07T13:49:59-05:00",
+ "created_at": "2011-12-20T16:04:37-05:00"
+ }
+ },
+ "purchase_method": {
+ "purchase_method": {
+ "is_archived": false,
+ "id": 13,
+ "updated_at": "2011-12-20T19:14:25-05:00",
+ "name": "CONVENTIONAL PURCHASE",
+ "created_at": "2011-12-20T19:14:25-05:00"
+ }
+ },
+ "miscellaneous_9": null,
+ "vehicle_equivalent_unit": null,
+ "warranty_extended_months": null
}
}
+
```

0 comments on commit 82c0f95

Please sign in to comment.
Something went wrong with that request. Please try again.