Introduction
\nThis is the api-documentation for 12th project of the Python path of Openclassrooms.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20098177","collectionId":"e45a0823-ec53-4979-a509-be53ac03ff0a","publishedId":"2s8YmSsLVK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-20T21:26:53.000Z"},"item":[{"name":"Sales Team","item":[{"name":"Client","item":[{"name":"List of all clients","id":"10c3ea6d-7194-441b-be8b-7bc470339319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/clients","description":"Enpoint that shows a list of all clients.
\nEnter the URI in the following format:
\n\nThe GET Client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/?search={first_name}
\nhttp://127.0.0.1:8000/clients/?search={last_name}
\nhttp://127.0.0.1:8000/clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all potential clients.
\n(Clients that don't have an active contract)
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/potential_clients/
\nThe GET potential client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/potential_clients/?search={first_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={last_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all existing clients.
\n(Clients that have an active contract)
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/existing_clients/
\nThe GET existing client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/existing_clients/?search={first_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={last_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a client.
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/{client-id}/
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"can be Null
\n","type":"text"},{"key":"mobile","value":"88558543475","description":"can be Null
\n","type":"text"},{"key":"company_name","value":"The Traditional Company","description":"max lenght 100
\n","type":"text"},{"key":"sales_contact","value":"","description":"user-email (of a sales team member), current user by default (if empty)
\n","type":"text","contentType":""}]},"url":"http://127.0.0.1:8000/clients/","description":"Endpoint that allowes Authenticated users to create/post a new client.
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/
\nThe Body has to contain the following key - value pairs:
\nfirst_name : {first name}
\nlast_name : {last name}
\nemail : {email-address}
\nphone : {phone number}
\nmobile : {mobile number}
\ncompany_name: {company name}
\nsales_contact : {user_id} -> (current user by default)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint to update a Client.
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/{client-id}/
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all client related enpoints
\n","_postman_id":"e018859a-052b-48cb-bebd-24fd9b4782de","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all Contracts.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/contracts/
\nThe GET Contracts supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/contracts/?search={client_first_name}
\nhttp://127.0.0.1:8000/contracts/?search={client_last_name}
\nhttp://127.0.0.1:8000/contracts/?search={client_first_name+client_last_name}
\nhttp://127.0.0.1:8000/contracts/?search={date(yyyy-mm-dd)}
\nhttp://127.0.0.1:8000/contracts/?search={amount}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a Contract.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/contracts/{contract-id}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"client id
\n","type":"text"},{"key":"status","value":"OPEN","description":"options: OPEN, SIGNED
\n","type":"text"},{"key":"amount","value":"500.00","description":"Price (float)
\n","type":"text"},{"key":"payment_due","value":"2022-11-01","description":"date until client has to pay {yyyy-mm-dd} (past dates not allowed)
\n","type":"text"}]},"url":"http://127.0.0.1:8000/contracts/","description":"Endpoint that allowes Authenticated users to create/post a new client.
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/contracts/
\nThe body has to contain the following key - value pairs:
\nclient : {client_id}
\nstatus : {valid contract status} (sales team: only OPEN or SIGNED allowed)
\namount : {float}
\npayment_due : {date (yyyy-mm-dd) - no past dates}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"client id
\n","type":"text","disabled":true},{"key":"status","value":"OPEN","description":"options: OPEN, SIGNED
\n","type":"text","disabled":true},{"key":"amount","value":"1700.00","description":"price (float)
\n","type":"text"},{"key":"payment_due","value":"","description":"date until client has to pay {yyyy-mm-dd} (past dates not allowed)
\n","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/contracts/9/","description":"Endpoint to update a Contract.
\nEnter The URI in the following format:
\nhttp://127.0.0.1:8000/contract/{contract-id}/
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all contract related endpoints.
\n","_postman_id":"e53b8ce2-1655-40a4-aa96-7a4ebc13d2ac","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all Events.
\nEnter the URI in the following format:
\n\nThe GET Events supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/events/?search={client_first_name}
\nhttp://127.0.0.1:8000/events/?search={client_last_name}
\nhttp://127.0.0.1:8000/events/?search={client_first_name+client_last_name}
\nhttp://127.0.0.1:8000/events/?search={date(yyyy-mm-dd)}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a Event.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/event/{event-id}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"name of the event
\n","type":"text"},{"key":"support_contact","value":"m.brauns@gmail.com","description":"user-email (off a support team member)
\n","type":"text"},{"key":"contract","value":"4","description":"contract_id (of a signed contract)
\n","type":"text"},{"key":"status","value":"PROCESSING","description":"options: PROCESSING, UPCOMING, ONGOING, COMPLETED, CANCELLED
\n","type":"text"},{"key":"attendees","value":"350","description":"int (number of attendees)
\n","type":"text"},{"key":"event_date","value":"2023-02-01","description":"date (yyyy-mm-dd)
\n","type":"text"},{"key":"notes","value":"A big spiderman party","description":"text field for notes
\n","type":"text"}]},"url":"http://127.0.0.1:8000/events/","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all event related endpoints.
\n","_postman_id":"8aa2da7e-07e8-43b1-90ce-ef0650667618","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This folder contains all the endpoints a sales team member is able / allowed to use.
\nTo Authenticate select the type Basic Auth.
\nUsername: {user_email}
\nPassword: {user_password}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all clients.
\nEnter the URI in the following format:
\n\nThe GET Client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/?search={first_name}
\nhttp://127.0.0.1:8000/clients/?search={last_name}
\nhttp://127.0.0.1:8000/clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all potential clients.
\n(Clients that don't have an active contract)
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/potential_clients/
\nThe GET potential client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/potential_clients/?search={first_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={last_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/potential_clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all existing clients.
\n(Clients that have an active contract)
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/existing_clients/
\nThe GET existing client supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/existing_clients/?search={first_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={last_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={first_name+last_name}
\nhttp://127.0.0.1:8000/existing_clients/?search={email}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a client.
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/clients/{client-id}/
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all client related endpoints.
\n","_postman_id":"7acd24cf-2b50-485a-9c98-873005f99763","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all Contracts.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/contracts/
\nThe GET Contracts supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/contracts/?search={client_first_name}
\nhttp://127.0.0.1:8000/contracts/?search={client_last_name}
\nhttp://127.0.0.1:8000/contracts/?search={client_first_name+client_last_name}
\nhttp://127.0.0.1:8000/contracts/?search={date(yyyy-mm-dd)}
\nhttp://127.0.0.1:8000/contracts/?search={amount}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a Contract.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/contracts/{contract-id}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all contract related endpoints.
\n","_postman_id":"01b251f8-2d1e-43ae-bd47-0602e682cf49","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enpoint that shows a list of all Events.
\nEnter the URI in the following format:
\n\nThe GET Events supports search operations for:
\nEnter The URI in the follwing format:
\nhttp://127.0.0.1:8000/events/?search={client_first_name}
\nhttp://127.0.0.1:8000/events/?search={client_last_name}
\nhttp://127.0.0.1:8000/events/?search={client_first_name+client_last_name}
\nhttp://127.0.0.1:8000/events/?search={date(yyyy-mm-dd)}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Endpoint that shows all details of a Event.
\nEnter the URI in the following format:
\nhttp://127.0.0.1:8000/event/{event-id}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"name of the event
\n","type":"text","disabled":true},{"key":"support_contact","value":"","description":"user-email (off a support team member)
\n","type":"text","disabled":true},{"key":"contract","value":"","description":"contract_id (of a signed contract)
\n","type":"text","disabled":true},{"key":"status","value":"","description":"options: PROCESSING, UPCOMING, ONGOING, COMPLETED, CANCELLED
\n","type":"text","disabled":true},{"key":"attendees","value":"300","description":"int (number of attendees)
\n","type":"text"},{"key":"event_date","value":"","description":"date (yyyy-mm-dd)
\n","type":"text","disabled":true},{"key":"notes","value":"","description":"text field for notes
\n","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/events/1/","description":"Endpoint to update a Event.
\nEnter The URI in the following format:
\nhttp://127.0.0.1:8000/event/{event-id}/
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contains all contract related endpoints.
\n","_postman_id":"6af5135f-f916-41b8-a66e-ce2e40254183","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This folder contains all the endpoints a support team member is able / allowed to use.
\nTo Authenticate select the type Basic Auth.
\nUsername: {user_email}
\nPassword: {user_password}
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"