🗃️Endpoints - Les membres du Spot

Lister les membres du Spot

List Spot members

GET/v1/spotMembers

Query parameters

Response

200400

Spot members returned successfully

Body

application/json

items*array of SpotMemberApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "firstname": "text",
      "lastname": "text"
    }
  ]
}

Modifier un membre du Spot

Update a spot member

PUT/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberId*string

The id of the spotMember

Body

application/json

firstnamestring

The first name of the spot member

lastnamestring

The last name of the spot member

titlestring

The title of the spot member

roleenum

The role of the spot member

MemberAdmin

statusenum

The status of the spot member

AcceptedRejectedDeactivated

avatarUrlnullable object

Response

200400404

Spot member successfully updated

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Récupérer un membre du Spot

Get a spot member

GET/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberId*string

The id of the spotMember

Response

200404

Spot member returned successfully

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Inviter un membre au Spot

Invite a spot member

POST/v1/spotMembers

Body

application/json

email*string

The email of the spot member

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

201400

Spot member has been successfully invited

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Inviter plusieurs membres au Spot

Invite multiple spot members

POST/v1/spotMembers~bulkInvite

Body

application/json

emailsarray of string

The emails of members to invite

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

201400413

Spot members has been successfully invited

Body

application/json

created*array of SpotMemberApiResponse (object)

The spot members that were created.

failed*array of CreateSpotMemberApiBody (object)

The spot members that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "created": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "firstname": "text",
      "lastname": "text"
    }
  ],
  "failed": [
    {
      "email": "text",
      "firstname": "text",
      "lastname": "text",
      "title": "text",
      "role": "Member",
      "avatarUrl": "text",
      "lang": "en",
      "theme": "light",
      "timezone": "Africa/Abidjan"
    }
  ]
}