AllowedUser

Users allowed to access the residential life hall desk services

GET /reslife/halldesk/allowed-user

Returns a list of users

Fields

Field Type Description Required
userName YES
building NO

Request

Headers

Header Value
Accept
application/vnd.residential-life.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.residential-life.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/reslife/halldesk/allowed-user"
       },
       "first": {
           "href": "/reslife/halldesk/allowed-user?page={page}"
       },
       "prev": {
           "href": "/reslife/halldesk/allowed-user?page={page}"
       },
       "next": {
           "href": "/reslife/halldesk/allowed-user?page={page}"
       },
       "last": {
           "href": "/reslife/halldesk/allowed-user?page={page}"
       }
   }
   "_embedded": {
       "allowed_user": [
           {
               "_links": {
                   "self": {
                       "href": "/reslife/halldesk/allowed-user[/:allowed_user_id]"
                   }
               }
              "userName": "",
              "building": "",
              "id": ""
           }
       ]
   }
}

POST /reslife/halldesk/allowed-user

Create a new allowed user record

Fields

Field Type Description Required
userName YES
building NO

Request

Headers

Header Value
Accept
application/vnd.residential-life.v1+json
application/hal+json
application/json
Content-Type
application/vnd.residential-life.v1+json
application/json

Body

{
   "userName": "",
   "building": ""
}

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.residential-life.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/reslife/halldesk/allowed-user[/:allowed_user_id]"
       }
   }
   "userName": "",
   "building": "",
   "id": ""
}

GET /reslife/halldesk/allowed-user[/:allowed_user_id]

Returns a single allowed user record

Fields

Field Type Description Required
userName YES
building NO

Request

Headers

Header Value
Accept
application/vnd.residential-life.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.residential-life.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/reslife/halldesk/allowed-user[/:allowed_user_id]"
       }
   }
   "userName": "",
   "building": "",
   "id": ""
}

PATCH /reslife/halldesk/allowed-user[/:allowed_user_id]

Updates a single allowed user record. You can update any number of fields

Fields

Field Type Description Required
userName YES
building NO

Request

Headers

Header Value
Accept
application/vnd.residential-life.v1+json
application/hal+json
application/json
Content-Type
application/vnd.residential-life.v1+json
application/json

Body

{
   "userName": "",
   "building": ""
}

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/vnd.residential-life.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/reslife/halldesk/allowed-user[/:allowed_user_id]"
       }
   }
   "userName": "",
   "building": "",
   "id": ""
}

DELETE /reslife/halldesk/allowed-user[/:allowed_user_id]

Removes a single allowed user record

Fields

Field Type Description Required
userName YES
building NO

Request

Headers

Header Value
Accept
application/vnd.residential-life.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.residential-life.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Package

GET /reslife/halldesk/package

Retrieve multiple package records

Fields

