Field Calendar

new_field-calendar

POST https://api.bws.ninja/v1/call

Request Body

Name	Type	Description
solution*	string	BWS.NFT.GameCube
operation*	string	new_calendar
parameters*	JSON	check method parameters

new_field-calendar Method Parameters

Parameter	Type	Desciption
fieldId	string	Field Id.
calendarId	string	Calendar Id.
description	string	The field calendar name (e.g. PSG 2025-26)
image	string	An image base64 encoded.

new_field-calendar API Call Example

new_field-calendar API call using Node.js

const axios = require('axios');

/* build request to use BWS Badges solution */
const request = {
{
  "solution": "BWS.NFT.GameCube",
  "operation": "new_field-calendar",
  "parameters":  {
      "fieldId": "8a7324f4-311d-43a8-a28f-87d9c424c354",
      "calendarId": "8a7324f4-311d-43a8-a28f-87d9c424c354",
      "description": "PSG 2025-26",
      "image": "9j/4AAQSkZJRgABAQIAHA... " /* base64 encoded image string */
  }
}

/* call BWS API using Axios */
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.bws.ninja/v1/call',
  headers: { 
    'X-Api-Key': 'XqaLg...... A5k2V729v', /* use your API key here! */
    'Content-Type': 'application/json'
  },
  data : JSON.stringify(request)
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

new_field-calendar Call Response

When the API call is successfully executed, it returns the fieldId and calendarId used to create the calendar and the related data, including the name and the image IPFS url.

{
  "statusCode": 200,
  "info": {
        "fieldId": "5a1486f3-753c-4194-b2d4-ea68b6e420c2",
        "calendarId": "8a7324f4-311d-43a8-a28f-87d9c424c354",
        "data": {
            "name": "PSG 2025-26",
            "image": "https://ipfs.bws.ninja/ipfs/QmQnRDsQPvNJ9RgT9bagHmCLQVxCyZxatkPpj3Avb1hsM8"
        }
  }
}

list_field-calendars

POST https://api.bws.ninja/v1/call

Request Body

Name	Type	Description
solution*	string	BWS.NFT.GameCube
operation*	string	list_field-calendars
parameters	JSON	check method parameters

list_field-calendars Method Parameters (optional)

Parameter	Type	Desciption
field_id	string	Field Id

list_field-calendars API Call Example

list_field-calendars API call using Node.js

const axios = require('axios');

/* build request to use BWS Badges solution */
const request = {
{
  "solution": "BWS.NFT.GameCube",
  "operation": "list_field-calendars",
  "parameters":  {
      "fieldId": "5a1486f3-753c-4194-b2d4-ea68b6e420c2"  
  }
}

/* call BWS API using Axios */
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.bws.ninja/v1/call',
  headers: { 
    'X-Api-Key': 'XqaLg...... A5k2V729v', /* use your API key here! */
    'Content-Type': 'application/json'
  },
  data : JSON.stringify(request)
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

list_field-calendars Call Response

When the API call is successfully executed, it returns the calendars list linked to the provided field.

{
  "statusCode": 200,
  "info": {
    "calendars": [
            {
                "fieldId": "5a1486f3-753c-4194-b2d4-ea68b6e420c2",
                "calendarId": "8a7324f4-311d-43a8-a28f-87d9c424c354",
                "data": {
                    "name": "PSG 2025-26",
                    "image": "https://ipfs.bws.ninja/ipfs/QmQnRDsQPvNJ9RgT9bagHmCLQVxCyZxatkPpj3Avb1hsM8"
                }
            }
        ]
  }
}

delete_field-calendar

POST https://api.bws.ninja/v1/call

Request Body

Name	Type	Description
solution*	string	BWS.NFT.GameCube
operation*	string	delete_calendar
parameters*	JSON	check method parameters

delete_field-calendar Method Parameters

Parameter	Type	Desciption
fieldId	string	The Filed Id we used to create the relationship we want to delete.
calendarId	string	The Calendar Id we used to create the relatinship to delete.

delete_field-calendar API Call Example

delete_field-calendar API call using Node.js

const axios = require('axios');

/* build request to use BWS Badges solution */
const request = {
{
  "solution": "BWS.NFT.GameCube",
  "operation": "delete_calendar",
  "parameters":  {
     "fieldId": "5a1486f3-753c-4194-b2d4-ea68b6e420c2",
     "calendarId": "8a7324f4-311d-43a8-a28f-87d9c424c354"  
  }
}

/* call BWS API using Axios */
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.bws.ninja/v1/call',
  headers: { 
    'X-Api-Key': 'XqaLg...... A5k2V729v', /* use your API key here! */
    'Content-Type': 'application/json'
  },
  data : JSON.stringify(request)
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

delete_field-calendar Call Response

When the API call is executed without errors, it returns a successful status code.

{
  "statusCode": 200
}