nss-cohort-37 / bangazon-api-green-monkeys Goto Github PK

Implement the following endpoints

* Order objects that have a payment method that isn't NULL are considered complete and processed. An order that does not have a payment type would be considered a user's shopping cart. A user can have only one shopping cart, and therefore will only have a maximum of one Order record in the database with a NULL payment type at a given time.

** To purchase an order, update the Order object's userPaymentId property

JSON Order Object

{
    "id": 1575559407665,
    "customerId": 1575559407787,
    "userPaymentId": null
}

JSON CustomerProduct Object

{
    "customerId": 1575559407787,
    "productId": 1575501970208
}

Implement the following endpoints

JSON Product Object

{
    "id": 15755594079867,
    "productTypeId": 1575501970045,
    "customerId": 1575559407755,
    "price": 62.54,
    "description": "pede ullamcorper augue a suscipit nulla elit ac nulla sed",
    "title": "Murciélago LP640",
    "dateAdded": "2018-12-25T00:00:00.000Z"
}

NOTES

• If the query string parameter ?sortBy=recent is provided in the URL when querying a list of products, then all of the products that were most recently created should appear first.
• If the query string parameter q is provided in the URL when querying a list of products, then all of the products whose Title or Description includes the search parameter should be returned.
  For example: If the query string parameter ?q=tank is provided in the URL when querying a list of products, then all products that have the word "tank" in their title or description should be returned.
• When a new product gets added, the DateAdded property should be set by the server to the current DateTime

Swagger documentation should be included for each endpoint

Implement the following endpoints

JSON Department Object

{
    "id": 1575559403194,
    "name": "Accounting",
    "budget": 1230000
}

Implement the following endpoint

JSON RevenueReport Object

{
    "productTypeId": 1575501970829,
    "productType": "Filters",
    "totalRevenue": 158.64
}

Implement the following endpoints

JSON TrainingProgram Object

{
    "id": 1575559403194,
    "name": "GIS Application",
    "startDate": "2020-09-25T00:00:00.000Z",
    "endDate": "2020-10-05T00:00:00.000Z",
    "maxAttendees": 45
}

NOTES

• The api/trainingPrograms route should only include training programs that are upcoming. It should not include any programs in the past
• When getting a single training program by Id, the json response should always include the list of employees that are currently enrolled in the program.
• When added a new training program, the start date must be in the future and the end date must be after the start date

Implement the following endpoints

***This should be a soft delete. Meaning you should not actually delete the customer from the database. There is an Active column on the customer table that should be set to false.

JSON Customer Object

{
    "id": 1575559407787,
    "active": true,
    "createdDate": "2019-08-25T00:00:00.000Z",
    "firstName": "Nathanael",
    "lastName": "Laverenz",
    "address": "401 Nunya Business Dr",
    "city": "Herman",
    "state": "New York",
    "email": "[email protected]",
    "phone": "6151237584"
}

NOTES

• Results from GET requests should not include customers that have been soft deleted.
• If the query string parameter of q is provided when querying the list of customers, then any customer that has a first or last name that matches the pattern should be returned. For example: If /customers?q=mic is requested, then any customer whose first name is Michelle, or Michael, or Domicio should be returned. Any customer whose last name is Michaelangelo, or Omici, Dibromic should be returned.
• When a new customer is being added, the customer's DateCreated property should be set to the current DateTime

Implement the following endpoints

JSON ProductType Object

{
    "id": 1575501970045,
    "name": "Accessories"
}

Update, and use, a CORS policy that only allows requests from the http://bangazon.com domain.

Ref: https://docs.microsoft.com/en-us/aspnet/core/security/cors

Update the /api/products endpoint to support these additional query parameters

Implement the following endpoints

JSON Employee Object

{
      "id": 1575501974624,
      "firstName": "Adam",
      "lastName": "Sheaffer",
      "departmentId": 1575559403192,
      "isSupervisor": false,
      "computerId": 1575566566333,
      "email": "[email protected]"
}

JSON Employee Object w/ Computer

{
      "id": 1575501974624,
      "firstName": "Adam",
      "lastName": "Sheaffer",
      "departmentId": 1575559403192,
      "isSupervisor": false,
      "computerId": 1575566566333,
      "computer": {
            "id": 1575566566333,
            "purchaseDate": "2016-01-01T23:28:56.782Z",
            "decomissionDate": null,
            "make": "Apple",
            "model": "Macbook Pro"
      },
      "email": "[email protected]"
}

NOTES

• When getting a single employee by Id, the employee's computer should always be included in the json response

Stretch: Update the api/products endpoint to support the following query parameter

NOTES

• popularity should be determined by how many times a product has been ordered

Implement the following endpoints

***This should be a soft delete. Instead of deleting a payment type record from the database, the payment type's Active property should be changed to False

JSON PaymentType Object

{
    "id": 1575501974871,
    "name": "Mastercard",
    "active": true
}

NOTES

• Any payment types that have been soft deleted should not show up when making a GET request.

Implement the following endpoints

JSON Computer Object

{
    "id": 1575566566333,
    "purchaseDate": "2016-01-01T23:28:56.782Z",
    "decomissionDate": null,
    "make": "Apple",
    "model": "Macbook Pro"
}

NOTES

• A computer is considered available if it is not currently assigned to an employee and it does not have a DecomissionDate
• A computer cannot be deleted if it is currently assigned to an employee. If a user tries to delete a computer that is assigned to an employee, the API should return a 403 Forbidden status code

Implement the following endpoints

***This should be a soft delete. Meaning you should not actually delete the customer from the database. There is an Active column on the UserPaymentType table that should be set to False.

JSON UserPaymentType Object

{
    "id": 1575501978463,
    "customerId": 1575559407787,
    "paymentTypeId": 1575501974871,
    "acctNumber": "2234 56789 0123",
    "active": true
}

NOTES

• Records that have been soft deleted should not be included in results when making GET requests