Field Type Description Required
description YES
createdByInitials YES
received Date and time the package was received (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
receivedByInitials Initials of the staff member that received the package NO
pickedUp Date and time the package was picked up (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
pickedUpByInitials Initials of the staff member that released the package NO
nameOnPackage NO
addressOnPackage NO
carrier NO
forwardingReason NO
forwardingInstructions NO
mailServicesStaffInitials NO
resident Associated resident's ID 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": "https://local.api.truman.edu/reslife/halldesk/package?page=1"
    },
    "first": {
      "href": "https://local.api.truman.edu/reslife/halldesk/package"
    },
    "last": {
      "href": "https://local.api.truman.edu/reslife/halldesk/package?page=1"
    }
  },
  "_embedded": {
    "package": [
      {
        "id": 31,
        "description": "package A",
        "createdByInitials": "JAE",
        "received": {
          "date": "2016-09-07 18:55:43.000000",
          "timezone_type": 3,
          "timezone": "America/Chicago"
        },
        "receivedByInitials": "JAE",
        "pickedUp": {
          "date": "2016-09-07 20:52:07.000000",
          "timezone_type": 3,
          "timezone": "America/Chicago"
        },
        "pickedUpByInitials": "jae",
        "nameOnPackage": null,
        "addressOnPackage": null,
        "forwardingInstructions": null,
        "mailServicesStaffInitials": null,
        "carrier": null,
        "fowardingReason": null,
        "_embedded": {
          "resident": {
            "id": 4,
            "userName": null,
            "firstName": null,
            "lastName": null,
            "name": "",
            "phone": "",
            "email": "",
            "code": "",
            "address": null,
            "addressLineTwo": null,
            "city": null,
            "state": null,
            "zip": null,
            "importedFromBanner": true,
            "tempCard": null,
            "tempEmail": null,
            "building": "BN",
            "room": "1100",
            "added": {
              "date": "-0001-11-30 00:00:00.000000",
              "timezone_type": 3,
              "timezone": "America/Chicago"
            },
            "addedBy": "banner",
            "lastModified": {
              "date": "2016-09-16 00:00:00.000000",
              "timezone_type": 3,
              "timezone": "America/Chicago"
            },
            "lastModifiedBy": "banner",
            "nightLogEntries": {},
            "packages": {},
            "_links": {
              "self": {
                "href": "https://local.api.truman.edu/reslife/halldesk/resident/4"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://local.api.truman.edu/reslife/halldesk/package/31"
          }
        }
      },
    ]
  },
  "page_count": 1,
  "page_size": 25,
  "total_items": 1,
  "page": 1
}

POST /reslife/halldesk/package

Create a new package record

Fields

Field Type Description Required
description YES
createdByInitials YES
received Date and time the package was received (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
receivedByInitials Initials of the staff member that received the package NO
pickedUp Date and time the package was picked up (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
pickedUpByInitials Initials of the staff member that released the package NO
nameOnPackage NO
addressOnPackage NO
carrier NO
forwardingReason NO
forwardingInstructions NO
mailServicesStaffInitials NO
resident Associated resident's ID 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 /reslife/halldesk/package[/:package_id]

Retrieve a single package record

Fields

Field Type Description Required
description YES
createdByInitials YES
received Date and time the package was received (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
receivedByInitials Initials of the staff member that received the package NO
pickedUp Date and time the package was picked up (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
pickedUpByInitials Initials of the staff member that released the package NO
nameOnPackage NO
addressOnPackage NO
carrier NO
forwardingReason NO
forwardingInstructions NO
mailServicesStaffInitials NO
resident Associated resident's ID 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

{
  "id": 31,
  "description": "package A",
  "createdByInitials": "JAE",
  "received": {
    "date": "2016-09-07 18:55:43.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "receivedByInitials": "JAE",
  "pickedUp": {
    "date": "2016-09-07 20:52:07.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "pickedUpByInitials": "jae",
  "nameOnPackage": null,
  "addressOnPackage": null,
  "forwardingInstructions": null,
  "mailServicesStaffInitials": null,
  "carrier": null,
  "fowardingReason": null,
  "_embedded": {
    "resident": {
      "id": 4,
      "userName": null,
      "firstName": null,
      "lastName": null,
      "name": "",
      "phone": "",
      "email": "",
      "code": "",
      "address": null,
      "addressLineTwo": null,
      "city": null,
      "state": null,
      "zip": null,
      "importedFromBanner": true,
      "tempCard": null,
      "tempEmail": null,
      "building": "BN",
      "room": "1100",
      "added": {
        "date": "-0001-11-30 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "America/Chicago"
      },
      "addedBy": "banner",
      "lastModified": {
        "date": "2016-09-16 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "America/Chicago"
      },
      "lastModifiedBy": "banner",
      "nightLogEntries": {},
      "packages": {},
      "_links": {
        "self": {
          "href": "https://local.api.truman.edu/reslife/halldesk/resident/4"
        }
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/package/31"
    }
  }
}

PATCH /reslife/halldesk/package[/:package_id]

Update a package record

Fields

Field Type Description Required
description YES
createdByInitials YES
received Date and time the package was received (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
receivedByInitials Initials of the staff member that received the package NO
pickedUp Date and time the package was picked up (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
pickedUpByInitials Initials of the staff member that released the package NO
nameOnPackage NO
addressOnPackage NO
carrier NO
forwardingReason NO
forwardingInstructions NO
mailServicesStaffInitials NO
resident Associated resident's ID 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 /reslife/halldesk/package[/:package_id]

Delete a package record

Fields

Field Type Description Required
description YES
createdByInitials YES
received Date and time the package was received (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
receivedByInitials Initials of the staff member that received the package NO
pickedUp Date and time the package was picked up (yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\') NO
pickedUpByInitials Initials of the staff member that released the package NO
nameOnPackage NO
addressOnPackage NO
carrier NO
forwardingReason NO
forwardingInstructions NO
mailServicesStaffInitials NO
resident Associated resident's ID 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

CashCountRecord

GET /reslife/halldesk/cash-count

Fields

Field Type Description Required
lastName NO
firstName NO
userName YES
pennies NO
nickels NO
dimes NO
quarters NO
ones NO
fives NO
tens NO
largeBills NO
stamps NO
total NO
building YES
in Toggles the record from a cash count in and cash count out. Assign a true value to set the record as a cash count in when coming on shift. 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 /reslife/halldesk/cash-count

Fields

Field Type Description Required
lastName NO
firstName NO
userName YES
pennies NO
nickels NO
dimes NO
quarters NO
ones NO
fives NO
tens NO
largeBills NO
stamps NO
total NO
building YES
in Toggles the record from a cash count in and cash count out. Assign a true value to set the record as a cash count in when coming on shift. 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 /reslife/halldesk/cash-count[/:cash_count_record_id]

Fields

Field Type Description Required
lastName NO
firstName NO
userName YES
pennies NO
nickels NO
dimes NO
quarters NO
ones NO
fives NO
tens NO
largeBills NO
stamps NO
total NO
building YES
in Toggles the record from a cash count in and cash count out. Assign a true value to set the record as a cash count in when coming on shift. 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 /reslife/halldesk/cash-count[/:cash_count_record_id]

Fields

Field Type Description Required
lastName NO
firstName NO
userName YES
pennies NO
nickels NO
dimes NO
quarters NO
ones NO
fives NO
tens NO
largeBills NO
stamps NO
total NO
building YES
in Toggles the record from a cash count in and cash count out. Assign a true value to set the record as a cash count in when coming on shift. 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 /reslife/halldesk/cash-count[/:cash_count_record_id]

Fields

Field Type Description Required
lastName NO
firstName NO
userName YES
pennies NO
nickels NO
dimes NO
quarters NO
ones NO
fives NO
tens NO
largeBills NO
stamps NO
total NO
building YES
in Toggles the record from a cash count in and cash count out. Assign a true value to set the record as a cash count in when coming on shift. 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

Resident

GET /reslife/halldesk/resident

Fields

Field Type Description Required
bannerId YES
name NO
phone NO
email NO
code NO
address NO
addressLineTwo NO
city NO
tempCard NO
tempBannerId NO
tempEmail NO
building NO
room NO
state NO
zip NO
userName NO
firstName NO
lastName 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 /reslife/halldesk/resident

Fields

Field Type Description Required
bannerId YES
name NO
phone NO
email NO
code NO
address NO
addressLineTwo NO
city NO
tempCard NO
tempBannerId NO
tempEmail NO
building NO
room NO
state NO
zip NO
userName NO
firstName NO
lastName 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 /reslife/halldesk/resident[/:resident_id]

Fields

Field Type Description Required
bannerId YES
name NO
phone NO
email NO
code NO
address NO
addressLineTwo NO
city NO
tempCard NO
tempBannerId NO
tempEmail NO
building NO
room NO
state NO
zip NO
userName NO
firstName NO
lastName 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 /reslife/halldesk/resident[/:resident_id]

Fields

Field Type Description Required
bannerId YES
name NO
phone NO
email NO
code NO
address NO
addressLineTwo NO
city NO
tempCard NO
tempBannerId NO
tempEmail NO
building NO
room NO
state NO
zip NO
userName NO
firstName NO
lastName 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 /reslife/halldesk/resident[/:resident_id]

Fields

Field Type Description Required
bannerId YES
name NO
phone NO
email NO
code NO
address NO
addressLineTwo NO
city NO
tempCard NO
tempBannerId NO
tempEmail NO
building NO
room NO
state NO
zip NO
userName NO
firstName NO
lastName 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

NightLogEntry

Residential life hall desk night log entries

GET /reslife/halldesk/night-log-entry

Retrieve a collection of night log entries

Fields

Field Type Description Required
firstName YES
middleName NO
lastName YES
phone NO
email YES
building YES
room YES
code YES
buildingVisited YES
cameInAt YES
createdByInitials 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": "https://local.api.truman.edu/reslife/halldesk/night-log-entry?page=1"
    },
    "first": {
      "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry"
    },
    "last": {
      "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry?page=1"
    }
  },
  "_embedded": {
    "night_log_entry": [
      {
        "id": 1,
        "firstName": "Shawn",
        "middleName": null,
        "lastName": "Mendes",
        "phone": null,
        "email": "sm@example.com",
        "building": "Missouri Hall",
        "room": "1234",
        "code": "AT",
        "buildingVisited": "Missouri Hall",
        "cameInAt": {
          "date": "2016-09-22 08:10:00.000000",
          "timezone_type": 3,
          "timezone": "America/Chicago"
        },
        "createdByInitials": "cmk",
        "added": {
          "date": "2016-09-22 08:11:10.000000",
          "timezone_type": 3,
          "timezone": "America/Chicago"
        },
        "addedBy": null,
        "lastModified": {
          "date": "2016-09-22 08:11:10.000000",
          "timezone_type": 3,
          "timezone": "America/Chicago"
        },
        "lastModifiedBy": null,
        "host": null,
        "_links": {
          "self": {
            "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry/1"
          }
        }
      }
    ]
  },
  "page_count": 1,
  "page_size": 25,
  "total_items": 1,
  "page": 1
}

POST /reslife/halldesk/night-log-entry

Create a new visitor log entry

Fields

Field Type Description Required
firstName YES
middleName NO
lastName YES
phone NO
email YES
building YES
room YES
code YES
buildingVisited YES
cameInAt YES
createdByInitials YES

Request

Headers

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

Body

{
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phone": "",
   "email": "",
   "building": "",
   "room": "",
   "code": "",
   "buildingVisited": "",
   "cameInAt": "",
   "createdByInitials": ""
}

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

{
  "id": 1,
  "firstName": "Shawn",
  "middleName": null,
  "lastName": "Mendes",
  "phone": null,
  "email": "sm@example.com",
  "building": "Missouri Hall",
  "room": "1234",
  "code": "AT",
  "buildingVisited": "Missouri Hall",
  "cameInAt": {
    "date": "2016-09-22 08:10:00.000000",
    "timezone_type": 2,
    "timezone": "Z"
  },
  "createdByInitials": "cmk",
  "added": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "addedBy": null,
  "lastModified": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "lastModifiedBy": null,
  "host": null,
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry/1"
    }
  }
}

GET /reslife/halldesk/night-log-entry[/:night_log_entry_id]

Retrieve a single night log entry

Fields

Field Type Description Required
firstName YES
middleName NO
lastName YES
phone NO
email YES
building YES
room YES
code YES
buildingVisited YES
cameInAt YES
createdByInitials 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

{
  "id": 1,
  "firstName": "Shawn",
  "middleName": null,
  "lastName": "Mendes",
  "phone": null,
  "email": "sm@example.com",
  "building": "Missouri Hall",
  "room": "1234",
  "code": "AT",
  "buildingVisited": "Missouri Hall",
  "cameInAt": {
    "date": "2016-09-22 08:10:00.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "createdByInitials": "cmk",
  "added": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "addedBy": null,
  "lastModified": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "lastModifiedBy": null,
  "host": null,
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry/1"
    }
  }
}

PATCH /reslife/halldesk/night-log-entry[/:night_log_entry_id]

Updates an arbitrary number of fields in an existing night log entry

Fields

Field Type Description Required
firstName YES
middleName NO
lastName YES
phone NO
email YES
building YES
room YES
code YES
buildingVisited YES
cameInAt YES
createdByInitials YES

Request

Headers

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

Body

{
   "firstName": "",
   "middleName": "",
   "lastName": "",
   "phone": "",
   "email": "",
   "building": "",
   "room": "",
   "code": "",
   "buildingVisited": "",
   "cameInAt": "",
   "createdByInitials": ""
}

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

{
  "id": 1,
  "firstName": "Shawn",
  "middleName": null,
  "lastName": "Mendes",
  "phone": "(555) 555-5555",
  "email": "sm@example.com",
  "building": "Missouri Hall",
  "room": "1234",
  "code": "AT",
  "buildingVisited": "Missouri Hall",
  "cameInAt": {
    "date": "2016-09-22 08:10:00.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "createdByInitials": "cmk",
  "added": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "addedBy": null,
  "lastModified": {
    "date": "2016-09-22 08:11:10.000000",
    "timezone_type": 3,
    "timezone": "America/Chicago"
  },
  "lastModifiedBy": null,
  "host": null,
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/night-log-entry/1"
    }
  }
}

ForwardingReason

Reasons a package is forwarded

GET /reslife/halldesk/forwarding-reason

Fields

Field Type Description Required
description 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": "https://local.api.truman.edu/reslife/halldesk/forwarding-reason?page=1"
    },
    "first": {
      "href": "https://local.api.truman.edu/reslife/halldesk/forwarding-reason"
    },
    "last": {
      "href": "https://local.api.truman.edu/reslife/halldesk/forwarding-reason?page=1"
    }
  },
  "_embedded": {
    "forwarding_reason": [
      {
        "id": 1,
        "description": "Delivered to Wrong Hall",
        "_links": {
          "self": {
            "href": "https://local.api.truman.edu/reslife/halldesk/forwarding-reason/1"
          }
        }
      }
    ]
  },
  "page_count": 1,
  "page_size": 25,
  "total_items": 3,
  "page": 1
}

GET /reslife/halldesk/forwarding-reason[/:forwarding_reason_id]

Fields

Field Type Description Required
description 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

{
  "id": 1,
  "description": "Delivered to Wrong Hall",
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/forwarding-reason/1"
    }
  }
}

