Apigility

ReservationEquipment

Maintains a set of records that indicate what equipment is attached to which reservations

GET /service-center/reservation/:reservation_id/equipment

Returns all reservation equipment

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/reservation/:reservation_id/equipment

Adds a piece of equipment to a reservation

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/reservation/:reservation_id/equipment[/:equipment_id]

Removes a piece of equipment from a reservation

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

GET /service-center/reservation/:reservation_id/equipment[/:equipment_id]

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

CheckOutEquipment

Maintains equipment associations with check out records.

GET /service-center/check-out/:check_out_id/equipment

Returns all of the check out equipment

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/check-out/:check_out_id/equipment

Adds a piece of equipment to a check out

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

{
   "equipmentId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/check-out/:check_out_id/equipment[/:equipment_id]

Removes a piece of equipment from a check out. Returns a 204 No Content status on success.

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

GET /service-center/check-out/:check_out_id/equipment[/:equipment_id]

Fields

Field	Type	Description	Required
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

CheckInEquipment

Maintains a set of records that illustrate the equipment assigned to check in records.

GET /service-center/check-in/:check_in_id/equipment

Returns all check in equipment

Fields

Field	Type	Description	Required
checkInId			YES
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/check-in/:check_in_id/equipment

Add a piece of equipment to a check in

Fields

Field	Type	Description	Required
checkInId			YES
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/check-in/:check_in_id/equipment[/:equipment_id]

Removes a piece of equipment from a check in.

Fields

Field	Type	Description	Required
checkInId			YES
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

GET /service-center/check-in/:check_in_id/equipment[/:equipment_id]

Fields

Field	Type	Description	Required
checkInId			YES
equipmentId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GenerateCheckOut

Generates a check out from a reservation

POST /service-center/generate-check-out

Fields

Field	Type	Description	Required
reservationId			YES
createdByInitials			YES
confirmationEmail			NO
address			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

{
   "reservationId": "",
   "createdByInitials": "",
   "confirmationEmail": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GenerateCheckIn

Generates a check in from a check out

POST /service-center/generate-check-in

The checkOutID is required. All other fields are optional.

Fields

Field	Type	Description	Required
createdByInitials			NO
confirmationEmail			NO
checkOutId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

{
   "createdByInitials": "",
   "confirmationEmail": "",
   "checkOutId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GenerateOperationalCheck

Generates an operational check for each piece of equipment associated with a given check in record

POST /service-center/generate-operational-check

Fields

Field	Type	Description	Required
checkInId			YES

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/hal+json application/json
Content-Type	application/vnd.service-center.v1+json application/json

Body

{
   "checkInId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Customer

GET /service-center/customer

Fields

Field	Type	Description	Required
userName			YES
agreementFormSigned			NO
agreementFormLastSigned			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/customer

Fields

Field	Type	Description	Required
userName			YES
agreementFormSigned			NO
agreementFormLastSigned			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /service-center/customer[/:customer_id]

Fields

Field	Type	Description	Required
userName			YES
agreementFormSigned			NO
agreementFormLastSigned			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /service-center/customer[/:customer_id]

Fields

Field	Type	Description	Required
userName			YES
agreementFormSigned			NO
agreementFormLastSigned			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/customer[/:customer_id]

Fields

Field	Type	Description	Required
userName			YES
agreementFormSigned			NO
agreementFormLastSigned			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

CheckOutRecord

GET /service-center/check-out-record

Fields

Field	Type	Description	Required
pickUp			YES
checkedIn			NO
agreementFormSigned			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			YES
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/check-out-record

Fields

Field	Type	Description	Required
pickUp			YES
checkedIn			NO
agreementFormSigned			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			YES
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /service-center/check-out-record[/:check_out_record_id]

Fields

Field	Type	Description	Required
pickUp			YES
checkedIn			NO
agreementFormSigned			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			YES
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /service-center/check-out-record[/:check_out_record_id]

Fields

Field	Type	Description	Required
pickUp			YES
checkedIn			NO
agreementFormSigned			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			YES
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/check-out-record[/:check_out_record_id]

Fields

Field	Type	Description	Required
pickUp			YES
checkedIn			NO
agreementFormSigned			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			YES
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

CheckInRecord

The CheckInRecord service maintains a set or records that indicate when each check-out has been returned.

GET /service-center/check-in-record

Returns a list of records.

Fields

Field	Type	Description	Required
createdByInitials			YES
confirmationEmail			NO
dropOff			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/check-in-record"
       },
       "first": {
           "href": "/service-center/check-in-record?page={page}"
       },
       "prev": {
           "href": "/service-center/check-in-record?page={page}"
       },
       "next": {
           "href": "/service-center/check-in-record?page={page}"
       },
       "last": {
           "href": "/service-center/check-in-record?page={page}"
       }
   }
   "_embedded": {
       "check_in_record": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/check-in-record[/:check_in_record_id]"
                   }
               }
              "checkInId": "",
              "checkOutId": "",
              "createdByInitials": "",
              "confirmationEmail": "",
              "dropOff": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": ""
           }
       ]
   }
}

