bfpulliam/backend

Fairshots backend repository

Fairshots Backend · ·

To view Frontend Repo please go to https://github.com/Fairshots/Fairshots.org

Stack:

Node | Express | PostgreSQL | Sequelize | Passport.Js

Roadmap for Backend, Frontend and Admin Panel

Project Progress

Repository Branches

Development - contains staging code under test - (PULL REQUESTS MUST BE DONE HERE).
Master - contains the code deployed to production server
others - developer or temporary branches

How to contribute

Please follow these steps to contribute - installation instructions included

API Documentation

Title	URL	Method	Params
login	/login	POST
forgot password	/login/forgot	POST
reset password	/login/pwreset/:token
get featured three photographers and three orgs	/api/featured	GET
register new photographer	/api/photographer	POST
get basic info of all photographers	/api/photographer/all	GET
read photographer	/api/photographer/:id	GET	Header Authorization: 'bearer token'
update photographer info	/api/photographer/:id	PUT	Header Authorization: 'bearer token'
delete photographer account	/api/photographer/:id	DELETE	Header Authorization: 'bearer token'
insert links of photos	/api/photographer/:id/photos	POST	Header Authorization: 'bearer token'
register new organization	/api/organization	POST
get basic info of all orgs	/api/organization/all	GET
read organization	/api/organization/:id	GET	Header Authorization: 'bearer token'
update organization	/api/organization/:id	PUT	Header Authorization: 'bearer token'
delete organization	/api/organization/:id	DELETE	Header Authorization: 'bearer token'
insert links of photos	/api/organization/:id/photos	POST	Header Authorization: 'bearer token'
create new project	/api/project	POST	Header Authorization: 'bearer token'
view project	/api/project/:id	GET	Header Authorization: 'bearer token'
update project	/api/project/:id	PUT	Header Authorization: 'bearer token'
delete project	/api/project/:id	DELETE	Header Authorization: 'bearer token'
apply to project (photographer)	/api/project/:id	POST	Header Authorization: 'bearer token'
insert links of photos in project	/api/project/:id/photos	POST	Header Authorization: 'bearer token'
send email to another user (photographer or org)	/api/mail/	POST

Details on Request Params

All requests params may be sent as x-www-form-urlencoded or JSON in request body.

/login (req body only)

POST

{
  email: [string],
  password: [string]
}

Success:
Code 200 -
content: object
Returning:

{ 
  msg: 'Logged in',
  userId: [string],
  token: [string]
} 

Failure:
Code 401 - Unauthorized

/login/forgot (req body only)

POST

{
  Email: [string],
}

Success:
Code 200 -
content: object
Returning:

• e-mail sent

{ 
   info
} 

Failure:
Code 400 - User not found

/login/pwreset/:token

POST
parameters: reset token must be handled in frontend replacing all "&" by "." before posting

{
  Email: [string]
  Password: [string],
}

Success:
Code 200 -
content: object
Returning:

{ 
   msg: "Password was successfully reset"
} 

Failure:
Code 400 - missing data Code 401 - invalid token Code 500 - error

**/api/featured/

GET

Success:
Code 200 - created
content: object
Returning:

{
	Photographers: [{
	  Id: [string]
	  Name: [string],   //required
	  Skill: ['Student' | 'Amateur' | 'Professional'] , //required
	  Biography: [text], //required
	  ProfilePicture: [string],
	  Languages: [string array] ,
	  Causes: [string array] ,
	  City: [string] , //required
	  Country: [string], //required 
	  createdAt: [date],
	  Photos: {} ,
	  Project Applications: {} 
	}, ...] ,

      Organizations:[
	{
	  Name: [string],   //required
	  Parent: [string],
	  Logo: [URL],
	  Background: [text], //required
	  website: [URL],
	  facebook: [URL],
	  Causes: [string array] ,
	  City: [string] , //required
	  Country: [string], //required 
	  Projects: {}
	}, ...]
}

Possible Failure:
Code 500 - Server Error

{ 
  error object
} 

