Skip to content

Files

Latest commit

5b12155 · Feb 17, 2020

History

History
610 lines (318 loc) · 10.4 KB

API.md

File metadata and controls

610 lines (318 loc) · 10.4 KB

FUPP API

API for FUPP app.

Table of Contents

  1. returns professions array
  2. returns profession
  3. returns professions array
  4. returns profession
  5. returns professions array
  6. log-in the user and returns a token
  7. returns professions array
  8. returns profession
  9. returns professions array
  10. returns professions array
  11. returns professions array
  12. returns professions array
  13. returns profession
  14. Users API

categories

Specification Value
Resource Path /categories
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/categories GET returns professions array

API: /categories (GET)

returns professions array

category

Specification Value
Resource Path /category
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/category/{id} GET returns profession

API: /category/{id} (GET)

returns profession

Param Name Param Type Data Type Description Required?
id query string id Yes

contact

Specification Value
Resource Path /contact
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/contact GET returns professions array

API: /contact (GET)

returns professions array

expertise

Specification Value
Resource Path /expertise
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/expertise GET returns profession

API: /expertise (GET)

returns profession

Param Name Param Type Data Type Description Required?
id query string id Yes

expertises

Specification Value
Resource Path /expertises
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/expertises/{id} GET returns professions array

API: /expertises/{id} (GET)

returns professions array

jobs

Specification Value
Resource Path /jobs
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/jobs/register POST log-in the user and returns a token
/jobs/myjobs GET log-in the user and returns a token
/jobs/jobs GET log-in the user and returns a token
/jobs/pitched GET log-in the user and returns a token
/jobs/interviewing GET log-in the user and returns a token
/jobs/offered GET log-in the user and returns a token
/jobs/accepted GET log-in the user and returns a token
/jobs/jobstatus POST log-in the user and returns a token

API: /jobs/register (POST)

log-in the user and returns a token

Param Name Param Type Data Type Description Required?
description query string Descripttion Yes
location query string Location Yes
postcode query string Postcode Yes
rate query string Rate Yes
subcategoryid query string SubcategoryID Yes
categoryid query string CategoryID Yes

API: /jobs/myjobs (GET)

log-in the user and returns a token

API: /jobs/jobs (GET)

log-in the user and returns a token

API: /jobs/pitched (GET)

log-in the user and returns a token

API: /jobs/interviewing (GET)

log-in the user and returns a token

API: /jobs/offered (GET)

log-in the user and returns a token

API: /jobs/accepted (GET)

log-in the user and returns a token

API: /jobs/jobstatus (POST)

log-in the user and returns a token

Param Name Param Type Data Type Description Required?
status query string Status Yes

missions

Specification Value
Resource Path /missions
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/missions GET returns professions array

API: /missions (GET)

returns professions array

profession

Specification Value
Resource Path /profession
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/profession/{id} GET returns profession

API: /profession/{id} (GET)

returns profession

Param Name Param Type Data Type Description Required?
id query string id Yes

professions

Specification Value
Resource Path /professions
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/professions GET returns professions array

API: /professions (GET)

returns professions array

services

Specification Value
Resource Path /services
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/services GET returns professions array

API: /services (GET)

returns professions array

steps

Specification Value
Resource Path /steps
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/steps GET returns professions array

API: /steps (GET)

returns professions array

subcategories

Specification Value
Resource Path /subcategories
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/subcategories GET returns professions array

API: /subcategories (GET)

returns professions array

subcategory

Specification Value
Resource Path /subcategory
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/subcategory/{id} GET returns profession

API: /subcategory/{id} (GET)

returns profession

Param Name Param Type Data Type Description Required?
id query string id Yes

users

Specification Value
Resource Path /users
API Version 1.0.0
BasePath for the API http://host:port/api
Consumes application/json
Produces

Operations

Resource Path Operation Description
/users/login POST log-in the user and returns a token
/users/register POST user register

API: /users/login (POST)

log-in the user and returns a token

Param Name Param Type Data Type Description Required?
email query string Email Yes
password query string Password Yes

API: /users/register (POST)

user register

Param Name Param Type Data Type Description Required?
firstname query string FristName Yes
surname query string Surname Yes
email query string Email Yes
password query string Password Yes
nicname query string NicName Yes
profession query string Profession Yes
expertise query string Expertise Yes
history query string History Yes
address1 query string Address1 Yes
address2 query string Address2 Yes
city query string City Yes
postcode query string PostCode Yes
phone query string Telephone Yes
buddy query string Buddy Yes
professionid query uint ProfessionID Yes
expertiseid query uint ExpertiseID Yes