GET /service-center/check-in-record[/:check_in_record_id]

Returns a single record.

Fields

Field	Type	Description	Required
createdByInitials			YES
confirmationEmail			NO
dropOff			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/check-in-record[/:check_in_record_id]"
       }
   }
   "checkInId": "",
   "checkOutId": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "dropOff": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

PATCH /service-center/check-in-record[/:check_in_record_id]

Updates all fields provided for a record.

Fields

Field	Type	Description	Required
createdByInitials			YES
confirmationEmail			NO
dropOff			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "checkInId": "",
   "checkOutId": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "dropOff": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/check-in-record[/:check_in_record_id]"
       }
   }
   "checkInId": "",
   "checkOutId": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "dropOff": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

DELETE /service-center/check-in-record[/:check_in_record_id]

Deletes a record. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
createdByInitials			YES
confirmationEmail			NO
dropOff			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Status

GET /service-center/status

Fields

Field	Type	Description	Required
name			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/status

Fields

Field	Type	Description	Required
name			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /service-center/status[/:status_id]

Fields

Field	Type	Description	Required
name			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /service-center/status[/:status_id]

Fields

Field	Type	Description	Required
name			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

PATCH /service-center/status[/:status_id]

Fields

Field	Type	Description	Required
name			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

InadequateSupplyReport

GET /service-center/inadequate-supply-report

Fields

Field	Type	Description	Required
comment			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /service-center/inadequate-supply-report

Fields

Field	Type	Description	Required
comment			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /service-center/inadequate-supply-report[/:inadequate_supply_report_id]

Fields

Field	Type	Description	Required
comment			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

BlackoutDate

Maintains all of the dates that are not allowed for checking out or checking in equipment

GET /service-center/blackout-date

Returns a list of all the unavailable dates

Fields

Field	Type	Description	Required
date			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blackout-date"
       },
       "first": {
           "href": "/service-center/blackout-date?page={page}"
       },
       "prev": {
           "href": "/service-center/blackout-date?page={page}"
       },
       "next": {
           "href": "/service-center/blackout-date?page={page}"
       },
       "last": {
           "href": "/service-center/blackout-date?page={page}"
       }
   }
   "_embedded": {
       "blackout_date": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/blackout-date[/:blackout_date_id]"
                   }
               }
              "date": "",
              "blackoutDateId": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": ""
           }
       ]
   }
}

POST /service-center/blackout-date

Add a new unavailable date

Fields

Field	Type	Description	Required
date			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "date": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blackout-date[/:blackout_date_id]"
       }
   }
   "date": "",
   "blackoutDateId": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

DELETE /service-center/blackout-date[/:blackout_date_id]

Remove a date. A 201 response with no content is returned on success.

Fields

Field	Type	Description	Required
date			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

GET /service-center/category

Returns a list of all categories

Fields