Carrier

GET /reslife/halldesk/carrier

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

{
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/carrier?page=1"
    },
    "first": {
      "href": "https://local.api.truman.edu/reslife/halldesk/carrier"
    },
    "last": {
      "href": "https://local.api.truman.edu/reslife/halldesk/carrier?page=1"
    }
  },
  "_embedded": {
    "carrier": [
      {
        "id": 1,
        "name": "DHL",
        "packages": {},
        "_links": {
          "self": {
            "href": "https://local.api.truman.edu/reslife/halldesk/carrier/1"
          }
        }
      }
    ]
  },
  "page_count": 1,
  "page_size": 25,
  "total_items": 4,
  "page": 1
}

GET /reslife/halldesk/carrier[/:carrier_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

{
  "id": 1,
  "name": "DHL",
  "packages": {},
  "_links": {
    "self": {
      "href": "https://local.api.truman.edu/reslife/halldesk/carrier/1"
    }
  }
}

ToDoListItem

GET /reslife/halldesk/todo-list-item

Fields

Field Type Description Required
description YES
orderWeight 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 /reslife/halldesk/todo-list-item

Fields

Field Type Description Required
description YES
orderWeight 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 /reslife/halldesk/todo-list-item[/:to_do_list_item_id]

Fields

Field Type Description Required
description YES
orderWeight 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 /reslife/halldesk/todo-list-item[/:to_do_list_item_id]

Fields

Field Type Description Required
description YES
orderWeight 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 /reslife/halldesk/todo-list-item[/:to_do_list_item_id]

Fields

Field Type Description Required
description YES
orderWeight 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