API Docs - acstech/corkboard GitHub Wiki

API Docs

New Item

URL

/api/items/new

METHOD

POST

URL Params

none

Data Params

    { 

    name: [string],

    category: [string],

    description: [string],

    price: [string],

    salestatus: [string],

    picid[]: [string]

    }

Success Response

Code: 201 CREATED Data: none

Error Response

Code: 400 BAD REQUEST

Code: 401 Unauthorized

Notes

Get Items

URL

/api/items

METHOD

GET

URL Params

none

Data Params

none

Success Response

Code: 200 OK

{ 
item:  { 
        
       id: [string],

       name: [string],

       category: [string],   

       description: [string],

       price: [float64],

       userid: [string],       

       date: [time.Time],

       salestatus: [string],

       picid[]: [string]
       
       },      
}

Error Response

Code: 204 NO CONTENT

Code: 400 Bad Request

Code: 401 UNAUTHORIZED

Notes

GetItemById

URL

/api/items/:id

METHOD

GET

URL Params

:id

Data Params

none

Success Response

Code: 200 OK

{
 id: [string],

 name: [string],

 category: [string],  

 description: [string],

 price: [float64], 

 userid: [string],       

 date: [time.Time],

 salestatus: [string],

 picid[]: [string] 

 }

Error Response

Code: 204 NO CONTENT

Code: 401 UNAUTHORIZED

Code: 400 Bad Request

Notes

GetItemsByCategory

URL

/api/category/:key

METHOD

GET

URL Params

:key

Data Params

None

Success Response

Code: 200 OK

{

 id: [string],

 name: [string],

 category: [string],

 description: [string],

 price: [float64],

 userid: [string],       

 date: [time.Time],

 salestatus: [string],

 picid[]: [string] 

 }

Error Response

Code: 204 NO CONTENT

Code: 400 Bad Request

Code: 401 UNAUTHORIZED

Notes

Delete Item

URL

/api/items/delete/:id

METHOD

DELETE

URL Params

:id

Data Params

None

Success Response

Code: 200 Success

Error Response

Code: 400 Bad Request

Code: 401 UNAUTHORIZED

Code: 403 FORBIDDEN

Notes

Edit Item

URL

/api/items/edit/:id

METHOD

PUT

URL Params

:id

Data Params

{ 

    name: [string], 

    category: [string],

    description: [string],

    price: [string],
    
    salestatus: [string],

    picid[]: [string] 

}

Success Response

Code: 201 Created

Error Response

401 UNAUTHORIZED

400 BAD REQUEST

403 FORBIDDEN

Notes

Register User

URL

/api/users/register

METHOD

POST

URL Params

none

Data Params

 {
       email: [string],

       password:[string],

       confirm:[string],

       siteId:[string]   (8-4-4-4-12)

 }

Success Response

201: CREATED

Error Response

400 BAD REQUEST

401 UNAUTHORIZED

Notes

Authenticate

URL

/api/users/auth

METHOD

POST

URL Params

none

Data Params

{

email: [string],

password: [string],

siteId: [string] (8-4-4-4-12)

} 

Success Response

Code: 200 Success Data:

{

 token: [jwt Raw Token] 

}

Error Response

Code: 401 Unauthorized Code: 400 Bad Request Not in JSON Format!

Get Users

URL

/api/users/

METHOD

GET

URL Params

none

Data Params

none

Success Response

Code: 200 OK Data:

{

  {

      id: [string], 

      email:[string],

      firstname:[string],

      lastname:[string],

      phone:[string],

      zipcode: [string],

      picid: [string],

      url: [string]

   }, {...}, {...}

}

Error Response

Code: 400 Bad Request Code: 401 UNAUTHORIZED

Code: 500 INTERNAL SERVER ERROR

Get User

URL

/api/users/:id

METHOD

GET

URL Params

:id

Data Params

none

Success Response

Code: 200 OK Data:

 {

       id: [string], 

       email:[string],

       firstname:[string],

       lastname:[string],

       phone:[string],

       zipcode: [string],

       picid: [string],

       url: [string],

       items:[[]Item]

   }

Error Response

Code: 400 BAD REQUEST

Code: 401 UNAUTHORIZED

Update User

URL

/api/users/edit/:id

METHOD

PUT

URL Params

:id

Data Params

{ 

  firstname:[string],

  lastname:[string],

  email:[string],

  phone:[string],

  picid: [string],

  zipcode:[string]

}

Success Response

Code: 200 OK

Error Response

Code: 401 UNAUTHORIZED Code: 403 FORBIDDEN

Notes

Delete User

URL

/api/users/delete/:id

METHOD

DELETE

URL Params

:id

Data Params

none

Success Response

Code: 200 OK

Error Response

Code: 401 UNAUTHORIZED Code: 403 FORBIDDEN

Search User

URL

/api/search/:key

METHOD

GET

URL Params

:key

Data Params

none

Success Response

Code: 200 OK

 {

 id: [string], 

 email:[string],

 firstname:[string],

 lastname:[string],

 phone:[string],

 zipcode: [string],

 picid: [string],

 url: [string],

items:[[]Item] 

}

Error Response

Code: 401 UNAUTHORIZED Code: 400 Bad Request

Notes

NewImageURL

URL

/api/images/new

METHOD

POST

URL Params

None

Data Params

 {

  extension: [string] 

 }

Success Response

Code: 200 Success Data:

 {

 picid: string,

 url: string

 }

Notes

Extension is the file extension of the file you wish to upload ("jpg", "png", etc) Once you have obtained the presigned URL for the image you wish to upload, make a put request to the URL with the file in the request Body. A url to reference/get the image will be provided when you get a user or item object