Field	Type	Description	Required
name			YES
personalAllowed			NO
facultyAllowed			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/category"
       },
       "first": {
           "href": "/service-center/category?page={page}"
       },
       "prev": {
           "href": "/service-center/category?page={page}"
       },
       "next": {
           "href": "/service-center/category?page={page}"
       },
       "last": {
           "href": "/service-center/category?page={page}"
       }
   }
   "_embedded": {
       "category": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/category[/:category_id]"
                   }
               }
              "categoryId": "",
              "name": "",
              "personalAllowed": "",
              "facultyAllowed": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": ""
           }
       ]
   }
}

POST /service-center/category

Creates a new category

Fields

Field	Type	Description	Required
name			YES
personalAllowed			NO
facultyAllowed			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "categoryId": "",
   "name": "",
   "personalAllowed": "",
   "facultyAllowed": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/category[/:category_id]"
       }
   }
   "categoryId": "",
   "name": "",
   "personalAllowed": "",
   "facultyAllowed": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

GET /service-center/category[/:category_id]

Grabs a single category

Fields

Field	Type	Description	Required
name			YES
personalAllowed			NO
facultyAllowed			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/category[/:category_id]"
       }
   }
   "categoryId": "",
   "name": "",
   "personalAllowed": "",
   "facultyAllowed": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

PATCH /service-center/category[/:category_id]

Updates any number of fields for a category

Fields

Field	Type	Description	Required
name			YES
personalAllowed			NO
facultyAllowed			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "categoryId": "",
   "name": "",
   "personalAllowed": "",
   "facultyAllowed": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/category[/:category_id]"
       }
   }
   "categoryId": "",
   "name": "",
   "personalAllowed": "",
   "facultyAllowed": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

DELETE /service-center/category[/:category_id]

Deletes a category. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
name			YES
personalAllowed			NO
facultyAllowed			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Reservation

The Reservation service maintains a set or records that allow patrons to reserve equipment for checkout.

GET /service-center/reservation

Returns a list of records.

Fields

Field	Type	Description	Required
pickUp			YES
checkoutType			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			NO
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/reservation"
       },
       "first": {
           "href": "/service-center/reservation?page={page}"
       },
       "prev": {
           "href": "/service-center/reservation?page={page}"
       },
       "next": {
           "href": "/service-center/reservation?page={page}"
       },
       "last": {
           "href": "/service-center/reservation?page={page}"
       }
   }
   "_embedded": {
       "reservation": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/reservation[/:reservation_id]"
                   }
               }
              "reservationId": "",
              "userName": "",
              "firstName": "",
              "middleName": "",
              "lastName": "",
              "phoneNumber": "",
              "address": "",
              "emailAddress": "",
              "due": "",
              "createdByInitials": "",
              "confirmationEmail": "",
              "cancelled": "",
              "checkoutType": "",
              "pickUp": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": "",
              "notes": ""
           }
       ]
   }
}

POST /service-center/reservation

Creates a new record.

Fields

Field	Type	Description	Required
pickUp			YES
checkoutType			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			NO
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "reservationId": "",
   "userName": "",
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phoneNumber": "",
   "address": "",
   "emailAddress": "",
   "due": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "cancelled": "",
   "checkoutType": "",
   "pickUp": "",
   "notes": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/reservation[/:reservation_id]"
       }
   }
   "reservationId": "",
   "userName": "",
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phoneNumber": "",
   "address": "",
   "emailAddress": "",
   "due": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "cancelled": "",
   "checkoutType": "",
   "pickUp": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "notes": ""
}

GET /service-center/reservation[/:reservation_id]

Returns a single record.

Fields

Field	Type	Description	Required
pickUp			YES
checkoutType			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			NO
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/reservation[/:reservation_id]"
       }
   }
   "reservationId": "",
   "userName": "",
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phoneNumber": "",
   "address": "",
   "emailAddress": "",
   "due": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "cancelled": "",
   "checkoutType": "",
   "pickUp": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "notes": ""
}

PATCH /service-center/reservation[/:reservation_id]

Updates all fields provided for a record.

Fields

