Docs Home

Equipment Endpoints

Equipment Summary

• id: number
• name: string
• type: string
• holderId: number
• categoryId: number
• currentLocationId: number
• homeLocationId: number

Equipment Details

• id: number
• name: string
• type: string
• holderId: number
• holderName: string
• categoryId: number
• categoryName: string
• currentLocationId: number
• currentLocationName: string
• homeLocationId: number
• homeLocationName: string
• condition: string
• make: string
• manufacturer: string
• model: string
• dateUpdated: date string
• dateHolderUpdated: date string
• serialId: string
• notes: string

GET /equipment?{categoryId, manufacturer}

List equipment

query parameters:

• categoryId: number
• manufacturer: string

response:

[]... Equipment Summary

GET /equipment/{:equipment-id}

Get equipment info

response:

Equipment Details

GET /equipment/summary?{categoryId, includedFields[]}

Generate csv summary of equipment with specified scope

query parameters:

• categoryId: number
• includedFields: string array containing one or more of:
  • 'name'
  • 'type'
  • 'holder'
  • 'category'
  • 'currentLocation'
  • 'homeLocation'
  • 'condition'
  • 'make'
  • 'model'
  • 'manufacturer'
  • 'dateUpdated'
  • 'dateHolderUpdated'
  • 'serialId'
  • 'notes'

response:

Textual CSV table of equipment entries in the specified category with specified fields

GET /equipment/{:equipment-id}/notes

Get equipment notes

response:

Textual content of "notes" field

PUT /equipment/{:equipment-id}/notes

Update equipment notes

body parameters:

• notes*: string