/api/photographer

POST

{
  name: [string],   //required
  email: [string],  //required
  password: [string],
  skill: ['Student' | 'Amateur' | 'Professional'] , //required
  biography: [text], //required
  webpage: [string],
  facebook: [string],
  instagram: [string],
  pictUrl: [string],
  languages: [string array] ,
  causes: [string array] ,
  city: [string] , //required
  country: [string], //required 
}

Success:
Code 201 - created
content: object
Returning:

{ 
  photographer
} 

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

/api/photographer/all

GET

Success:
Code 200 - created
content: object
Returning:

[{
  Id: [string]
  Name: [string],   //required
  Skill: ['Student' | 'Amateur' | 'Professional'] , //required
  Biography: [text], //required
  ProfilePicture: [string],
  Languages: [string array] ,
  Causes: [string array] ,
  City: [string] , //required
  Country: [string], //required 
  createdAt: [date],
  Photos: {} ,
  Project Applications: {} 
}, ...] 

Possible Failure:
Code 500 - Server Error

{ 
  error object
} 

/api/photographer/:id

GET

Authentication: 'bearer token'

Success:
Code 200 - OK
content: object
Returning:

{
  Id: [string]
  Name: [string],   //required
  Email: [string],  //required
  Skill: ['Student' | 'Amateur' | 'Professional'] , //required
  Biography: [text], //required
  Webpage: [string],
  Facebook: [string],
  Instagram: [string],
  ProfilePicture: [string],
  Languages: [string array] ,
  Causes: [string array] ,
  City: [string] , //required
  Country: [string], //required 
  createdAt: [date],
  updatedAt: [date],
  Photos: {} ,
  Project Applications: {} 
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token

PUT

Authentication: 'bearer token'

{
  key: value // to be updated one or more
}
// Attention: Key name here must be equal to DB column names (most of the column names are capitalized). 

Success:
Code 200 - OK
content: object
Returning:

[ x ]  // number of itens updated

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

DELETE
Authentication: 'bearer token'

Success:
Code 200 - OK
content: object
Returning:

{
  msg: " user deleted from database successfully" // to be updated one or more
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

/api/photographer/:id/photos

POST

{
  photos:[{
    photographerId: [ID],
    cloudlink:[URL]
  },
  {
    ophotographerId: [ID],
    cloudlink:[URL]
  }]
}

Success:
Code 201 - created
content: object
Returning:

[{
    id: [ID]
    organizationId or photographerId: [ID],
    cloudlink:[URL]
  },
  {
    id: [ID]
    organizationId or photographerId: [ID],
    cloudlink:[URL]
 }]

/api/organization

POST

{
  name: [string],   //required
  logo: [URL],
  email: [email],  //required
  person: [string], //required
  position: [string],
  password: [string],
  phone: [phone]
  background: [text], //required
  website: [URL], //required
  facebook: [URL],
  languages: [string array] ,
  causes: [string array] ,
  city: [string] , //required
  country: [string], //required 
  createdAt: [date],
  updatedAt: [date]
}

Success:
Code 201 - created
content: object
Returning:

{ 
  organization
} 

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

/api/organization/all

GET

Success:
Code 200 - ok
content: object
Returning:

{
  Name: [string],   //required
  Logo: [URL],
  Background: [text], //required
  website: [URL],
  facebook: [URL],
  Causes: [string array] ,
  City: [string] , //required
  Country: [string], //required 
  Projects: {}
}

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

/api/organization/:id

GET

Authentication: 'bearer token'

Success:
Code 200 - OK
content: object
Returning:

{
  Name: [string],   //required
  Logo: [URL],
  Email: [email],  //required
  ContactPerson: [string],
  Position: [string],
  Password: [string],
  Phone: [phone]
  Background: [text], //required
  website: [URL],
  facebook: [URL],
  Languages: [string array] ,
  Causes: [string array] ,
  City: [string] , //required
  Country: [string], //required 
  Photos: {},
  Projects: {}
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token

PUT

Authentication: 'bearer token'

{
  key: value // to be updated one or more
}
// Attention: Key name here must be equal to DB column names (most of the column names are capitalized). 

Success:
Code 200 - OK
content: object
Returning:

[ x ]  // number of itens updated

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

DELETE
Authentication: 'bearer token'

Success:
Code 200 - OK
content: object
Returning:

{
  msg: " user deleted from database successfully" // to be updated one or more
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

/api/organization/:id/photos

POST

{
  photos:[{
    organizationId: [ID],
    cloudlink:[URL]
  },
  {
    organizationId: [ID],
    cloudlink:[URL]
  }]
}

Success:
Code 201 - created
content: object
Returning:

[{
    id: [ID]
    organizationId: [ID],
    cloudlink:[URL]
  },
  {
    id: [ID]
    organizationId: [ID],
    cloudlink:[URL]
 }]

/api/project/

POST

{
        title: [string],
        description: [string],
        startingDate: [date],
        duration: [integer],
        applicationDate: : [date],
        deliveryDate: [date],
        fundingOptions: ['No Funds' | 'Expenses' | 'Photographer'],
        fundsAvailable: [string],
        fundsDetails: [string],
        fundsFairshot: [boolean],
        photographersNeeded: [integer],
        professionalOnly: [boolean],
        geographicRestriction: ['Anywhere'|'Continent'|'Country'|'Region'],
        question1: [string],
        question2: [string],
	question3: [string],
	city: [string],
	country: [string],
        cause: [string],
        organizationId: [ID],
	photos: [ { projectId: [integer], cloudlink: [string] }, ... ]  
}

Success:
Code 201 - created
content: object
Returning:

{ 
  project
} 

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

*/api/project/:id

GET

Authentication: 'bearer token'

Success:
Code 200 - created
content: object
Returning:

{
        Title,
        Description,
        StartingDate,
        Duration,
        ApplicationDate,
        Delivery,
        FundingOptions,
        FundsAvailable,
        FundsDetails,
        FundsFairshot,
        PhotographersNeeded,
        ProfessionalOnly,
        GeographicRestriction,
        Question1,
        Question2,
	Question3,
	City,
	Country,
        Cause,
        organizationId,
	photos,
        createdAt,
        updatedAt
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token

PUT

Authentication: 'bearer token'

{
  key: value // to be updated one or more
}
// Attention: Key name here must be equal to DB column names (most of the column names are capitalized). 

Success:
Code 200 - OK
content: object
Returning:

[ x ]  // number of itens updated

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

DELETE
Authentication: 'bearer token'

Success:
Code 200 - OK
content: object
Returning:

{
  msg: "Project deleted from database successfully" // to be updated one or more
}

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

POST

Authentication: 'bearer token'

{
  photographerId: [Id],
  answer1: [string],
  answer2: [string],
  answer3: [string] 
}
// Attention: Key name here must be equal to DB column names (most of the column names are capitalized). 

Success:
Code 201 - created
content: object
Returning:

[ application result ]

Failure:
Code 401 - Unauthorized
Cause: invalid API Token
Code 500 - Server Error
Possible Causes: invalid values, wrong key names

/api/project/:id/photos

POST

{
	photos: [ { projectId: [integer], cloudlink: [string] }, ... ]  
}

Success:
Code 201 - created
content: object
Returning:

[
{ 
  photos
}, ...
] 

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

/api/mail (request body only)

POST

{
   email: [string],
   subject: [string]
   message: [string] 
}

Success:
Code 200 - OK
content: info object
Returning:

{ 
  info
}

Failure:
Code 500 - Internal Server Error

{ 
  error object
} 

======= */api/project/all
GET

Authentication: 'bearer token'

Success:
Code 200 - created
content: object
Returning:

[{
        Title,
        Description,
        ApplicationDate,
        Country,
        Cause,
	[organization name & logo]
	[1 Photo]
}, ...]

Failure:
Code 401 - Unauthorized
Cause: invalid API Token