Field	Type	Description	Required
pickUp			YES
checkoutType			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			NO
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "reservationId": "",
   "userName": "",
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phoneNumber": "",
   "address": "",
   "emailAddress": "",
   "due": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "cancelled": "",
   "checkoutType": "",
   "pickUp": "",
   "notes": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/reservation[/:reservation_id]"
       }
   }
   "reservationId": "",
   "userName": "",
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phoneNumber": "",
   "address": "",
   "emailAddress": "",
   "due": "",
   "createdByInitials": "",
   "confirmationEmail": "",
   "cancelled": "",
   "checkoutType": "",
   "pickUp": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "notes": ""
}

DELETE /service-center/reservation[/:reservation_id]

Deletes a record. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
pickUp			YES
checkoutType			NO
userName			YES
firstName			NO
middleName			NO
lastName			NO
phoneNumber			YES
address			NO
emailAddress			YES
due			YES
createdByInitials			YES
confirmationEmail			NO
cancelled			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Equipment

The Equipment service maintains a set or records that record all of the equipment that is available for checkout.

GET /service-center/equipment

Returns a list of records.

Fields

Field	Type	Description	Required
name			YES
model			NO
serialNumber			NO
trumanTag			NO
abbreviation			NO
personalCheckoutAllowed			NO
facultyCheckoutAllowed			NO
purchased			NO
status			YES
storageLocation			NO
deliveredLocation			NO
archived			NO
category			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/equipment"
       },
       "first": {
           "href": "/service-center/equipment?page={page}"
       },
       "prev": {
           "href": "/service-center/equipment?page={page}"
       },
       "next": {
           "href": "/service-center/equipment?page={page}"
       },
       "last": {
           "href": "/service-center/equipment?page={page}"
       }
   }
   "_embedded": {
       "equipment": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/equipment[/:equipment_id]"
                   }
               }
              "equipmentId": "",
              "name": "",
              "model": "",
              "serialNumber": "",
              "trumanTag": "",
              "abbreviation": "",
              "personalCheckoutAllowed": "",
              "facultyCheckoutAllowed": "",
              "purchased": "",
              "status": "",
              "storageLocation": "",
              "deliveredLocation": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": "",
              "categoryId": ""
           }
       ]
   }
}

POST /service-center/equipment

Creates a new record.

Fields

Field	Type	Description	Required
name			YES
model			NO
serialNumber			NO
trumanTag			NO
abbreviation			NO
personalCheckoutAllowed			NO
facultyCheckoutAllowed			NO
purchased			NO
status			YES
storageLocation			NO
deliveredLocation			NO
archived			NO
category			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "equipmentId": "",
   "name": "",
   "model": "",
   "serialNumber": "",
   "trumanTag": "",
   "abbreviation": "",
   "personalCheckoutAllowed": "",
   "facultyCheckoutAllowed": "",
   "purchased": "",
   "status": "",
   "storageLocation": "",
   "deliveredLocation": "",
   "categoryId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/equipment[/:equipment_id]"
       }
   }
   "equipmentId": "",
   "name": "",
   "model": "",
   "serialNumber": "",
   "trumanTag": "",
   "abbreviation": "",
   "personalCheckoutAllowed": "",
   "facultyCheckoutAllowed": "",
   "purchased": "",
   "status": "",
   "storageLocation": "",
   "deliveredLocation": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "categoryId": ""
}

GET /service-center/equipment[/:equipment_id]

Returns a single record.

Fields

Field	Type	Description	Required
name			YES
model			NO
serialNumber			NO
trumanTag			NO
abbreviation			NO
personalCheckoutAllowed			NO
facultyCheckoutAllowed			NO
purchased			NO
status			YES
storageLocation			NO
deliveredLocation			NO
archived			NO
category			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/equipment[/:equipment_id]"
       }
   }
   "equipmentId": "",
   "name": "",
   "model": "",
   "serialNumber": "",
   "trumanTag": "",
   "abbreviation": "",
   "personalCheckoutAllowed": "",
   "facultyCheckoutAllowed": "",
   "purchased": "",
   "status": "",
   "storageLocation": "",
   "deliveredLocation": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "categoryId": ""
}

