Assignments API

v1.0 • REST • JSON

Full CRUD management for assignment accounts. Create, retrieve, update, and delete assignment records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/assignments

Quick Reference

GET
/api/assignments List all assignments (paginated)
200 GET
/api/assignments/{id} Get one assignment by ID
200 POST
/api/assignments Create a new assignment
201 PUT
/api/assignments/{id} Replace assignment data
204 DEL
/api/assignments/{id} Remove a assignment
204 GET
/api/assignments/{id} Assignment not found example
404
GET /api/assignments 200 OK

Get All Assignments

Retrieves a paginated list of all assignments in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/assignments/{id} 200 OK

Get Single Assignment

Fetch the full profile for a specific assignment using their numeric ID. Returns all assignment fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique assignment identifier
Response: 200 OK
GET /api/assignments/{id} 404 Not Found

Assignment Not Found

Returned when the requested assignment ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing assignment resources.

Response: 404 Not Found 
{}
POST /api/assignments 201 Created

Create Assignment

Registers a new assignment with the provided details. On success, returns the newly created assignment object — including the auto-generated ID, timestamp, and resolved role names.

Request Body
FieldTypeRequiredDescription
firstName string Required Assignment's given name
lastName string Required Assignment's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /api/assignments/{id} 200 OK

Update Assignment

Fully replaces an existing assignment's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /api/assignments/{id} 204 No Content

Delete Assignment

Permanently removes a assignment from the system by their ID. This action is irreversible — once deleted, the assignment record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the assignment to delete
Response: 204 No Content 
{}