The API documentation for Sersow application serves as a private resource exclusively accessible to developers and mentors, offering detailed insights and instructions on integrating and leveraging the application's features and functionalities.
\nThis Middlewares error condition applies to all requests
\n1. If a request does not match the API version provided
\nError Type: api-version
\n{\n \"status\": 410,\n \"message\": \"Gone, Something wrong with the version of API\",\n \"err\": {\n \"type\": \"api-version\",\n \"data\": {\n \"code\": -1\n }\n }\n}\n\nThis Token Authorization error condition is intended for every request that is required to use the Authorization header.
Error Type: token
1. It checks the presence of an authorization token in the request headers. If the token is missing, it returns a 401 Unauthorized response with the message \"Request Unauthorized\" and an error code of -1.
\n{\n \"status\": 401,\n \"message\": \"Request Unauthorized\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -1\n }\n }\n}\n\n2. If the token is present, it verifies the token using a JWT library. If there is an error during verification, it returns a 401 Unauthorized response with the message \"Token Unauthorized\" and an error code of -2.
\n{\n \"status\": 401,\n \"message\": \"Token Unauthorized\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -2\n }\n }\n}\n\n3. If the token is Expired it returns a 401 Unauthorized response with the message \"Token Expired\" and an error code of -3.
\n{\n \"status\": 401,\n \"message\": \"Token Expired\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -3\n }\n }\n}\n\n4. If the URL ends with \"valid-code\" or \"resend-code,\" it checks if the \"notVerified\" property in the token's data is not true. If it is not true, it returns a 401 Unauthorized response with the message \"User in Token is Already Verified\" and an error code of -4.
\n{\n \"status\": 401,\n \"message\": \"User in Token is Already Verified\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -4\n }\n }\n}\n\n5. If the URL does not end with \"valid-code\" or \"resend-code,\" it checks if the \"notVerified\" property in the token's data is true. If it is true, it returns a 401 Unauthorized response with the message \"User in Token is Not Verified\" and an error code of -5.
\n{\n \"status\": 401,\n \"message\": \"User in Token is Not Verified\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -5\n }\n }\n}\n\nThis Validator error condition applies to every request that contains a json body.
\nError Type: validator
\n{\n \"status\": 400,\n \"message\": \"{Message of AJV Error}\",\n \"err\": {\n \"type\": \"validator\",\n \"data\": {\n \"instancePath\": \"/{}\",\n \"schemaPath\": \"#/{}/{}/{}\",\n \"keyword\": \"{}\",\n \"params\": {\n \"pattern\": \"^{}$\"\n },\n \"message\": \"must match pattern \\\"{}$\\\"\"\n }\n }\n}\n\n{\n type: 'object',\n properties: {\n emailUpi: {\n type: 'string',\n maxLength: 68,\n minLength: 9,\n pattern: '^[A-Za-z0-9._%+-]+@upi\\\\.edu$',\n nullable: false\n },\n name: {\n type: 'string',\n maxLength: 60,\n minLength: 1,\n nullable: false\n },\n gender: {\n type: 'integer',\n enum: [1, 2],\n nullable: false\n },\n password: {\n type: 'string',\n minLength: 6,\n maxLength: 18,\n pattern: '^\\\\S+$',\n nullable: false\n }\n },\n required: ['emailUpi', 'name', 'gender', 'password'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n code: {\n type: 'string',\n minLength: 6,\n maxLength: 6,\n nullable: false\n }\n },\n required: ['code'],\n additionalProperties: false\n}\n\n{\n type: 'object',\n properties: {\n identity: {\n type: 'string',\n maxLength: 68,\n minLength: 1,\n nullable: false\n },\n password: {\n type: 'string',\n minLength: 6,\n maxLength: 18,\n nullable: false\n }\n },\n required: ['identity', 'password'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n email: {\n type: 'string',\n maxLength: 68,\n minLength: 1,\n pattern: '^[A-Za-z0-9._%+-]+@(upi\\\\.edu|gmail\\\\.com)$',\n nullable: false\n }\n },\n required: ['email'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n code: {\n type: 'string',\n maxLength: 20,\n minLength: 20,\n nullable: false\n },\n password: {\n type: 'string',\n minLength: 6,\n maxLength: 18,\n pattern: '^\\\\S+$',\n nullable: false\n }\n }\n}\n\n{\n type: 'object',\n properties: {\n name: {\n type: 'string',\n maxLength: 60,\n minLength: 1,\n nullable: false\n },\n bio: {\n type: 'string',\n maxLength: 160,\n minLength: 1,\n nullable: true\n },\n image: {\n type: 'string',\n nullable: true\n },\n website: {\n type: 'string',\n maxLength: 50,\n minLength: 1,\n nullable: true\n }\n },\n required: ['name', 'bio', 'website'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n email: {\n type: 'string',\n maxLength: 40,\n minLength: 11,\n pattern: '^[A-Za-z0-9._%+-]+@gmail\\\\.com$',\n nullable: false\n }\n }\n};\n\n{\n type: 'object',\n properties: {\n code: {\n type: 'string',\n minLength: 6,\n maxLength: 6,\n nullable: false\n }\n },\n required: ['code'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n username: {\n type: 'string',\n maxLength: 15,\n minLength: 1,\n pattern: '^[a-zA-Z0-9_]{1,15}$',\n nullable: false\n }\n }\n};\n\n{\n type: 'object',\n properties: {\n password: {\n type: 'string',\n minLength: 6,\n maxLength: 18,\n pattern: '^\\\\S+$',\n nullable: false\n },\n newPassword: {\n type: 'string',\n minLength: 6,\n maxLength: 18,\n pattern: '^\\\\S+$',\n nullable: false\n }\n },\n required: ['password', 'newPassword'],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n id: {\n type: 'string',\n maxLength: 36,\n minLength: 36,\n nullable: true\n },\n title: {\n type: 'string',\n maxLength: 25,\n minLength: 1,\n nullable: false\n },\n description: {\n type: 'string',\n maxLength: 700,\n minLength: 1,\n nullable: true\n },\n categories: {\n type: 'array',\n maxItems: 3,\n items: {\n type: \"string\",\n maxLength: 36,\n minLength: 36,\n pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',\n nullable: false\n },\n nullable: true\n },\n otherCtg: {\n type: 'string',\n maxLength: 15,\n minLength: 1,\n nullable: true\n },\n logo: {\n type: 'string',\n nullable: true\n },\n thumbnail: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false,\n if: { properties: { isUrl: { const: true } } },\n then: {\n maxLength: 50,\n minLength: 11,\n pattern: '^(?:https?:\\\\/\\\\/(?:www\\\\.)?youtube\\\\.com\\\\/(?:watch\\\\?v=|embed\\\\/)?[\\\\w-]{11}|https?:\\\\/\\\\/youtu\\\\.be\\\\/[\\\\w-]{11})$'\n },\n else: {\n pattern: '^[A-Za-z0-9+/=]+$'\n }\n },\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n image1: {\n type: 'string',\n nullable: true\n },\n image2: {\n type: 'string',\n nullable: true\n },\n image3: {\n type: 'string',\n nullable: true\n },\n program: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n paper: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n code: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n tags: {\n type: 'array',\n maxItems: 4,\n nullable: true,\n items: {\n type: 'string',\n maxLength: 12,\n pattern: '^[a-z0-9]{1,12}$',\n nullable: false\n }\n },\n contributors: {\n type: 'array',\n nullable: true,\n items: {\n type: 'string',\n pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',\n nullable: false\n }\n }\n },\n required: [\n 'id', 'title', 'description', 'categories', 'otherCtg', \n 'logo', 'thumbnail', 'image1', 'image2', 'image3', \n 'program', 'paper', 'code', 'tags', 'contributors'\n ],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n id: {\n type: 'string',\n maxLength: 36,\n minLength: 36,\n nullable: true\n },\n title: {\n type: 'string',\n maxLength: 25,\n minLength: 1,\n nullable: false\n },\n description: {\n type: 'string',\n maxLength: 700,\n minLength: 1,\n nullable: true\n },\n categories: {\n type: 'array',\n maxItems: 3,\n items: {\n type: \"string\",\n maxLength: 36,\n minLength: 36,\n pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',\n nullable: false\n },\n nullable: true\n },\n otherCtg: {\n type: 'string',\n maxLength: 15,\n minLength: 1,\n nullable: true\n },\n logo: {\n type: 'string',\n nullable: true\n },\n thumbnail: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false,\n if: { properties: { isUrl: { const: true } } },\n then: {\n maxLength: 50,\n minLength: 11,\n pattern: '^(?:https?:\\\\/\\\\/(?:www\\\\.)?youtube\\\\.com\\\\/(?:watch\\\\?v=|embed\\\\/)?[\\\\w-]{11}|https?:\\\\/\\\\/youtu\\\\.be\\\\/[\\\\w-]{11})$'\n },\n else: {\n pattern: '^[A-Za-z0-9+/=]+$'\n }\n },\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n image1: {\n type: 'string',\n nullable: true\n },\n image2: {\n type: 'string',\n nullable: true\n },\n image3: {\n type: 'string',\n nullable: true\n },\n program: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n paper: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n code: {\n type: 'object',\n nullable: true,\n properties: {\n isUrl: {\n type: 'boolean',\n nullable: false\n },\n data: {\n type: 'string',\n nullable: false\n }\n },\n required: ['isUrl', 'data'],\n additionalProperties: false\n },\n tags: {\n type: 'array',\n maxItems: 4,\n nullable: true,\n items: {\n type: 'string',\n maxLength: 12,\n pattern: '^[a-z0-9]{1,12}$',\n nullable: false\n }\n },\n contributors: {\n type: 'array',\n nullable: true,\n items: {\n type: 'string',\n pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',\n nullable: false\n }\n }\n },\n required: [\n 'id', 'title', 'description', 'categories', 'otherCtg', \n 'logo', 'thumbnail', 'image1', 'image2', 'image3', \n 'program', 'paper', 'code', 'tags', 'contributors'\n ],\n additionalProperties: false\n};\n\n{\n type: 'object',\n properties: {\n comment: {\n type: 'string',\n maxLength: 200,\n minLength: 1,\n pattern: '^[a-zA-Z0-9\\\\s`~!@#$%^&*()-_=+[\\\\]{}|;:\\'\",.<>/?\\\\\\\\]+$',\n nullable: false\n }\n }\n};\n\nPrimary is the main API specific to all features for Sersow users
\n","_postman_id":"e21a5239-d0eb-4e49-9d3e-7638307e676f"}],"event":[{"listen":"prerequest","script":{"id":"c986bb59-43dd-4fc8-8821-9787ed626919","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d93e69f-f3d5-485c-ada0-b691df7eb189","type":"text/javascript","exec":[""]}}],"variable":[{"key":"host","value":"https://api.sersow.com","type":"string"},{"key":"version","value":"v1","type":"string"},{"key":"userToken","value":"header.payload.signature","type":"string"},{"key":"refreshToken","value":"header.payload.signature","type":"string"}]}