The Client Address Book API allows users to execute CRUD actions and persist data to a MongoDB database.
\nTo access the API, navigate to scottiecrump/client-address-next and follow the provided instructions to run the API in a Docker container.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Getting Started","slug":"getting-started"}],"owner":"3521978","collectionId":"22d52145-d76a-4951-8d72-559195ea68f0","publishedId":"UVJkBZ2Q","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-08T20:32:26.000Z"},"item":[{"name":"Add New Client","event":[{"listen":"prerequest","script":{"id":"5249b36c-82e3-4742-b413-a14e1dd04885","exec":["const randomPhone = Math.floor(Math.random() * 1000000000)","const randomFullName = pm.variables.replaceIn('Jean Koepp');","","pm.collectionVariables.set(\"randomPhone\", randomPhone);","pm.collectionVariables.set(\"randomFullName\", randomFullName);",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"c9c40f38-8b5e-4c05-a67c-d514204180dd","exec":["pm.test(\"given POST request, returns 200 status\", () => {"," pm.response.to.have.status(200);","});","","pm.test(\"given new client, returns client added message\", () => {"," const response = pm.response.json();"," const name = pm.collectionVariables.get(\"randomFullName\");",""," pm.expect(response.message).to.eql(`${name} successfully added`);","});","","const schema = {"," \"type\": \"object\","," \"properties\": {"," \"message\": {"," \"type\": \"string\""," }"," },"," \"required\": ["," \"message\""," ]","}","","pm.test(\"given valid POST request, response matches schema\", () => {"," pm.response.to.have.jsonSchema(schema);","});",""],"type":"text/javascript"}}],"id":"8a29efae-4203-43ab-b5ac-3e4c4112f6f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"Lupe.Daugherty65@hotmail.com\",\n \"phone\": \"\",\n \"address\": \"9639 Kyra Centers\",\n \"company\": \"Volkman Group\",\n \"notes\": \"Earum iste qui pariatur.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/add-client","description":"Creates a new client. The name value must be unique. The name and email properties are required. The phone property is designed to accept integers only. So, for example, phone number formats such as (111) 222-3333 will not work.
{\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone\": number,\n \"address\": \"string\",\n \"company\": \"string\",\n \"notes\": \"string\"\n}\n\nRetrieves an array of all current clients.
\n","urlObject":{"path":["api","clients"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"d2e31653-6661-4b7c-9ec8-c674db09210b","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"{{baseURL}}/api/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"_id\": \"61aa26f711778415b375e07b\",\n \"name\": \"Kadeem Dorsey\",\n \"email\": \"delapeq@mailinator.com\",\n \"address\": \"123 Phillip Carson Street\",\n \"phone\": 11234567890,\n \"company\": \"Hendrix Nguyen Plc\",\n \"notes\": \"Eveniet cumque volu\",\n \"__v\": 0,\n \"id\": \"61aa26f711778415b375e07b\"\n }\n ]\n}"}],"_postman_id":"dcc1be62-7cbe-457c-831d-a652dc7c5765"},{"name":"Get Client","event":[{"listen":"test","script":{"id":"ee7e56b6-e128-4cbc-b338-3bf305282739","exec":["pm.test(\"given GET request, returns 200 status\", () => {"," pm.response.to.have.status(200);","});","","const schema = {"," \"type\": \"object\","," \"properties\": {"," \"user\": {"," \"type\": \"object\","," \"properties\": {"," \"_id\": {"," \"type\": \"string\""," },"," \"name\": {"," \"type\": \"string\""," },"," \"email\": {"," \"type\": \"string\""," },"," \"address\": {"," \"type\": \"string\""," },"," \"phone\": {"," \"type\": \"integer\""," },"," \"company\": {"," \"type\": \"string\""," },"," \"notes\": {"," \"type\": \"string\""," },"," \"__v\": {"," \"type\": \"integer\""," },"," \"id\": {"," \"type\": \"string\""," }"," },"," \"required\": ["," \"_id\","," \"name\","," \"email\","," \"__v\","," \"id\""," ]"," }"," },"," \"required\": ["," \"user\""," ]","}","","pm.test(\"given GET request, response matches schema\", () => {"," pm.response.to.have.jsonSchema(schema);","});",""],"type":"text/javascript"}}],"id":"cf9f815a-ed84-482a-8bf4-192bb46d51f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/api/get-client?id=","description":"Returns a single client.
\n","urlObject":{"path":["api","get-client"],"host":["{{baseURL}}"],"query":[{"key":"id","value":""}],"variable":[]}},"response":[{"id":"7a165f9b-aa12-4d18-90f5-65b435d01437","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseURL}}/api/get-client?id=61aae9545e547d5199434e8c","host":["{{baseURL}}"],"path":["api","get-client"],"query":[{"key":"id","value":"61aae9545e547d5199434e8c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"\"e6-VRi5vRAjTXU1+DOzgwMOW8KYAz4\""},{"key":"Content-Length","value":"230"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Wed, 08 Dec 2021 16:17:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_id\": \"61aae9545e547d5199434e8c\",\n \"name\": \"Terry White\",\n \"email\": \"Zachary59@hotmail.com\",\n \"address\": \"4714 Jacobs Light\",\n \"phone\": 532088077,\n \"company\": \"Waters - Thiel\",\n \"notes\": \"possimus\",\n \"__v\": 0,\n \"id\": \"61aae9545e547d5199434e8c\"\n }\n}"}],"_postman_id":"cf9f815a-ed84-482a-8bf4-192bb46d51f0"},{"name":"Update Client","event":[{"listen":"test","script":{"id":"2c0221df-0d7e-4a1c-9c2d-b0c8cba10445","exec":["pm.test(\"given valid POST request, returns 201 status\", () => {"," pm.response.to.have.status(201);","});","","pm.test(\"given POST client, returns client updated message\", () => {"," const response = pm.response.json();"," const name = pm.collectionVariables.get(\"randomFullName\");",""," pm.expect(response.message).to.eql(`${name} successfully updated`);","});","","const schema = {"," \"type\": \"object\","," \"properties\": {"," \"message\": {"," \"type\": \"string\""," }"," },"," \"required\": ["," \"message\""," ]","}","","pm.test(\"given valid POST request, response matches schema\", () => {"," pm.response.to.have.jsonSchema(schema);","});",""],"type":"text/javascript"}}],"id":"613d6927-f125-4fbb-95c1-ab7bb854c5e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"notes\": \"Updated Notes\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/update-client","description":"Update details for an existing client. Note: the name value is simply used in the response message. If you do not pass in a name the response will be \"undefined was successfully updated\"
{\n \"id\": \"string\",\n \"name\": \"string\",\n}\n\nRemove an existing client. Note: the name value is simply used in the response message. If you do not pass in a name the response will be \"undefined was successfully deleted\"
{\n\"id\": \"string\",\n \"name\": \"string\"\n}\n\n