PATCH /service-center/equipment[/:equipment_id]

Updates all fields provided for a record.

Fields

Field	Type	Description	Required
name			YES
model			NO
serialNumber			NO
trumanTag			NO
abbreviation			NO
personalCheckoutAllowed			NO
facultyCheckoutAllowed			NO
purchased			NO
status			YES
storageLocation			NO
deliveredLocation			NO
archived			NO
category			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "equipmentId": "",
   "name": "",
   "model": "",
   "serialNumber": "",
   "trumanTag": "",
   "abbreviation": "",
   "personalCheckoutAllowed": "",
   "facultyCheckoutAllowed": "",
   "purchased": "",
   "status": "",
   "storageLocation": "",
   "deliveredLocation": "",
   "categoryId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/equipment[/:equipment_id]"
       }
   }
   "equipmentId": "",
   "name": "",
   "model": "",
   "serialNumber": "",
   "trumanTag": "",
   "abbreviation": "",
   "personalCheckoutAllowed": "",
   "facultyCheckoutAllowed": "",
   "purchased": "",
   "status": "",
   "storageLocation": "",
   "deliveredLocation": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": "",
   "categoryId": ""
}

DELETE /service-center/equipment[/:equipment_id]

Deletes a record. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
name			YES
model			NO
serialNumber			NO
trumanTag			NO
abbreviation			NO
personalCheckoutAllowed			NO
facultyCheckoutAllowed			NO
purchased			NO
status			YES
storageLocation			NO
deliveredLocation			NO
archived			NO
category			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Blacklist

The Blacklist service maintains a set or records that indicate who is not allowed to checkout equipment from the service center.

GET /service-center/blacklist

Returns a list of records.

Fields

Field	Type	Description	Required
userName			YES
reason			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blacklist"
       },
       "first": {
           "href": "/service-center/blacklist?page={page}"
       },
       "prev": {
           "href": "/service-center/blacklist?page={page}"
       },
       "next": {
           "href": "/service-center/blacklist?page={page}"
       },
       "last": {
           "href": "/service-center/blacklist?page={page}"
       }
   }
   "_embedded": {
       "blacklist": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/blacklist[/:blacklist_id]"
                   }
               }
              "userName": "",
              "reason": "",
              "blacklistId": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": ""
           }
       ]
   }
}

POST /service-center/blacklist

Creates a new Blacklist record.

Fields

Field	Type	Description	Required
userName			YES
reason			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "userName": "",
   "reason": "",
   "blacklistId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blacklist[/:blacklist_id]"
       }
   }
   "userName": "",
   "reason": "",
   "blacklistId": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

GET /service-center/blacklist[/:blacklist_id]

Returns a single record.

Fields

Field	Type	Description	Required
userName			YES
reason			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blacklist[/:blacklist_id]"
       }
   }
   "userName": "",
   "reason": "",
   "blacklistId": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

PATCH /service-center/blacklist[/:blacklist_id]

Updates all fields provided for a record.

Fields

Field	Type	Description	Required
userName			YES
reason			NO

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "userName": "",
   "reason": "",
   "blacklistId": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/blacklist[/:blacklist_id]"
       }
   }
   "userName": "",
   "reason": "",
   "blacklistId": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

DELETE /service-center/blacklist[/:blacklist_id]

Deletes a record. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
userName			YES
reason			NO

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

OperationalCheckRecord

The OperationalCheckRecord service maintains a set or records that indicate when each checked-in piece of equipment has been checked to ensure operational condition.

GET /service-center/operational-check-record

Returns a list of records.

Fields

