buddy brno REST API documentation version dev

/account

patch

patch

Verify email. And more.

/auth

get

get

Responds with a JWT token when authorized (with basic authorization).

get

get

Responds with a JWT admin token

/messages

post get

post

Sends a message from logged user to receiver. Send a notification to the receiver (job does it regularly).

get
  • ?filter[threads] show a list of 'last message of every conversation'
  • ?filter[with]=username show a conversation with a single user

Sends a message from logged user to receiver. Send a notification to the receiver (job does it regularly).

    /users

    post

    post

    Create a new user wih unverified email. Verification message will be sent to the provided email.

    Create a new user wih unverified email. Verification message will be sent to the provided email.

    Body

    Media type: application/vnd.api+json

    Type: object

    Example:

    {
  "data": {
    "type": "users",
    "attributes": {
      "username": "example",
      "email": "example@example.com",
      "password": "thisShouldBeStronger",
      "role": "buddy",
      "givenName": "Foo",
      "familyName": "Bar",
      "birthday": 1500000000000,
      "gender": "female"
    }
  }
}

    HTTP status code 201

    Success

    HTTP status code 400

    Validation error

    HTTP status code 409

    Conflict, username must be unique

    patch

    patch
    • admin can activate or desactivate buddy
    • user can update her own availability
    • admin can activate or desactivate buddy
    • user can update her own availability

    URI Parameters

    • username: required (string)

    post

    post

    add a language to self

    add a language to self

    URI Parameters

    • username: required (string)

    delete

    delete

    remove a language from self

    remove a language from self

    URI Parameters

    • username: required (string)
    • language: required (string)

    /comers

    get

    get

    list verified and available comers to a buddy

    • ?filter[gender]=male,female,other
    • ?filter[age][min]=number
    • ?filter[age][max]=number
    • ?filter[language]=aa,bb,cc

    /buddies

    get

    get

    list verified, available and active buddies to a comer

    • ?filter[gender]=male,female,other
    • ?filter[age][min]=number
    • ?filter[age][max]=number
    • ?filter[language]=aa,bb,cc