API Specification

Below is a breakdown of ORM Core API spec.

Be sure to check out the Swagger docs for interactive documentation.

---

Path	Method	Summary
/accounts	POST	Create/Update/Restore account.
/accounts	DELETE	Delete an account.
/accounts	GET	List accounts in a paginated format.
/accounts	PATCH	Update an account.
/accounts/course	DELETE	Detach Course from Account.
/accounts/course	POST	Assign Course to Account.
/accounts/department	POST	Assign Department to Account.
/accounts/department	DELETE	Detach Department from Account.
/accounts/duty	DELETE	Detach Duty from Account.
/accounts/duty	POST	Assign Duty to Account.
/accounts/identifier/{identifier}	GET	Show an Account by Identifier
/accounts/load-status/code/{code}	GET	List accounts with the specified load status code in a paginated format.
/accounts/load-status/{id}	GET	List accounts with the specified load status in a paginated format.
/accounts/room	DELETE	Detach Room from Account.
/accounts/room	POST	Assign Room to Account.
/accounts/school	POST	Assign Account to School.
/accounts/school	DELETE	Detach Account from School.
/accounts/username/{username}	GET	Show an Account by Username
/accounts/{id}	GET	Show an Account by ID
/addresses	GET	List Addresses in a paginated format.
/addresses	POST	Create Address.
/addresses	DELETE	Delete an Address.
/addresses/account/{id}	GET	Show all Addresses owned by Account.
/addresses/identifier/{identifier}	GET	Show all Addresses owned by Account by Identifier.
/addresses/username/{username}	GET	Show all Addresses owned by Account by Username.
/addresses/{id}	GET	Show an Address by ID.
/alias-accounts	DELETE	Delete an alias account.
/alias-accounts	GET	List alias accounts in a paginated format.
/alias-accounts	POST	Create/Update/Restore alias account.
/alias-accounts/username/{username}	GET	Show an alias account by Username
/alias-accounts/{id}	GET	Show an alias account by ID
/auth	POST	Authenticate with API using Secret.
/auth/login	POST	Authenticate with API using credentials.
/auth/validate	GET	Verify authenticated session.
/buildings	DELETE	Delete a building.
/buildings	GET	List Buildings in a paginated format.
/buildings	POST	Create/Update/Restore Building.
/buildings/code/{code}	GET	Show a Building by Code.
/buildings/{id}	GET	Show a Building by ID.
/campuses	GET	List campuses in a paginated format.
/campuses	POST	Create/Update/Restore Campus.
/campuses	DELETE	Delete a Campus.
/campuses/code/{code}	GET	Show a Campus by Code.
/campuses/{id}	GET	Show a Campus by ID.
/countries	DELETE	Delete a Country.
/countries	GET	List Countries in a paginated format.
/countries	POST	Create/Update/Restore Country.
/countries/code/{code}	GET	Show a Country by Code.
/countries/{id}	GET	Show a Country by ID.
/courses	POST	Create/Update/Restore Course.
/courses	GET	List Courses in a paginated format.
/courses	DELETE	Delete a Course.
/courses/code/{code}	GET	Show a Course by Code.
/courses/{id}	GET	Show a Course by ID.
/departments	DELETE	Delete a Department.
/departments	POST	Create/Update/Restore Department.
/departments	GET	List Departments in a paginated format.
/departments/code/{code}	GET	Show a Department by Code.
/departments/{id}	GET	Show a Department by ID.
/duties	POST	Create/Update/Restore Duty.
/duties	DELETE	Delete a Duty.
/duties	GET	List Duties in a paginated format.
/duties/account/{id}	GET	Show a list of Duties that an account is a member of.
/duties/code/{code}	GET	Show a Duty by Code.
/duties/identifier/{identifier}	GET	Show a list of Duties that an account is a member of.
/duties/username/{username}	GET	Show a list of Duties that an account is a member of.
/duties/{id}	GET	Show a Duty by ID.
/emails	DELETE	Delete an Email.
/emails	GET	List Emails in a paginated format.
/emails	POST	Create/Update/Restore Email.
/emails/account/{id}	GET	Show all Email's owned by Account.
/emails/address/{address}	GET	Show a Email by Address.
/emails/identifier/{identifier}	GET	Show all Email's owned by Account by Identifier.
/emails/unverified	GET	List of unverified Emails in a paginated format.
/emails/unverified/account/{id}	GET	List of unverified Emails in a paginated format that are owned by the specified account.
/emails/username/{username}	GET	Show all Email's owned by Account by Username.
/emails/verified	GET	List of verified Emails in a paginated format.
/emails/verified/account/{id}	GET	List of verified Emails in a paginated format that are owned by the specified account.
/emails/{id}	GET	Show an Email by ID.
/load-status/code/{code}	GET	Show a Load Status by Code.
/load-statuses	DELETE	Delete a Load Status type.
/load-statuses	POST	Create/Update/Restore Load Status.
/load-statuses	GET	List the available Load Status types.
/load-statuses/{id}	GET	Show a Load Status by ID.
/mobile-carriers	POST	Create/Update/Restore Mobile Carrier.
/mobile-carriers	GET	List MobileCarriers in a paginated format.
/mobile-carriers	DELETE	Delete a Mobile Carrier.
/mobile-carriers/code/{code}	GET	Show a Mobile Carrier by Code.
/mobile-carriers/{id}	GET	Show a Mobile Carrier by ID.
/mobile-phones	GET	List Mobile Phones in a paginated format.
/mobile-phones	DELETE	Delete an Mobile Phone.
/mobile-phones	POST	Create/Update/Restore Mobile Phone.
/mobile-phones/account/{id}	GET	Show all Mobile Phone's owned by Account.
/mobile-phones/identifier/{identifier}	GET	Show all Mobile Phone's owned by Account by Identifier.
/mobile-phones/mobile-carrier/code/{code}	GET	List of Mobile Phones by Mobile Carrier Code.
/mobile-phones/mobile-carrier/id/{id}	GET	List of Mobile Phones by Mobile Carrier ID.
/mobile-phones/unverified	GET	List of unverified Mobile Phones in a paginated format.
/mobile-phones/unverified/account/{id}	GET	List of unverified Mobile Phones in a paginated format owned by an account.
/mobile-phones/username/{username}	GET	Show all Mobile Phone's owned by Account by Username.
/mobile-phones/verified	GET	List of verified Mobile Phones in a paginated format.
/mobile-phones/verified/account/{id}	GET	List of verified Mobile Phones that an account owns in a paginated format.
/mobile-phones/{id}	GET	Show an Mobile Phone by ID.
/rooms	GET	List Rooms in a paginated format.
/rooms	POST	Create/Update/Restore Room.
/rooms	DELETE	Delete a Room.
/rooms/code/{code}	GET	Show a Room by Code.
/rooms/{id}	GET	Show a Room by ID.
/school/code/{code}	GET	Show a School by Code.
/schools	DELETE	Delete a School.
/schools	POST	Create/Update/Restore School.
/schools	GET	List Schools in a paginated format.
/schools/{id}	GET	Show a School by ID.
/service-accounts	GET	List service accounts in a paginated format.
/service-accounts	DELETE	Delete an service account.
/service-accounts	POST	Create/Update/Restore service account.
/service-accounts/identifier/{identifier}	GET	Show an service account by Identifier
/service-accounts/username/{username}	GET	Show an service account by Username
/service-accounts/{id}	GET	Show an service account by ID
/states	DELETE	Delete a State.
/states	GET	List States in a paginated format.
/states	POST	Create/Update/Restore State.
/states/code/{code}	GET	Show a State by Code.
/states/{id}	GET	Show a State by ID.
/verify	POST	Verify Email or Mobile Phone.
/verify/{token}	GET	Verify Email or Mobile Phone.