Field	Type	Description	Required
notes			NO
complete			NO
checkedByInitials			NO
status			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/operational-check-record"
       },
       "first": {
           "href": "/service-center/operational-check-record?page={page}"
       },
       "prev": {
           "href": "/service-center/operational-check-record?page={page}"
       },
       "next": {
           "href": "/service-center/operational-check-record?page={page}"
       },
       "last": {
           "href": "/service-center/operational-check-record?page={page}"
       }
   }
   "_embedded": {
       "operational_check_record": [
           {
               "_links": {
                   "self": {
                       "href": "/service-center/operational-check-record[/:operational_check_record_id]"
                   }
               }
              "operationalCheckId": "",
              "equipmentId": "",
              "checkInId": "",
              "notes": "",
              "complete": "",
              "added": "",
              "addedBy": "",
              "lastModified": "",
              "lastModifiedBy": ""
           }
       ]
   }
}

POST /service-center/operational-check-record

Creates a new record. Requires an associated check-in record.

Fields

Field	Type	Description	Required
notes			NO
complete			NO
checkedByInitials			NO
status			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "operationalCheckId": "",
   "equipmentId": "",
   "checkInId": "",
   "notes": "",
   "complete": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/operational-check-record[/:operational_check_record_id]"
       }
   }
   "operationalCheckId": "",
   "equipmentId": "",
   "checkInId": "",
   "notes": "",
   "complete": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

GET /service-center/operational-check-record[/:operational_check_record_id]

Returns a single record.

Fields

Field	Type	Description	Required
notes			NO
complete			NO
checkedByInitials			NO
status			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/operational-check-record[/:operational_check_record_id]"
       }
   }
   "operationalCheckId": "",
   "equipmentId": "",
   "checkInId": "",
   "notes": "",
   "complete": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

PATCH /service-center/operational-check-record[/:operational_check_record_id]

Updates all fields provided for a record.

Fields

Field	Type	Description	Required
notes			NO
complete			NO
checkedByInitials			NO
status			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json
Content-Type	application/json

Body

{
   "operationalCheckId": "",
   "equipmentId": "",
   "checkInId": "",
   "notes": "",
   "complete": ""
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/service-center/operational-check-record[/:operational_check_record_id]"
       }
   }
   "operationalCheckId": "",
   "equipmentId": "",
   "checkInId": "",
   "notes": "",
   "complete": "",
   "added": "",
   "addedBy": "",
   "lastModified": "",
   "lastModifiedBy": ""
}

DELETE /service-center/operational-check-record[/:operational_check_record_id]

Deletes a record. There is no request body or response body. A 204 status is returned on success.

Fields

Field	Type	Description	Required
notes			NO
complete			NO
checkedByInitials			NO
status			NO
equipment			YES

Request

Headers

Header	Value
Accept	application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

OverdueCost

Calculates the overdue cost of a check out record

GET /service-center/overdue-cost[/:checkout_id]

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "businessHours": "",
    "offHours": "",
    "totalCost": ""
}

LastEquipmentCheckOut

GET /service-center/last-equipment-check-out/:equipment_id

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

EquipmentCheckOut

GET /service-center/equipment/:equipment_id/check-out

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

CategoryReport

GET /service-center/category-report[/:category_id]

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

EquipmentOperationalCheckRecords

GET /service/center/equipment/:equipment_id/operational-check-record[/:operational_check_record_id]

Request

Headers

Header	Value
Accept	application/vnd.service-center.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.service-center.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Documentation

ServiceCenter (v1)

ReservationEquipment

GET /service-center/reservation/:reservation_id/equipment

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /service-center/reservation/:reservation_id/equipment

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

DELETE /service-center/reservation/:reservation_id/equipment[/:equipment_id]

Fields

Request

Headers

Response

Status Codes

Headers

GET /service-center/reservation/:reservation_id/equipment[/:equipment_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

CheckOutEquipment

GET /service-center/check-out/:check_out_id/equipment

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /service-center/check-out/:check_out_id/equipment

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

DELETE /service-center/check-out/:check_out_id/equipment[/:equipment_id]

Fields

Request

Headers

Response

Status Codes

Headers

GET /service-center/check-out/:check_out_id/equipment[/:equipment_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

CheckInEquipment

GET /service-center/check-in/:check_in_id/equipment

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /service-center/check-in/:check_in_id/equipment

Fields

Request