Back to top

Beeple Data management APIs

This is a list of APIs that someone can use to interact with Beeple as an end user. This means that all APIs calls need to be executed as a special user.

Planning

Projects

Projects are the main entity of a customer’s planning. Beeple provides an API to list all projects and one to create a project

List
GET/api/v1/admin/projects

This will return a list of all (non-deleted) projects.

Example URI

GET /api/v1/admin/projects
Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "projects": [
    {
      "id": "7",
      "name": "Example Project",
      "customer": {
        "id": "5",
        "name": "Example client"
      },
      "department": {
        "id": "5",
        "name": "Example depertment"
      },
      "description": "Description of example project",
      "start_date": "2017-08-15",
      "end_date": "2017-09-15",
      "color": "color1",
      "color_code": "'#AABBCC'",
      "published": true,
      "subprojects_enabled": true,
      "enrolment_document": "Default Callsheet",
      "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
      "planning_custom_fields_attributes": [
        {
          "tenant_planning_custom_field_group_id": 1,
          "property_type": "boolean",
          "level": "happening",
          "name_i18n_attributes": {
            "0": {
              "language": "en",
              "name": "Some name"
            }
          },
          "description_i18n_attributes": {
            "0": {
              "language": "en",
              "description": "Some description"
            }
          },
          "use_as_filter": true,
          "required": true,
          "visible_for_volunteer": true,
          "numeric_whole_number": true,
          "numeric_minimal_value": "0",
          "numeric_maximal_value": "200",
          "numeric_unit_i18n": {
            "0": {
              "language": "en",
              "numeric_unit": "kilo"
            },
            "1": {
              "language": "en",
              "numeric_unit": "kilo"
            }
          },
          "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
          "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
          "date_range_start": "2017-04-01",
          "date_range_end": "2017-04-02",
          "time_range_start": "04:00",
          "time_range_end": "17:00",
          "list_options_attributes": {
            "0": {
              "0": {
                "slug": "option_1",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              },
              "1": {
                "slug": "option_2",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              }
            },
            "1": {
              "0": {
                "slug": "option_1",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              },
              "1": {
                "slug": "option_2",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              }
            }
          },
          "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
          "sort_order": 2
        }
      ],
      "manager_id `1582`": "Hello, world!",
      "practical_info": "Some practical info",
      "default_function_id `1582`": "Hello, world!",
      "logo": "Hello, world!",
      "remove_logo": false,
      "payroll_service_interim_id": "3",
      "payroll_service_intern_id": "76",
      "payroll_service_contractual_id": "666",
      "payroll_service_freelancer_id": "1234",
      "payroll_service_collaborator_id": "7685",
      "default_minimum_age": 18,
      "customer_experience_required": false,
      "default_team_maximum_travel_distance": "1582",
      "default_registration_type": "application",
      "default_team_open_for_reservations `false`": true,
      "teams_are_published_by_default `true`": true,
      "default_number_of_collaborators `5`": 1,
      "default_shift": "Hello, world!",
      "responsible_planning_id `1582`": "Hello, world!",
      "name_i18n_attributes `1582`": {
        "0": {
          "language": "en",
          "name": "Some name"
        },
        "1": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        },
        "1": {
          "language": "en",
          "description": "Some description"
        }
      },
      "work_location_specification_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        },
        "1": {
          "language": "en",
          "description": "Some description"
        }
      },
      "work_location_id": "155",
      "work_location_specification": "Second door",
      "errors": [
        "Hello, world!"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the created project"
          },
          "name": {
            "type": "string",
            "description": "The name of the project"
          },
          "customer": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the customer of the Beeple tenant"
              },
              "name": {
                "type": "string",
                "description": "The name of this customer (max 255 characters)"
              }
            },
            "required": [
              "id"
            ]
          },
          "department": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the department of the Beeple tenant that executes the project"
              },
              "name": {
                "type": "string",
                "description": "The name of this department (max 255 characters)"
              }
            },
            "required": [
              "id"
            ]
          },
          "description": {
            "type": "string",
            "description": "A description of the project"
          },
          "start_date": {
            "type": "string",
            "description": "Start date of the project in YYYY-MM-DD"
          },
          "end_date": {
            "type": "string",
            "description": "End date of the project in YYYY-MM-DD"
          },
          "color": {
            "type": "string",
            "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
          },
          "color_code": {
            "type": "string",
            "description": "The hexadecimal code of this color"
          },
          "published": {
            "type": "boolean",
            "description": "Indication whether the project is published"
          },
          "enrolment_document": {
            "type": "string",
            "description": "Name of the enrolment document being used"
          },
          "logo_url `https://www.mysite.com/logo.png`": {
            "type": "string",
            "description": "A URL of the project logo"
          },
          "planning_custom_fields_attributes": {
            "type": "array",
            "description": "A list of extra custom planning fields."
          },
          "manager_id `1582`": {
            "type": "string",
            "description": "The ID of the supervisor of the subproject"
          },
          "practical_info": {
            "type": "string",
            "description": "Text to describe some practical info"
          },
          "default_function_id `1582`": {
            "type": "string",
            "description": "The ID of the default function of collaborators"
          },
          "logo": {
            "type": "string",
            "description": "hash of the desired logo"
          },
          "remove_logo": {
            "type": "boolean",
            "description": "Whether to remove the logo or not"
          },
          "payroll_service_interim_id": {
            "type": "string",
            "description": "Payroll service ID for the interim"
          },
          "payroll_service_intern_id": {
            "type": "string",
            "description": "Payroll service ID for interns"
          },
          "payroll_service_contractual_id": {
            "type": "string",
            "description": "Payroll service ID for contractuals"
          },
          "payroll_service_freelancer_id": {
            "type": "string",
            "description": "Payroll service ID for freelancers"
          },
          "payroll_service_collaborator_id": {
            "type": "string",
            "description": "Payroll service ID for collaborators"
          },
          "default_minimum_age": {
            "type": "number",
            "description": "The minimum age required to be employed to the project"
          },
          "customer_experience_required": {
            "type": "boolean",
            "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
          },
          "default_team_maximum_travel_distance": {
            "type": "string",
            "description": "The maximum travel distance a collaborator should have to travel"
          },
          "default_registration_type": {
            "type": "string",
            "enum": [
              "application",
              "direct_registration"
            ],
            "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
          },
          "default_team_open_for_reservations `false`": {
            "type": "boolean",
            "description": "This decides if the project is open for reservations by default."
          },
          "teams_are_published_by_default `true`": {
            "type": "boolean",
            "description": "This decides if the teams should be published by default."
          },
          "default_number_of_collaborators `5`": {
            "type": "number",
            "description": "This is used as the default number of collaborators when creating teams for this happening."
          },
          "default_shift": {
            "type": "string",
            "description": "The default start/end times and duration for Shifts."
          },
          "responsible_planning_id `1582`": {
            "type": "string",
            "description": "ID of the collaborator responsible for the planning"
          },
          "name_i18n_attributes `1582`": {
            "type": "object",
            "properties": {
              "0": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
                  },
                  "name": {
                    "type": "string",
                    "description": "the name of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "name"
                ]
              },
              "1": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
                  },
                  "name": {
                    "type": "string",
                    "description": "the name of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "name"
                ]
              }
            },
            "required": [
              "0",
              "1"
            ],
            "description": "the name of the group"
          },
          "description_i18n_attributes": {
            "type": "object",
            "properties": {
              "0": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                  },
                  "description": {
                    "type": "string",
                    "description": "the description of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "description"
                ]
              },
              "1": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                  },
                  "description": {
                    "type": "string",
                    "description": "the description of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "description"
                ]
              }
            },
            "required": [
              "0",
              "1"
            ]
          },
          "work_location_specification_i18n_attributes": {
            "type": "object",
            "properties": {
              "0": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                  },
                  "description": {
                    "type": "string",
                    "description": "the description of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "description"
                ]
              },
              "1": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string",
                    "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                  },
                  "description": {
                    "type": "string",
                    "description": "the description of the given attribute expressed in the specific `language`"
                  }
                },
                "required": [
                  "language",
                  "description"
                ]
              }
            },
            "required": [
              "0",
              "1"
            ]
          },
          "subprojects_enabled": {
            "type": "boolean",
            "description": "This allows the project to have subprojects"
          },
          "work_location_id": {
            "type": "string",
            "description": "The ID of the default work location address ID"
          },
          "work_location_specification": {
            "type": "string",
            "description": "Small description giving extra details about how to reach the destination"
          },
          "errors": {
            "type": "array",
            "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "start_date",
          "end_date",
          "published",
          "subprojects_enabled",
          "description_i18n_attributes",
          "work_location_specification_i18n_attributes",
          "subprojects_enabled"
        ]
      }
    }
  }
}

Create
POST/api/v1/admin/projects

Example URI

POST /api/v1/admin/projects
Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "project": {
    "name": "Example Project",
    "customer_id": "5",
    "customer_contact_person_name": "John Doe",
    "customer_contact_person_phone": "32498123456",
    "department_id": "5",
    "description": "Description of example project",
    "start_date": "2017-08-15",
    "end_date": "2017-09-15",
    "single_callsheet_per_collaborator": false,
    "color": "color1",
    "published": true,
    "enrolment_document_id": "7",
    "display_on_availabilities_calendar": true,
    "manager_id `1582`": "Hello, world!",
    "practical_info": "Some practical info",
    "default_function_id `1582`": "Hello, world!",
    "logo": "Hello, world!",
    "remove_logo": false,
    "payroll_service_interim_id": "3",
    "payroll_service_intern_id": "76",
    "payroll_service_contractual_id": "666",
    "payroll_service_freelancer_id": "1234",
    "payroll_service_collaborator_id": "7685",
    "default_minimum_age": 18,
    "customer_experience_required": false,
    "default_team_maximum_travel_distance": "1582",
    "default_registration_type": "application",
    "default_team_open_for_reservations `false`": true,
    "teams_are_published_by_default `true`": true,
    "default_number_of_collaborators `5`": 1,
    "default_shift_attributes": "Hello, world!",
    "responsible_planning_id `1582`": "Hello, world!",
    "name_i18n_attributes `1582`": {
      "language": "en",
      "name": "Some name"
    },
    "description_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "work_location_specification_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "subprojects_enabled": true,
    "work_location_id": "155",
    "work_location_specification": "Second door",
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ],
    "planning_custom_fields_attributes": [
      {
        "tenant_planning_custom_field_group_id": 1,
        "property_type": "boolean",
        "level": "happening",
        "name_i18n_attributes": {
          "0": {
            "language": "en",
            "name": "Some name"
          }
        },
        "description_i18n_attributes": {
          "0": {
            "language": "en",
            "description": "Some description"
          }
        },
        "use_as_filter": true,
        "required": true,
        "visible_for_volunteer": true,
        "numeric_whole_number": true,
        "numeric_minimal_value": "0",
        "numeric_maximal_value": "200",
        "numeric_unit_i18n": {
          "0": {
            "language": "en",
            "numeric_unit": "kilo"
          },
          "1": {
            "language": "en",
            "numeric_unit": "kilo"
          }
        },
        "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
        "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
        "date_range_start": "2017-04-01",
        "date_range_end": "2017-04-02",
        "time_range_start": "04:00",
        "time_range_end": "17:00",
        "list_options_attributes": {
          "0": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          },
          "1": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          }
        },
        "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
        "sort_order": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the project (max 255 characters)"
        },
        "customer_id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant. If Beeple is\n\nconfigured to not use customers this will be unnecessary information and ignored"
        },
        "customer_contact_person_name": {
          "type": "string",
          "description": "The customer's contact person name"
        },
        "customer_contact_person_phone": {
          "type": "string",
          "description": "The customer's contact person phone number"
        },
        "department_id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project. If Beeple\n\nis configured to not use departments this will be unnecessary information and ignored"
        },
        "description": {
          "type": "string",
          "description": "A description of the project"
        },
        "start_date": {
          "type": "string",
          "description": "Start date of the project in YYYY-MM-DD"
        },
        "end_date": {
          "type": "string",
          "description": "End date of the project in YYYY-MM-DD"
        },
        "single_callsheet_per_collaborator": {
          "type": "boolean",
          "description": "If no enrolment id is provided, this will decide which callsheet to use as default"
        },
        "color": {
          "type": "string",
          "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
        },
        "published": {
          "type": "boolean",
          "description": "Indication whether the project is published"
        },
        "enrolment_document_id": {
          "type": "string",
          "description": "The enrolment document ID. Can be omitted if there is only one active in the environment"
        },
        "display_on_availabilities_calendar": {
          "type": "boolean",
          "description": "Indication if should be shown on calendar. Required if tenant uses availabilities"
        },
        "manager_id `1582`": {
          "type": "string",
          "description": "The ID of the supervisor of the subproject"
        },
        "practical_info": {
          "type": "string",
          "description": "Text to describe some practical info"
        },
        "default_function_id `1582`": {
          "type": "string",
          "description": "The ID of the default function of collaborators"
        },
        "logo": {
          "type": "string",
          "description": "hash of the desired logo"
        },
        "remove_logo": {
          "type": "boolean",
          "description": "Whether to remove the logo or not"
        },
        "payroll_service_interim_id": {
          "type": "string",
          "description": "Payroll service ID for the interim"
        },
        "payroll_service_intern_id": {
          "type": "string",
          "description": "Payroll service ID for interns"
        },
        "payroll_service_contractual_id": {
          "type": "string",
          "description": "Payroll service ID for contractuals"
        },
        "payroll_service_freelancer_id": {
          "type": "string",
          "description": "Payroll service ID for freelancers"
        },
        "payroll_service_collaborator_id": {
          "type": "string",
          "description": "Payroll service ID for collaborators"
        },
        "default_minimum_age": {
          "type": "number",
          "description": "The minimum age required to be employed to the project"
        },
        "customer_experience_required": {
          "type": "boolean",
          "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
        },
        "default_team_maximum_travel_distance": {
          "type": "string",
          "description": "The maximum travel distance a collaborator should have to travel"
        },
        "default_registration_type": {
          "type": "string",
          "enum": [
            "application",
            "direct_registration"
          ],
          "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
        },
        "default_team_open_for_reservations `false`": {
          "type": "boolean",
          "description": "This decides if the project is open for reservations by default."
        },
        "teams_are_published_by_default `true`": {
          "type": "boolean",
          "description": "This decides if the teams should be published by default."
        },
        "default_number_of_collaborators `5`": {
          "type": "number",
          "description": "This is used as the default number of collaborators when creating teams for this happening."
        },
        "default_shift_attributes": {
          "type": "string",
          "description": "The default start/end times and duration for Shifts. The date part is ignored and only the time portion is relevant."
        },
        "responsible_planning_id `1582`": {
          "type": "string",
          "description": "ID of the collaborator responsible for the planning"
        },
        "name_i18n_attributes `1582`": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ],
          "description": "the name of the project"
        },
        "description_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "work_location_specification_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "subprojects_enabled": {
          "type": "boolean",
          "description": "This allows the project to have subprojects"
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the default work location address ID"
        },
        "work_location_specification": {
          "type": "string",
          "description": "Small description giving extra details about how to reach the destination"
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        },
        "planning_custom_fields_attributes": {
          "type": "array",
          "description": "A list of extra custom planning fields."
        }
      },
      "required": [
        "name",
        "description",
        "start_date",
        "end_date",
        "color",
        "published",
        "display_on_availabilities_calendar",
        "description_i18n_attributes",
        "work_location_specification_i18n_attributes",
        "subprojects_enabled"
      ],
      "description": "Project info"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "name": "Example Project",
  "customer": {
    "id": "5",
    "name": "Example client"
  },
  "department": {
    "id": "5",
    "name": "Example depertment"
  },
  "description": "Description of example project",
  "start_date": "2017-08-15",
  "end_date": "2017-09-15",
  "color": "color1",
  "color_code": "'#AABBCC'",
  "published": true,
  "subprojects_enabled": true,
  "enrolment_document": "Default Callsheet",
  "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
  "planning_custom_fields_attributes": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "manager_id `1582`": "Hello, world!",
  "practical_info": "Some practical info",
  "default_function_id `1582`": "Hello, world!",
  "logo": "Hello, world!",
  "remove_logo": false,
  "payroll_service_interim_id": "3",
  "payroll_service_intern_id": "76",
  "payroll_service_contractual_id": "666",
  "payroll_service_freelancer_id": "1234",
  "payroll_service_collaborator_id": "7685",
  "default_minimum_age": 18,
  "customer_experience_required": false,
  "default_team_maximum_travel_distance": "1582",
  "default_registration_type": "application",
  "default_team_open_for_reservations `false`": true,
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "responsible_planning_id `1582`": "Hello, world!",
  "name_i18n_attributes `1582`": {
    "0": {
      "language": "en",
      "name": "Some name"
    },
    "1": {
      "language": "en",
      "name": "Some name"
    }
  },
  "description_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_specification_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_id": "155",
  "work_location_specification": "Second door",
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created project"
    },
    "name": {
      "type": "string",
      "description": "The name of the project"
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant"
        },
        "name": {
          "type": "string",
          "description": "The name of this customer (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project"
        },
        "name": {
          "type": "string",
          "description": "The name of this department (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description of the project"
    },
    "start_date": {
      "type": "string",
      "description": "Start date of the project in YYYY-MM-DD"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the project in YYYY-MM-DD"
    },
    "color": {
      "type": "string",
      "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
    },
    "color_code": {
      "type": "string",
      "description": "The hexadecimal code of this color"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the project is published"
    },
    "enrolment_document": {
      "type": "string",
      "description": "Name of the enrolment document being used"
    },
    "logo_url `https://www.mysite.com/logo.png`": {
      "type": "string",
      "description": "A URL of the project logo"
    },
    "planning_custom_fields_attributes": {
      "type": "array",
      "description": "A list of extra custom planning fields."
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "practical_info": {
      "type": "string",
      "description": "Text to describe some practical info"
    },
    "default_function_id `1582`": {
      "type": "string",
      "description": "The ID of the default function of collaborators"
    },
    "logo": {
      "type": "string",
      "description": "hash of the desired logo"
    },
    "remove_logo": {
      "type": "boolean",
      "description": "Whether to remove the logo or not"
    },
    "payroll_service_interim_id": {
      "type": "string",
      "description": "Payroll service ID for the interim"
    },
    "payroll_service_intern_id": {
      "type": "string",
      "description": "Payroll service ID for interns"
    },
    "payroll_service_contractual_id": {
      "type": "string",
      "description": "Payroll service ID for contractuals"
    },
    "payroll_service_freelancer_id": {
      "type": "string",
      "description": "Payroll service ID for freelancers"
    },
    "payroll_service_collaborator_id": {
      "type": "string",
      "description": "Payroll service ID for collaborators"
    },
    "default_minimum_age": {
      "type": "number",
      "description": "The minimum age required to be employed to the project"
    },
    "customer_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "default_team_maximum_travel_distance": {
      "type": "string",
      "description": "The maximum travel distance a collaborator should have to travel"
    },
    "default_registration_type": {
      "type": "string",
      "enum": [
        "application",
        "direct_registration"
      ],
      "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
    },
    "default_team_open_for_reservations `false`": {
      "type": "boolean",
      "description": "This decides if the project is open for reservations by default."
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this happening."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "responsible_planning_id `1582`": {
      "type": "string",
      "description": "ID of the collaborator responsible for the planning"
    },
    "name_i18n_attributes `1582`": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ],
      "description": "the name of the group"
    },
    "description_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "work_location_specification_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "subprojects_enabled": {
      "type": "boolean",
      "description": "This allows the project to have subprojects"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the default work location address ID"
    },
    "work_location_specification": {
      "type": "string",
      "description": "Small description giving extra details about how to reach the destination"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "start_date",
    "end_date",
    "published",
    "subprojects_enabled",
    "description_i18n_attributes",
    "work_location_specification_i18n_attributes",
    "subprojects_enabled"
  ]
}

Details
GET/api/v1/admin/projects/{project_id}

Example URI

GET /api/v1/admin/projects/7
URI Parameters
HideShow
project_id
string (required) Example: 7

The project ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "name": "Example Project",
  "customer": {
    "id": "5",
    "name": "Example client"
  },
  "department": {
    "id": "5",
    "name": "Example depertment"
  },
  "description": "Description of example project",
  "start_date": "2017-08-15",
  "end_date": "2017-09-15",
  "color": "color1",
  "color_code": "'#AABBCC'",
  "published": true,
  "subprojects_enabled": true,
  "enrolment_document": "Default Callsheet",
  "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
  "planning_custom_fields_attributes": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "manager_id `1582`": "Hello, world!",
  "practical_info": "Some practical info",
  "default_function_id `1582`": "Hello, world!",
  "logo": "Hello, world!",
  "remove_logo": false,
  "payroll_service_interim_id": "3",
  "payroll_service_intern_id": "76",
  "payroll_service_contractual_id": "666",
  "payroll_service_freelancer_id": "1234",
  "payroll_service_collaborator_id": "7685",
  "default_minimum_age": 18,
  "customer_experience_required": false,
  "default_team_maximum_travel_distance": "1582",
  "default_registration_type": "application",
  "default_team_open_for_reservations `false`": true,
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "responsible_planning_id `1582`": "Hello, world!",
  "name_i18n_attributes `1582`": {
    "0": {
      "language": "en",
      "name": "Some name"
    },
    "1": {
      "language": "en",
      "name": "Some name"
    }
  },
  "description_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_specification_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_id": "155",
  "work_location_specification": "Second door",
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created project"
    },
    "name": {
      "type": "string",
      "description": "The name of the project"
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant"
        },
        "name": {
          "type": "string",
          "description": "The name of this customer (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project"
        },
        "name": {
          "type": "string",
          "description": "The name of this department (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description of the project"
    },
    "start_date": {
      "type": "string",
      "description": "Start date of the project in YYYY-MM-DD"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the project in YYYY-MM-DD"
    },
    "color": {
      "type": "string",
      "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
    },
    "color_code": {
      "type": "string",
      "description": "The hexadecimal code of this color"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the project is published"
    },
    "enrolment_document": {
      "type": "string",
      "description": "Name of the enrolment document being used"
    },
    "logo_url `https://www.mysite.com/logo.png`": {
      "type": "string",
      "description": "A URL of the project logo"
    },
    "planning_custom_fields_attributes": {
      "type": "array",
      "description": "A list of extra custom planning fields."
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "practical_info": {
      "type": "string",
      "description": "Text to describe some practical info"
    },
    "default_function_id `1582`": {
      "type": "string",
      "description": "The ID of the default function of collaborators"
    },
    "logo": {
      "type": "string",
      "description": "hash of the desired logo"
    },
    "remove_logo": {
      "type": "boolean",
      "description": "Whether to remove the logo or not"
    },
    "payroll_service_interim_id": {
      "type": "string",
      "description": "Payroll service ID for the interim"
    },
    "payroll_service_intern_id": {
      "type": "string",
      "description": "Payroll service ID for interns"
    },
    "payroll_service_contractual_id": {
      "type": "string",
      "description": "Payroll service ID for contractuals"
    },
    "payroll_service_freelancer_id": {
      "type": "string",
      "description": "Payroll service ID for freelancers"
    },
    "payroll_service_collaborator_id": {
      "type": "string",
      "description": "Payroll service ID for collaborators"
    },
    "default_minimum_age": {
      "type": "number",
      "description": "The minimum age required to be employed to the project"
    },
    "customer_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "default_team_maximum_travel_distance": {
      "type": "string",
      "description": "The maximum travel distance a collaborator should have to travel"
    },
    "default_registration_type": {
      "type": "string",
      "enum": [
        "application",
        "direct_registration"
      ],
      "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
    },
    "default_team_open_for_reservations `false`": {
      "type": "boolean",
      "description": "This decides if the project is open for reservations by default."
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this happening."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "responsible_planning_id `1582`": {
      "type": "string",
      "description": "ID of the collaborator responsible for the planning"
    },
    "name_i18n_attributes `1582`": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ],
      "description": "the name of the group"
    },
    "description_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "work_location_specification_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "subprojects_enabled": {
      "type": "boolean",
      "description": "This allows the project to have subprojects"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the default work location address ID"
    },
    "work_location_specification": {
      "type": "string",
      "description": "Small description giving extra details about how to reach the destination"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "start_date",
    "end_date",
    "published",
    "subprojects_enabled",
    "description_i18n_attributes",
    "work_location_specification_i18n_attributes",
    "subprojects_enabled"
  ]
}

Enable Subproject
POST/api/v1/admin/projects/{project_id}/enable_subprojects

Example URI

POST /api/v1/admin/projects/7/enable_subprojects
URI Parameters
HideShow
project_id
string (required) Example: 7

The project ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "name": "Example Project",
  "customer": {
    "id": "5",
    "name": "Example client"
  },
  "department": {
    "id": "5",
    "name": "Example depertment"
  },
  "description": "Description of example project",
  "start_date": "2017-08-15",
  "end_date": "2017-09-15",
  "color": "color1",
  "color_code": "'#AABBCC'",
  "published": true,
  "subprojects_enabled": true,
  "enrolment_document": "Default Callsheet",
  "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
  "planning_custom_fields_attributes": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "manager_id `1582`": "Hello, world!",
  "practical_info": "Some practical info",
  "default_function_id `1582`": "Hello, world!",
  "logo": "Hello, world!",
  "remove_logo": false,
  "payroll_service_interim_id": "3",
  "payroll_service_intern_id": "76",
  "payroll_service_contractual_id": "666",
  "payroll_service_freelancer_id": "1234",
  "payroll_service_collaborator_id": "7685",
  "default_minimum_age": 18,
  "customer_experience_required": false,
  "default_team_maximum_travel_distance": "1582",
  "default_registration_type": "application",
  "default_team_open_for_reservations `false`": true,
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "responsible_planning_id `1582`": "Hello, world!",
  "name_i18n_attributes `1582`": {
    "0": {
      "language": "en",
      "name": "Some name"
    },
    "1": {
      "language": "en",
      "name": "Some name"
    }
  },
  "description_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_specification_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_id": "155",
  "work_location_specification": "Second door",
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created project"
    },
    "name": {
      "type": "string",
      "description": "The name of the project"
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant"
        },
        "name": {
          "type": "string",
          "description": "The name of this customer (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project"
        },
        "name": {
          "type": "string",
          "description": "The name of this department (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description of the project"
    },
    "start_date": {
      "type": "string",
      "description": "Start date of the project in YYYY-MM-DD"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the project in YYYY-MM-DD"
    },
    "color": {
      "type": "string",
      "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
    },
    "color_code": {
      "type": "string",
      "description": "The hexadecimal code of this color"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the project is published"
    },
    "enrolment_document": {
      "type": "string",
      "description": "Name of the enrolment document being used"
    },
    "logo_url `https://www.mysite.com/logo.png`": {
      "type": "string",
      "description": "A URL of the project logo"
    },
    "planning_custom_fields_attributes": {
      "type": "array",
      "description": "A list of extra custom planning fields."
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "practical_info": {
      "type": "string",
      "description": "Text to describe some practical info"
    },
    "default_function_id `1582`": {
      "type": "string",
      "description": "The ID of the default function of collaborators"
    },
    "logo": {
      "type": "string",
      "description": "hash of the desired logo"
    },
    "remove_logo": {
      "type": "boolean",
      "description": "Whether to remove the logo or not"
    },
    "payroll_service_interim_id": {
      "type": "string",
      "description": "Payroll service ID for the interim"
    },
    "payroll_service_intern_id": {
      "type": "string",
      "description": "Payroll service ID for interns"
    },
    "payroll_service_contractual_id": {
      "type": "string",
      "description": "Payroll service ID for contractuals"
    },
    "payroll_service_freelancer_id": {
      "type": "string",
      "description": "Payroll service ID for freelancers"
    },
    "payroll_service_collaborator_id": {
      "type": "string",
      "description": "Payroll service ID for collaborators"
    },
    "default_minimum_age": {
      "type": "number",
      "description": "The minimum age required to be employed to the project"
    },
    "customer_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "default_team_maximum_travel_distance": {
      "type": "string",
      "description": "The maximum travel distance a collaborator should have to travel"
    },
    "default_registration_type": {
      "type": "string",
      "enum": [
        "application",
        "direct_registration"
      ],
      "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
    },
    "default_team_open_for_reservations `false`": {
      "type": "boolean",
      "description": "This decides if the project is open for reservations by default."
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this happening."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "responsible_planning_id `1582`": {
      "type": "string",
      "description": "ID of the collaborator responsible for the planning"
    },
    "name_i18n_attributes `1582`": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ],
      "description": "the name of the group"
    },
    "description_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "work_location_specification_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "subprojects_enabled": {
      "type": "boolean",
      "description": "This allows the project to have subprojects"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the default work location address ID"
    },
    "work_location_specification": {
      "type": "string",
      "description": "Small description giving extra details about how to reach the destination"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "start_date",
    "end_date",
    "published",
    "subprojects_enabled",
    "description_i18n_attributes",
    "work_location_specification_i18n_attributes",
    "subprojects_enabled"
  ]
}

Update
PATCH/api/v1/admin/projects/{project_id}

Example URI

PATCH /api/v1/admin/projects/7
URI Parameters
HideShow
project_id
string (required) Example: 7

The project ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "project": {
    "name": "Example Project",
    "customer_id": "5",
    "customer_contact_person_name": "John Doe",
    "customer_contact_person_phone": "32498123456",
    "department_id": "5",
    "description": "Description of example project",
    "start_date": "2017-08-15",
    "end_date": "2017-09-15",
    "single_callsheet_per_collaborator": false,
    "color": "color1",
    "published": true,
    "enrolment_document_id": "7",
    "display_on_availabilities_calendar": true,
    "manager_id `1582`": "Hello, world!",
    "practical_info": "Some practical info",
    "default_function_id `1582`": "Hello, world!",
    "logo": "Hello, world!",
    "remove_logo": false,
    "payroll_service_interim_id": "3",
    "payroll_service_intern_id": "76",
    "payroll_service_contractual_id": "666",
    "payroll_service_freelancer_id": "1234",
    "payroll_service_collaborator_id": "7685",
    "default_minimum_age": 18,
    "customer_experience_required": false,
    "default_team_maximum_travel_distance": "1582",
    "default_registration_type": "application",
    "default_team_open_for_reservations `false`": true,
    "teams_are_published_by_default `true`": true,
    "default_number_of_collaborators `5`": 1,
    "default_shift_attributes": "Hello, world!",
    "responsible_planning_id `1582`": "Hello, world!",
    "name_i18n_attributes `1582`": {
      "language": "en",
      "name": "Some name"
    },
    "description_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "work_location_specification_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "subprojects_enabled": true,
    "work_location_id": "155",
    "work_location_specification": "Second door",
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ],
    "planning_custom_fields_attributes": [
      {
        "tenant_planning_custom_field_group_id": 1,
        "property_type": "boolean",
        "level": "happening",
        "name_i18n_attributes": {
          "0": {
            "language": "en",
            "name": "Some name"
          }
        },
        "description_i18n_attributes": {
          "0": {
            "language": "en",
            "description": "Some description"
          }
        },
        "use_as_filter": true,
        "required": true,
        "visible_for_volunteer": true,
        "numeric_whole_number": true,
        "numeric_minimal_value": "0",
        "numeric_maximal_value": "200",
        "numeric_unit_i18n": {
          "0": {
            "language": "en",
            "numeric_unit": "kilo"
          },
          "1": {
            "language": "en",
            "numeric_unit": "kilo"
          }
        },
        "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
        "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
        "date_range_start": "2017-04-01",
        "date_range_end": "2017-04-02",
        "time_range_start": "04:00",
        "time_range_end": "17:00",
        "list_options_attributes": {
          "0": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          },
          "1": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          }
        },
        "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
        "sort_order": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the project (max 255 characters)"
        },
        "customer_id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant. If Beeple is\n\nconfigured to not use customers this will be unnecessary information and ignored"
        },
        "customer_contact_person_name": {
          "type": "string",
          "description": "The customer's contact person name"
        },
        "customer_contact_person_phone": {
          "type": "string",
          "description": "The customer's contact person phone number"
        },
        "department_id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project. If Beeple\n\nis configured to not use departments this will be unnecessary information and ignored"
        },
        "description": {
          "type": "string",
          "description": "A description of the project"
        },
        "start_date": {
          "type": "string",
          "description": "Start date of the project in YYYY-MM-DD"
        },
        "end_date": {
          "type": "string",
          "description": "End date of the project in YYYY-MM-DD"
        },
        "single_callsheet_per_collaborator": {
          "type": "boolean",
          "description": "If no enrolment id is provided, this will decide which callsheet to use as default"
        },
        "color": {
          "type": "string",
          "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
        },
        "published": {
          "type": "boolean",
          "description": "Indication whether the project is published"
        },
        "enrolment_document_id": {
          "type": "string",
          "description": "The enrolment document ID. Can be omitted if there is only one active in the environment"
        },
        "display_on_availabilities_calendar": {
          "type": "boolean",
          "description": "Indication if should be shown on calendar. Required if tenant uses availabilities"
        },
        "manager_id `1582`": {
          "type": "string",
          "description": "The ID of the supervisor of the subproject"
        },
        "practical_info": {
          "type": "string",
          "description": "Text to describe some practical info"
        },
        "default_function_id `1582`": {
          "type": "string",
          "description": "The ID of the default function of collaborators"
        },
        "logo": {
          "type": "string",
          "description": "hash of the desired logo"
        },
        "remove_logo": {
          "type": "boolean",
          "description": "Whether to remove the logo or not"
        },
        "payroll_service_interim_id": {
          "type": "string",
          "description": "Payroll service ID for the interim"
        },
        "payroll_service_intern_id": {
          "type": "string",
          "description": "Payroll service ID for interns"
        },
        "payroll_service_contractual_id": {
          "type": "string",
          "description": "Payroll service ID for contractuals"
        },
        "payroll_service_freelancer_id": {
          "type": "string",
          "description": "Payroll service ID for freelancers"
        },
        "payroll_service_collaborator_id": {
          "type": "string",
          "description": "Payroll service ID for collaborators"
        },
        "default_minimum_age": {
          "type": "number",
          "description": "The minimum age required to be employed to the project"
        },
        "customer_experience_required": {
          "type": "boolean",
          "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
        },
        "default_team_maximum_travel_distance": {
          "type": "string",
          "description": "The maximum travel distance a collaborator should have to travel"
        },
        "default_registration_type": {
          "type": "string",
          "enum": [
            "application",
            "direct_registration"
          ],
          "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
        },
        "default_team_open_for_reservations `false`": {
          "type": "boolean",
          "description": "This decides if the project is open for reservations by default."
        },
        "teams_are_published_by_default `true`": {
          "type": "boolean",
          "description": "This decides if the teams should be published by default."
        },
        "default_number_of_collaborators `5`": {
          "type": "number",
          "description": "This is used as the default number of collaborators when creating teams for this happening."
        },
        "default_shift_attributes": {
          "type": "string",
          "description": "The default start/end times and duration for Shifts. The date part is ignored and only the time portion is relevant."
        },
        "responsible_planning_id `1582`": {
          "type": "string",
          "description": "ID of the collaborator responsible for the planning"
        },
        "name_i18n_attributes `1582`": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ],
          "description": "the name of the project"
        },
        "description_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "work_location_specification_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "subprojects_enabled": {
          "type": "boolean",
          "description": "This allows the project to have subprojects"
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the default work location address ID"
        },
        "work_location_specification": {
          "type": "string",
          "description": "Small description giving extra details about how to reach the destination"
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        },
        "planning_custom_fields_attributes": {
          "type": "array",
          "description": "A list of extra custom planning fields."
        }
      },
      "required": [
        "name",
        "description",
        "start_date",
        "end_date",
        "color",
        "published",
        "display_on_availabilities_calendar",
        "description_i18n_attributes",
        "work_location_specification_i18n_attributes",
        "subprojects_enabled"
      ],
      "description": "Project info"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "name": "Example Project",
  "customer": {
    "id": "5",
    "name": "Example client"
  },
  "department": {
    "id": "5",
    "name": "Example depertment"
  },
  "description": "Description of example project",
  "start_date": "2017-08-15",
  "end_date": "2017-09-15",
  "color": "color1",
  "color_code": "'#AABBCC'",
  "published": true,
  "subprojects_enabled": true,
  "enrolment_document": "Default Callsheet",
  "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
  "planning_custom_fields_attributes": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "manager_id `1582`": "Hello, world!",
  "practical_info": "Some practical info",
  "default_function_id `1582`": "Hello, world!",
  "logo": "Hello, world!",
  "remove_logo": false,
  "payroll_service_interim_id": "3",
  "payroll_service_intern_id": "76",
  "payroll_service_contractual_id": "666",
  "payroll_service_freelancer_id": "1234",
  "payroll_service_collaborator_id": "7685",
  "default_minimum_age": 18,
  "customer_experience_required": false,
  "default_team_maximum_travel_distance": "1582",
  "default_registration_type": "application",
  "default_team_open_for_reservations `false`": true,
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "responsible_planning_id `1582`": "Hello, world!",
  "name_i18n_attributes `1582`": {
    "0": {
      "language": "en",
      "name": "Some name"
    },
    "1": {
      "language": "en",
      "name": "Some name"
    }
  },
  "description_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_specification_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_id": "155",
  "work_location_specification": "Second door",
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created project"
    },
    "name": {
      "type": "string",
      "description": "The name of the project"
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant"
        },
        "name": {
          "type": "string",
          "description": "The name of this customer (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project"
        },
        "name": {
          "type": "string",
          "description": "The name of this department (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description of the project"
    },
    "start_date": {
      "type": "string",
      "description": "Start date of the project in YYYY-MM-DD"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the project in YYYY-MM-DD"
    },
    "color": {
      "type": "string",
      "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
    },
    "color_code": {
      "type": "string",
      "description": "The hexadecimal code of this color"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the project is published"
    },
    "enrolment_document": {
      "type": "string",
      "description": "Name of the enrolment document being used"
    },
    "logo_url `https://www.mysite.com/logo.png`": {
      "type": "string",
      "description": "A URL of the project logo"
    },
    "planning_custom_fields_attributes": {
      "type": "array",
      "description": "A list of extra custom planning fields."
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "practical_info": {
      "type": "string",
      "description": "Text to describe some practical info"
    },
    "default_function_id `1582`": {
      "type": "string",
      "description": "The ID of the default function of collaborators"
    },
    "logo": {
      "type": "string",
      "description": "hash of the desired logo"
    },
    "remove_logo": {
      "type": "boolean",
      "description": "Whether to remove the logo or not"
    },
    "payroll_service_interim_id": {
      "type": "string",
      "description": "Payroll service ID for the interim"
    },
    "payroll_service_intern_id": {
      "type": "string",
      "description": "Payroll service ID for interns"
    },
    "payroll_service_contractual_id": {
      "type": "string",
      "description": "Payroll service ID for contractuals"
    },
    "payroll_service_freelancer_id": {
      "type": "string",
      "description": "Payroll service ID for freelancers"
    },
    "payroll_service_collaborator_id": {
      "type": "string",
      "description": "Payroll service ID for collaborators"
    },
    "default_minimum_age": {
      "type": "number",
      "description": "The minimum age required to be employed to the project"
    },
    "customer_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "default_team_maximum_travel_distance": {
      "type": "string",
      "description": "The maximum travel distance a collaborator should have to travel"
    },
    "default_registration_type": {
      "type": "string",
      "enum": [
        "application",
        "direct_registration"
      ],
      "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
    },
    "default_team_open_for_reservations `false`": {
      "type": "boolean",
      "description": "This decides if the project is open for reservations by default."
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this happening."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "responsible_planning_id `1582`": {
      "type": "string",
      "description": "ID of the collaborator responsible for the planning"
    },
    "name_i18n_attributes `1582`": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ],
      "description": "the name of the group"
    },
    "description_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "work_location_specification_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "subprojects_enabled": {
      "type": "boolean",
      "description": "This allows the project to have subprojects"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the default work location address ID"
    },
    "work_location_specification": {
      "type": "string",
      "description": "Small description giving extra details about how to reach the destination"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "start_date",
    "end_date",
    "published",
    "subprojects_enabled",
    "description_i18n_attributes",
    "work_location_specification_i18n_attributes",
    "subprojects_enabled"
  ]
}

Delete project
DELETE/api/v1/admin/projects/{project_id}

Example URI

DELETE /api/v1/admin/projects/7
URI Parameters
HideShow
project_id
string (required) Example: 7

The project ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "name": "Example Project",
  "customer": {
    "id": "5",
    "name": "Example client"
  },
  "department": {
    "id": "5",
    "name": "Example depertment"
  },
  "description": "Description of example project",
  "start_date": "2017-08-15",
  "end_date": "2017-09-15",
  "color": "color1",
  "color_code": "'#AABBCC'",
  "published": true,
  "subprojects_enabled": true,
  "enrolment_document": "Default Callsheet",
  "logo_url `https://www.mysite.com/logo.png`": "Hello, world!",
  "planning_custom_fields_attributes": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "manager_id `1582`": "Hello, world!",
  "practical_info": "Some practical info",
  "default_function_id `1582`": "Hello, world!",
  "logo": "Hello, world!",
  "remove_logo": false,
  "payroll_service_interim_id": "3",
  "payroll_service_intern_id": "76",
  "payroll_service_contractual_id": "666",
  "payroll_service_freelancer_id": "1234",
  "payroll_service_collaborator_id": "7685",
  "default_minimum_age": 18,
  "customer_experience_required": false,
  "default_team_maximum_travel_distance": "1582",
  "default_registration_type": "application",
  "default_team_open_for_reservations `false`": true,
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "responsible_planning_id `1582`": "Hello, world!",
  "name_i18n_attributes `1582`": {
    "0": {
      "language": "en",
      "name": "Some name"
    },
    "1": {
      "language": "en",
      "name": "Some name"
    }
  },
  "description_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_specification_i18n_attributes": {
    "0": {
      "language": "en",
      "description": "Some description"
    },
    "1": {
      "language": "en",
      "description": "Some description"
    }
  },
  "work_location_id": "155",
  "work_location_specification": "Second door",
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created project"
    },
    "name": {
      "type": "string",
      "description": "The name of the project"
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the customer of the Beeple tenant"
        },
        "name": {
          "type": "string",
          "description": "The name of this customer (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the department of the Beeple tenant that executes the project"
        },
        "name": {
          "type": "string",
          "description": "The name of this department (max 255 characters)"
        }
      },
      "required": [
        "id"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description of the project"
    },
    "start_date": {
      "type": "string",
      "description": "Start date of the project in YYYY-MM-DD"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the project in YYYY-MM-DD"
    },
    "color": {
      "type": "string",
      "description": "Color used to present the project in calendars. The number refers to the presentation of the colors left to right when creating a project on screen in the Beeple application"
    },
    "color_code": {
      "type": "string",
      "description": "The hexadecimal code of this color"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the project is published"
    },
    "enrolment_document": {
      "type": "string",
      "description": "Name of the enrolment document being used"
    },
    "logo_url `https://www.mysite.com/logo.png`": {
      "type": "string",
      "description": "A URL of the project logo"
    },
    "planning_custom_fields_attributes": {
      "type": "array",
      "description": "A list of extra custom planning fields."
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "practical_info": {
      "type": "string",
      "description": "Text to describe some practical info"
    },
    "default_function_id `1582`": {
      "type": "string",
      "description": "The ID of the default function of collaborators"
    },
    "logo": {
      "type": "string",
      "description": "hash of the desired logo"
    },
    "remove_logo": {
      "type": "boolean",
      "description": "Whether to remove the logo or not"
    },
    "payroll_service_interim_id": {
      "type": "string",
      "description": "Payroll service ID for the interim"
    },
    "payroll_service_intern_id": {
      "type": "string",
      "description": "Payroll service ID for interns"
    },
    "payroll_service_contractual_id": {
      "type": "string",
      "description": "Payroll service ID for contractuals"
    },
    "payroll_service_freelancer_id": {
      "type": "string",
      "description": "Payroll service ID for freelancers"
    },
    "payroll_service_collaborator_id": {
      "type": "string",
      "description": "Payroll service ID for collaborators"
    },
    "default_minimum_age": {
      "type": "number",
      "description": "The minimum age required to be employed to the project"
    },
    "customer_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "default_team_maximum_travel_distance": {
      "type": "string",
      "description": "The maximum travel distance a collaborator should have to travel"
    },
    "default_registration_type": {
      "type": "string",
      "enum": [
        "application",
        "direct_registration"
      ],
      "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
    },
    "default_team_open_for_reservations `false`": {
      "type": "boolean",
      "description": "This decides if the project is open for reservations by default."
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this happening."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "responsible_planning_id `1582`": {
      "type": "string",
      "description": "ID of the collaborator responsible for the planning"
    },
    "name_i18n_attributes `1582`": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ],
      "description": "the name of the group"
    },
    "description_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "work_location_specification_i18n_attributes": {
      "type": "object",
      "properties": {
        "0": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        },
        "1": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
            },
            "description": {
              "type": "string",
              "description": "the description of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "description"
          ]
        }
      },
      "required": [
        "0",
        "1"
      ]
    },
    "subprojects_enabled": {
      "type": "boolean",
      "description": "This allows the project to have subprojects"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the default work location address ID"
    },
    "work_location_specification": {
      "type": "string",
      "description": "Small description giving extra details about how to reach the destination"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe project. The keys refer to the name of the field (eg. start_date) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "start_date",
    "end_date",
    "published",
    "subprojects_enabled",
    "description_i18n_attributes",
    "work_location_specification_i18n_attributes",
    "subprojects_enabled"
  ]
}

Subprojects

Subprojects are the more detailed level of customer’s planning. A subproject is always part of exactly one project. Beeple provides an API to list all subprojects of a project and one to create a subproject within a project

Get list of subprojects
GET/api/v1/admin/projects/{project_id}/subprojects{?page}

Example URI

GET /api/v1/admin/projects/87643/subprojects?page=2
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the project that you want to manage subprojects of

page
number (optional) Example: 2

The paginated page number.

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "filter": {
    "period_start_at": "Hello, world!",
    "period_end_at": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "filter": {
      "type": "object",
      "properties": {
        "period_start_at": {
          "type": "string"
        },
        "period_end_at": {
          "type": "string"
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "subprojects": [
    {
      "id": "17",
      "name": "Example Subproject",
      "customer_contact_person_name": "John Doe",
      "customer_contact_person_phone": "32498123456",
      "manager_id `1582`": "Hello, world!",
      "start_date `2019-09-11`": "Hello, world!",
      "end_date `2019-09-15`": "Hello, world!",
      "teams_are_published_by_default `true`": true,
      "default_number_of_collaborators `5`": 1,
      "default_shift": "Hello, world!",
      "project_id `7`": "Hello, world!",
      "planning_custom_fields_attributes `7`": [
        {
          "tenant_planning_custom_field_group_id": 1,
          "property_type": "boolean",
          "level": "happening",
          "name_i18n_attributes": {
            "0": {
              "language": "en",
              "name": "Some name"
            }
          },
          "description_i18n_attributes": {
            "0": {
              "language": "en",
              "description": "Some description"
            }
          },
          "use_as_filter": true,
          "required": true,
          "visible_for_volunteer": true,
          "numeric_whole_number": true,
          "numeric_minimal_value": "0",
          "numeric_maximal_value": "200",
          "numeric_unit_i18n": {
            "0": {
              "language": "en",
              "numeric_unit": "kilo"
            },
            "1": {
              "language": "en",
              "numeric_unit": "kilo"
            }
          },
          "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
          "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
          "date_range_start": "2017-04-01",
          "date_range_end": "2017-04-02",
          "time_range_start": "04:00",
          "time_range_end": "17:00",
          "list_options_attributes": {
            "0": {
              "0": {
                "slug": "option_1",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              },
              "1": {
                "slug": "option_2",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              }
            },
            "1": {
              "0": {
                "slug": "option_1",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              },
              "1": {
                "slug": "option_2",
                "title_i18n_attributes": {
                  "0": {
                    "language": "en",
                    "title": "My 2nd option"
                  },
                  "1": {
                    "language": "en",
                    "title": "My 2nd option"
                  }
                }
              }
            }
          },
          "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
          "sort_order": 2
        }
      ],
      "errors": [
        "Hello, world!"
      ]
    }
  ],
  "next": "Hello, world!",
  "prev": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "subprojects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the created subproject"
          },
          "name": {
            "type": "string",
            "description": "The name of the subproject"
          },
          "customer_contact_person_name": {
            "type": "string",
            "description": "The customer's contact person name"
          },
          "customer_contact_person_phone": {
            "type": "string",
            "description": "The customer's contact person phone number"
          },
          "manager_id `1582`": {
            "type": "string",
            "description": "The ID of the supervisor of the subproject"
          },
          "start_date `2019-09-11`": {
            "type": "string",
            "description": "The start date of the subproject"
          },
          "end_date `2019-09-15`": {
            "type": "string",
            "description": "The end date of the subproject"
          },
          "teams_are_published_by_default `true`": {
            "type": "boolean",
            "description": "This decides if the teams should be published by default."
          },
          "default_number_of_collaborators `5`": {
            "type": "number",
            "description": "This is used as the default number of collaborators when creating teams for this cluster."
          },
          "default_shift": {
            "type": "string",
            "description": "The default start/end times and duration for Shifts."
          },
          "project_id `7`": {
            "type": "string",
            "description": "The ID of the project to which the subproject belongs"
          },
          "planning_custom_fields_attributes `7`": {
            "type": "array",
            "description": "The ID of the project to which the subproject belongs"
          },
          "errors": {
            "type": "array",
            "description": "A key-value list of any errors encountered while creating\n\nthe subproject. The keys refer to the name of the field (eg. manager_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
          }
        },
        "required": [
          "id",
          "name",
          "start_date `2019-09-11`",
          "end_date `2019-09-15`",
          "project_id `7`",
          "planning_custom_fields_attributes `7`"
        ]
      }
    },
    "next": {
      "type": "string",
      "description": "The URL of the next page result"
    },
    "prev": {
      "type": "string",
      "description": "The URL of the previous page results"
    }
  }
}

Create
POST/api/v1/admin/projects/{project_id}/subprojects

Example URI

POST /api/v1/admin/projects/87643/subprojects
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the project that you want to manage subprojects of

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "subproject": {
    "name": "Example Subproject",
    "customer_contact_person_name": "John Doe",
    "customer_contact_person_phone": "32498123456",
    "manager_id `1582`": "Hello, world!",
    "responsible_planning_id `1582`": "Hello, world!",
    "default_function_id `1582`": "Hello, world!",
    "default_team_minimum_age `18`": 1,
    "default_team_customer_experience_required `false`": true,
    "default_team_maximum_travel_distance `152`": 1,
    "default_registration_type": "application",
    "default_team_open_for_reservations `false`": true,
    "work_location_id": "120",
    "work_location_specification": "At the entrance",
    "teams_are_published_by_default `true`": true,
    "default_number_of_collaborators `5`": 1,
    "default_shift_attributes": "Hello, world!",
    "name_i18n_attributes `1582`": {
      "language": "en",
      "name": "Some name"
    },
    "start_date `2019-09-11`": "Hello, world!",
    "end_date `2019-09-15`": "Hello, world!",
    "work_location_specification_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ],
    "planning_custom_fields_attributes": [
      {
        "tenant_planning_custom_field_group_id": 1,
        "property_type": "boolean",
        "level": "happening",
        "name_i18n_attributes": {
          "0": {
            "language": "en",
            "name": "Some name"
          }
        },
        "description_i18n_attributes": {
          "0": {
            "language": "en",
            "description": "Some description"
          }
        },
        "use_as_filter": true,
        "required": true,
        "visible_for_volunteer": true,
        "numeric_whole_number": true,
        "numeric_minimal_value": "0",
        "numeric_maximal_value": "200",
        "numeric_unit_i18n": {
          "0": {
            "language": "en",
            "numeric_unit": "kilo"
          },
          "1": {
            "language": "en",
            "numeric_unit": "kilo"
          }
        },
        "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
        "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
        "date_range_start": "2017-04-01",
        "date_range_end": "2017-04-02",
        "time_range_start": "04:00",
        "time_range_end": "17:00",
        "list_options_attributes": {
          "0": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          },
          "1": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          }
        },
        "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
        "sort_order": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "subproject": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the subproject"
        },
        "customer_contact_person_name": {
          "type": "string",
          "description": "The customer's contact person name"
        },
        "customer_contact_person_phone": {
          "type": "string",
          "description": "The customer's contact person phone number"
        },
        "manager_id `1582`": {
          "type": "string",
          "description": "The ID of the supervisor of the subproject"
        },
        "responsible_planning_id `1582`": {
          "type": "string",
          "description": "ID of the collaborator responsible for the planning"
        },
        "default_function_id `1582`": {
          "type": "string",
          "description": "The ID of the default function of collaborators"
        },
        "default_team_minimum_age `18`": {
          "type": "number",
          "description": "The minimum age required to be employed to the subproject"
        },
        "default_team_customer_experience_required `false`": {
          "type": "boolean",
          "description": "Whether or not the team should have customer experience."
        },
        "default_team_maximum_travel_distance `152`": {
          "type": "number",
          "description": "The maximum travel distance a collaborator should have to travel"
        },
        "default_registration_type": {
          "type": "string",
          "enum": [
            "application",
            "direct_registration"
          ],
          "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
        },
        "default_team_open_for_reservations `false`": {
          "type": "boolean",
          "description": "This decides if the project is open for reservations by default."
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the address of the work station"
        },
        "work_location_specification": {
          "type": "string",
          "description": "An addition to the work station"
        },
        "teams_are_published_by_default `true`": {
          "type": "boolean",
          "description": "This decides if the teams should be published by default."
        },
        "default_number_of_collaborators `5`": {
          "type": "number",
          "description": "This is used as the default number of collaborators when creating teams for this cluster."
        },
        "default_shift_attributes": {
          "type": "string",
          "description": "The default start/end times and duration for Shifts. The date part is ignored and only the time portion is relevant."
        },
        "name_i18n_attributes `1582`": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ],
          "description": "the name of the group"
        },
        "start_date `2019-09-11`": {
          "type": "string",
          "description": "The start date of the subproject"
        },
        "end_date `2019-09-15`": {
          "type": "string",
          "description": "The end date of the subproject"
        },
        "work_location_specification_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        },
        "planning_custom_fields_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        }
      },
      "required": [
        "name",
        "start_date `2019-09-11`",
        "end_date `2019-09-15`",
        "work_location_specification_i18n_attributes"
      ]
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "17",
  "name": "Example Subproject",
  "customer_contact_person_name": "John Doe",
  "customer_contact_person_phone": "32498123456",
  "manager_id `1582`": "Hello, world!",
  "start_date `2019-09-11`": "Hello, world!",
  "end_date `2019-09-15`": "Hello, world!",
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "project_id `7`": "Hello, world!",
  "planning_custom_fields_attributes `7`": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created subproject"
    },
    "name": {
      "type": "string",
      "description": "The name of the subproject"
    },
    "customer_contact_person_name": {
      "type": "string",
      "description": "The customer's contact person name"
    },
    "customer_contact_person_phone": {
      "type": "string",
      "description": "The customer's contact person phone number"
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "start_date `2019-09-11`": {
      "type": "string",
      "description": "The start date of the subproject"
    },
    "end_date `2019-09-15`": {
      "type": "string",
      "description": "The end date of the subproject"
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this cluster."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "project_id `7`": {
      "type": "string",
      "description": "The ID of the project to which the subproject belongs"
    },
    "planning_custom_fields_attributes `7`": {
      "type": "array",
      "description": "The ID of the project to which the subproject belongs"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe subproject. The keys refer to the name of the field (eg. manager_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "start_date `2019-09-11`",
    "end_date `2019-09-15`",
    "project_id `7`",
    "planning_custom_fields_attributes `7`"
  ]
}

Update
PATCH/api/v1/admin/projects/{project_id}/subprojects/{sub_project_id}

Example URI

PATCH /api/v1/admin/projects/87643/subprojects/7896
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the project that you want to manage subprojects of

sub_project_id
string (required) Example: 7896

The Beeple ID of the subproject

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "subproject": {
    "name": "Example Subproject",
    "customer_contact_person_name": "John Doe",
    "customer_contact_person_phone": "32498123456",
    "manager_id `1582`": "Hello, world!",
    "responsible_planning_id `1582`": "Hello, world!",
    "default_function_id `1582`": "Hello, world!",
    "default_team_minimum_age `18`": 1,
    "default_team_customer_experience_required `false`": true,
    "default_team_maximum_travel_distance `152`": 1,
    "default_registration_type": "application",
    "default_team_open_for_reservations `false`": true,
    "work_location_id": "120",
    "work_location_specification": "At the entrance",
    "teams_are_published_by_default `true`": true,
    "default_number_of_collaborators `5`": 1,
    "default_shift_attributes": "Hello, world!",
    "name_i18n_attributes `1582`": {
      "language": "en",
      "name": "Some name"
    },
    "start_date `2019-09-11`": "Hello, world!",
    "end_date `2019-09-15`": "Hello, world!",
    "work_location_specification_i18n_attributes": {
      "0": {
        "language": "en",
        "description": "Some description"
      },
      "1": {
        "language": "en",
        "description": "Some description"
      }
    },
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ],
    "planning_custom_fields_attributes": [
      {
        "tenant_planning_custom_field_group_id": 1,
        "property_type": "boolean",
        "level": "happening",
        "name_i18n_attributes": {
          "0": {
            "language": "en",
            "name": "Some name"
          }
        },
        "description_i18n_attributes": {
          "0": {
            "language": "en",
            "description": "Some description"
          }
        },
        "use_as_filter": true,
        "required": true,
        "visible_for_volunteer": true,
        "numeric_whole_number": true,
        "numeric_minimal_value": "0",
        "numeric_maximal_value": "200",
        "numeric_unit_i18n": {
          "0": {
            "language": "en",
            "numeric_unit": "kilo"
          },
          "1": {
            "language": "en",
            "numeric_unit": "kilo"
          }
        },
        "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
        "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
        "date_range_start": "2017-04-01",
        "date_range_end": "2017-04-02",
        "time_range_start": "04:00",
        "time_range_end": "17:00",
        "list_options_attributes": {
          "0": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          },
          "1": {
            "0": {
              "slug": "option_1",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            },
            "1": {
              "slug": "option_2",
              "title_i18n_attributes": {
                "0": {
                  "language": "en",
                  "title": "My 2nd option"
                },
                "1": {
                  "language": "en",
                  "title": "My 2nd option"
                }
              }
            }
          }
        },
        "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
        "sort_order": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "subproject": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the subproject"
        },
        "customer_contact_person_name": {
          "type": "string",
          "description": "The customer's contact person name"
        },
        "customer_contact_person_phone": {
          "type": "string",
          "description": "The customer's contact person phone number"
        },
        "manager_id `1582`": {
          "type": "string",
          "description": "The ID of the supervisor of the subproject"
        },
        "responsible_planning_id `1582`": {
          "type": "string",
          "description": "ID of the collaborator responsible for the planning"
        },
        "default_function_id `1582`": {
          "type": "string",
          "description": "The ID of the default function of collaborators"
        },
        "default_team_minimum_age `18`": {
          "type": "number",
          "description": "The minimum age required to be employed to the subproject"
        },
        "default_team_customer_experience_required `false`": {
          "type": "boolean",
          "description": "Whether or not the team should have customer experience."
        },
        "default_team_maximum_travel_distance `152`": {
          "type": "number",
          "description": "The maximum travel distance a collaborator should have to travel"
        },
        "default_registration_type": {
          "type": "string",
          "enum": [
            "application",
            "direct_registration"
          ],
          "description": "Decides whether the default registrations is a candidacy or an immediate enrolment"
        },
        "default_team_open_for_reservations `false`": {
          "type": "boolean",
          "description": "This decides if the project is open for reservations by default."
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the address of the work station"
        },
        "work_location_specification": {
          "type": "string",
          "description": "An addition to the work station"
        },
        "teams_are_published_by_default `true`": {
          "type": "boolean",
          "description": "This decides if the teams should be published by default."
        },
        "default_number_of_collaborators `5`": {
          "type": "number",
          "description": "This is used as the default number of collaborators when creating teams for this cluster."
        },
        "default_shift_attributes": {
          "type": "string",
          "description": "The default start/end times and duration for Shifts. The date part is ignored and only the time portion is relevant."
        },
        "name_i18n_attributes `1582`": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `name`."
            },
            "name": {
              "type": "string",
              "description": "the name of the given attribute expressed in the specific `language`"
            }
          },
          "required": [
            "language",
            "name"
          ],
          "description": "the name of the group"
        },
        "start_date `2019-09-11`": {
          "type": "string",
          "description": "The start date of the subproject"
        },
        "end_date `2019-09-15`": {
          "type": "string",
          "description": "The end date of the subproject"
        },
        "work_location_specification_i18n_attributes": {
          "type": "object",
          "properties": {
            "0": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            },
            "1": {
              "type": "object",
              "properties": {
                "language": {
                  "type": "string",
                  "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the language used in `description`"
                },
                "description": {
                  "type": "string",
                  "description": "the description of the given attribute expressed in the specific `language`"
                }
              },
              "required": [
                "language",
                "description"
              ]
            }
          },
          "required": [
            "0",
            "1"
          ]
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        },
        "planning_custom_fields_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        }
      },
      "required": [
        "name",
        "start_date `2019-09-11`",
        "end_date `2019-09-15`",
        "work_location_specification_i18n_attributes"
      ]
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "17",
  "name": "Example Subproject",
  "customer_contact_person_name": "John Doe",
  "customer_contact_person_phone": "32498123456",
  "manager_id `1582`": "Hello, world!",
  "start_date `2019-09-11`": "Hello, world!",
  "end_date `2019-09-15`": "Hello, world!",
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "project_id `7`": "Hello, world!",
  "planning_custom_fields_attributes `7`": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created subproject"
    },
    "name": {
      "type": "string",
      "description": "The name of the subproject"
    },
    "customer_contact_person_name": {
      "type": "string",
      "description": "The customer's contact person name"
    },
    "customer_contact_person_phone": {
      "type": "string",
      "description": "The customer's contact person phone number"
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "start_date `2019-09-11`": {
      "type": "string",
      "description": "The start date of the subproject"
    },
    "end_date `2019-09-15`": {
      "type": "string",
      "description": "The end date of the subproject"
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this cluster."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "project_id `7`": {
      "type": "string",
      "description": "The ID of the project to which the subproject belongs"
    },
    "planning_custom_fields_attributes `7`": {
      "type": "array",
      "description": "The ID of the project to which the subproject belongs"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe subproject. The keys refer to the name of the field (eg. manager_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "start_date `2019-09-11`",
    "end_date `2019-09-15`",
    "project_id `7`",
    "planning_custom_fields_attributes `7`"
  ]
}

Delete
DELETE/api/v1/admin/projects/{project_id}/subprojects/{sub_project_id}

Example URI

DELETE /api/v1/admin/projects/87643/subprojects/7896
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the project that you want to manage subprojects of

sub_project_id
string (required) Example: 7896

The Beeple ID of the subproject

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "17",
  "name": "Example Subproject",
  "customer_contact_person_name": "John Doe",
  "customer_contact_person_phone": "32498123456",
  "manager_id `1582`": "Hello, world!",
  "start_date `2019-09-11`": "Hello, world!",
  "end_date `2019-09-15`": "Hello, world!",
  "teams_are_published_by_default `true`": true,
  "default_number_of_collaborators `5`": 1,
  "default_shift": "Hello, world!",
  "project_id `7`": "Hello, world!",
  "planning_custom_fields_attributes `7`": [
    {
      "tenant_planning_custom_field_group_id": 1,
      "property_type": "boolean",
      "level": "happening",
      "name_i18n_attributes": {
        "0": {
          "language": "en",
          "name": "Some name"
        }
      },
      "description_i18n_attributes": {
        "0": {
          "language": "en",
          "description": "Some description"
        }
      },
      "use_as_filter": true,
      "required": true,
      "visible_for_volunteer": true,
      "numeric_whole_number": true,
      "numeric_minimal_value": "0",
      "numeric_maximal_value": "200",
      "numeric_unit_i18n": {
        "0": {
          "language": "en",
          "numeric_unit": "kilo"
        },
        "1": {
          "language": "en",
          "numeric_unit": "kilo"
        }
      },
      "datetime_range_start": "2018-04-01T10:10:00.000+02:00",
      "datetime_range_end": "2018-04-01T12:10:00.000+02:00",
      "date_range_start": "2017-04-01",
      "date_range_end": "2017-04-02",
      "time_range_start": "04:00",
      "time_range_end": "17:00",
      "list_options_attributes": {
        "0": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        },
        "1": {
          "0": {
            "slug": "option_1",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          },
          "1": {
            "slug": "option_2",
            "title_i18n_attributes": {
              "0": {
                "language": "en",
                "title": "My 2nd option"
              },
              "1": {
                "language": "en",
                "title": "My 2nd option"
              }
            }
          }
        }
      },
      "template_name: `MY_PROFILE_PROP_1`": "Hello, world!",
      "sort_order": 2
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created subproject"
    },
    "name": {
      "type": "string",
      "description": "The name of the subproject"
    },
    "customer_contact_person_name": {
      "type": "string",
      "description": "The customer's contact person name"
    },
    "customer_contact_person_phone": {
      "type": "string",
      "description": "The customer's contact person phone number"
    },
    "manager_id `1582`": {
      "type": "string",
      "description": "The ID of the supervisor of the subproject"
    },
    "start_date `2019-09-11`": {
      "type": "string",
      "description": "The start date of the subproject"
    },
    "end_date `2019-09-15`": {
      "type": "string",
      "description": "The end date of the subproject"
    },
    "teams_are_published_by_default `true`": {
      "type": "boolean",
      "description": "This decides if the teams should be published by default."
    },
    "default_number_of_collaborators `5`": {
      "type": "number",
      "description": "This is used as the default number of collaborators when creating teams for this cluster."
    },
    "default_shift": {
      "type": "string",
      "description": "The default start/end times and duration for Shifts."
    },
    "project_id `7`": {
      "type": "string",
      "description": "The ID of the project to which the subproject belongs"
    },
    "planning_custom_fields_attributes `7`": {
      "type": "array",
      "description": "The ID of the project to which the subproject belongs"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe subproject. The keys refer to the name of the field (eg. manager_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "name",
    "start_date `2019-09-11`",
    "end_date `2019-09-15`",
    "project_id `7`",
    "planning_custom_fields_attributes `7`"
  ]
}

Teams

Teams are the most detailed planning level in Beeple. A team is always part of exactly one subproject and one project. Beeple provides an API to list all teams of a subproject and one to create a team within a subproject

List in project
GET/api/v1/admin/projects/{project_id}/teams

Example URI

GET /api/v1/admin/projects/87643/teams
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the subproject that you want to manage teams of

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "teams": [
    {
      "id": "27",
      "name": "Example Team",
      "function": {
        "id": "7",
        "name": "A Name",
        "description": "A longer description"
      },
      "extra_practical_info": "Some practical info",
      "volunteers_needed": 5,
      "minimal_age": 18,
      "client_experience_required": false,
      "work_location_id": "120",
      "work_location_specification": "At the entrance",
      "registrations_via_application": true,
      "published": true,
      "relative_checkin_start": "00:30",
      "relative_checkin_duration": "00:15",
      "checkin_appointment_id": "157",
      "maximum_travel_distance": 20,
      "shifts_attributes": [
        {
          "start_datetime": "2017-04-01T09:00:00.000+02:00",
          "end_datetime": "2017-04-01T18:00:00.000+02:00",
          "break_duration": "00:30"
        }
      ],
      "contract_details_attributes": [
        {
          "contract_type": "volunteer",
          "be_collar_type": "arbeider",
          "local_legal_entity_id": "4",
          "compensation_hour_id": "3",
          "compensation_day_id": "1",
          "compensation_team_id": "2"
        }
      ],
      "planning_custom_fields": [
        {
          "planning_custom_field_id": "123",
          "value": "Some text"
        }
      ],
      "errors": [
        "Hello, world!"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "teams": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the created team"
          },
          "name": {
            "type": "string",
            "description": "The team name. Does not need to be passed, if automatic_name is true"
          },
          "function": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the function"
              },
              "name": {
                "type": "string",
                "description": "The name of the function"
              },
              "description": {
                "type": "string",
                "description": "The longer description"
              }
            },
            "description": "The function of the team"
          },
          "extra_practical_info": {
            "type": "string",
            "description": "Text to describe some extra info"
          },
          "volunteers_needed": {
            "type": "number",
            "description": "The number of collaborators needed"
          },
          "minimal_age": {
            "type": "number",
            "description": "The minimal age for collaborators to be enrolled in this team"
          },
          "client_experience_required": {
            "type": "boolean",
            "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
          },
          "work_location_id": {
            "type": "string",
            "description": "The ID of the address of the work station"
          },
          "work_location_specification": {
            "type": "string",
            "description": "An addition to the work station"
          },
          "registrations_via_application": {
            "type": "boolean",
            "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
          },
          "published": {
            "type": "boolean",
            "description": "Indication whether the team is published"
          },
          "relative_checkin_start": {
            "type": "string",
            "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
          },
          "relative_checkin_duration": {
            "type": "string",
            "description": "A time (HH:MM) to indicate how long the checkin lasts"
          },
          "checkin_appointment_id": {
            "type": "string",
            "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
          },
          "maximum_travel_distance": {
            "type": "number",
            "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
          },
          "shifts_attributes": {
            "type": "array",
            "description": "A list of shifts"
          },
          "contract_details_attributes": {
            "type": "array",
            "description": "A list of contract details"
          },
          "planning_custom_fields": {
            "type": "array",
            "description": "A list of planning custom fields"
          },
          "errors": {
            "type": "array",
            "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
          }
        },
        "required": [
          "id",
          "volunteers_needed",
          "work_location_id",
          "work_location_specification",
          "published",
          "shifts_attributes"
        ]
      }
    }
  }
}

List in subproject
GET/api/v1/admin/subprojects/{subproject_id}/teams{?page}

Example URI

GET /api/v1/admin/subprojects/87643/teams?page=2
URI Parameters
HideShow
subproject_id
string (required) Example: 87643

The Beeple ID of the subproject that you want to manage teams of

page
number (optional) Example: 2

The paginated page number.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "teams": [
    {
      "id": "27",
      "name": "Example Team",
      "function": {
        "id": "7",
        "name": "A Name",
        "description": "A longer description"
      },
      "extra_practical_info": "Some practical info",
      "volunteers_needed": 5,
      "minimal_age": 18,
      "client_experience_required": false,
      "work_location_id": "120",
      "work_location_specification": "At the entrance",
      "registrations_via_application": true,
      "published": true,
      "relative_checkin_start": "00:30",
      "relative_checkin_duration": "00:15",
      "checkin_appointment_id": "157",
      "maximum_travel_distance": 20,
      "shifts_attributes": [
        {
          "start_datetime": "2017-04-01T09:00:00.000+02:00",
          "end_datetime": "2017-04-01T18:00:00.000+02:00",
          "break_duration": "00:30"
        }
      ],
      "contract_details_attributes": [
        {
          "contract_type": "volunteer",
          "be_collar_type": "arbeider",
          "local_legal_entity_id": "4",
          "compensation_hour_id": "3",
          "compensation_day_id": "1",
          "compensation_team_id": "2"
        }
      ],
      "planning_custom_fields": [
        {
          "planning_custom_field_id": "123",
          "value": "Some text"
        }
      ],
      "errors": [
        "Hello, world!"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "teams": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the created team"
          },
          "name": {
            "type": "string",
            "description": "The team name. Does not need to be passed, if automatic_name is true"
          },
          "function": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the function"
              },
              "name": {
                "type": "string",
                "description": "The name of the function"
              },
              "description": {
                "type": "string",
                "description": "The longer description"
              }
            },
            "description": "The function of the team"
          },
          "extra_practical_info": {
            "type": "string",
            "description": "Text to describe some extra info"
          },
          "volunteers_needed": {
            "type": "number",
            "description": "The number of collaborators needed"
          },
          "minimal_age": {
            "type": "number",
            "description": "The minimal age for collaborators to be enrolled in this team"
          },
          "client_experience_required": {
            "type": "boolean",
            "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
          },
          "work_location_id": {
            "type": "string",
            "description": "The ID of the address of the work station"
          },
          "work_location_specification": {
            "type": "string",
            "description": "An addition to the work station"
          },
          "registrations_via_application": {
            "type": "boolean",
            "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
          },
          "published": {
            "type": "boolean",
            "description": "Indication whether the team is published"
          },
          "relative_checkin_start": {
            "type": "string",
            "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
          },
          "relative_checkin_duration": {
            "type": "string",
            "description": "A time (HH:MM) to indicate how long the checkin lasts"
          },
          "checkin_appointment_id": {
            "type": "string",
            "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
          },
          "maximum_travel_distance": {
            "type": "number",
            "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
          },
          "shifts_attributes": {
            "type": "array",
            "description": "A list of shifts"
          },
          "contract_details_attributes": {
            "type": "array",
            "description": "A list of contract details"
          },
          "planning_custom_fields": {
            "type": "array",
            "description": "A list of planning custom fields"
          },
          "errors": {
            "type": "array",
            "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
          }
        },
        "required": [
          "id",
          "volunteers_needed",
          "work_location_id",
          "work_location_specification",
          "published",
          "shifts_attributes"
        ]
      }
    }
  }
}

Create in project
POST/projects/{project_id}/teams

Example URI

POST /projects/87643/teams
URI Parameters
HideShow
project_id
string (required) Example: 87643

The Beeple ID of the subproject that you want to manage teams of

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "team": {
    "automatic_name": false,
    "name": "Example Team",
    "function_id": "9",
    "replace_required_profile_for_function": true,
    "remove_required_profile_for_function": true,
    "extra_practical_info": "Some practical info",
    "volunteers_needed": 5,
    "minimal_age": 18,
    "client_experience_required": false,
    "work_location_id": "120",
    "work_location_specification": "At the entrance",
    "registrations_via_application": true,
    "published": true,
    "relative_checkin_start": "00:30",
    "relative_checkin_duration": "00:15",
    "checkin_appointment_id": "157",
    "maximum_travel_distance": 20,
    "shifts_attributes": [
      {
        "start_datetime": "2017-04-01T09:00:00.000+02:00",
        "end_datetime": "2017-04-01T18:00:00.000+02:00",
        "break_duration": "00:30"
      }
    ],
    "contract_details_attributes": [
      {
        "contract_type": "volunteer",
        "be_collar_type": "arbeider",
        "local_legal_entity_id": "4",
        "compensation_hour_id": "3",
        "compensation_day_id": "1",
        "compensation_team_id": "2"
      }
    ],
    "planning_custom_fields": [
      {
        "planning_custom_field_id": "123",
        "value": "Some text"
      }
    ],
    "profile_property_requirements_attributes": [
      {
        "profile_property_id": "7",
        "must_have": true,
        "weight": 25,
        "boolean_selected": true,
        "numeric_min": 7,
        "numeric_max": 125,
        "date_min": "2018-01-15",
        "date_max": "2020-12-25",
        "datetime_min": "Hello, world!",
        "datetime_max": "Hello, world!",
        "time_min": "05:15",
        "time_max": "23:30",
        "list_multi_or": true,
        "list_single_options": [
          "Hello, world!"
        ],
        "list_multi_options": [
          "Hello, world!"
        ],
        "_destroy": true
      }
    ],
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "team": {
      "type": "object",
      "properties": {
        "automatic_name": {
          "type": "boolean",
          "description": "Flag to indicate the use of automatic team name generation"
        },
        "name": {
          "type": "string",
          "description": "The team name. Does not need to be passed, if automatic_name is true"
        },
        "function_id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "replace_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple replace the required profile properties of the team with those of the new function"
        },
        "remove_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple remove the required profile properties of the team if the new function does not demand a required profile"
        },
        "extra_practical_info": {
          "type": "string",
          "description": "Text to describe some extra info"
        },
        "volunteers_needed": {
          "type": "number",
          "description": "The number of collaborators needed"
        },
        "minimal_age": {
          "type": "number",
          "description": "The minimal age for collaborators to be enrolled in this team"
        },
        "client_experience_required": {
          "type": "boolean",
          "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the address of the work station"
        },
        "work_location_specification": {
          "type": "string",
          "description": "An addition to the work station"
        },
        "registrations_via_application": {
          "type": "boolean",
          "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
        },
        "published": {
          "type": "boolean",
          "description": "Indication whether the team is published"
        },
        "relative_checkin_start": {
          "type": "string",
          "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
        },
        "relative_checkin_duration": {
          "type": "string",
          "description": "A time (HH:MM) to indicate how long the checkin lasts"
        },
        "checkin_appointment_id": {
          "type": "string",
          "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
        },
        "maximum_travel_distance": {
          "type": "number",
          "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
        },
        "shifts_attributes": {
          "type": "array",
          "description": "A list of shifts"
        },
        "contract_details_attributes": {
          "type": "array",
          "description": "A list of contract details"
        },
        "planning_custom_fields": {
          "type": "array",
          "description": "A list of planning custom fields"
        },
        "profile_property_requirements_attributes": {
          "type": "array",
          "description": "A list of profile properties.  Only changes (additions or removals) need to passed"
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        }
      },
      "required": [
        "automatic_name",
        "function_id",
        "volunteers_needed",
        "work_location_id",
        "work_location_specification",
        "published",
        "shifts_attributes"
      ]
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "27",
  "name": "Example Team",
  "function": {
    "id": "7",
    "name": "A Name",
    "description": "A longer description"
  },
  "extra_practical_info": "Some practical info",
  "volunteers_needed": 5,
  "minimal_age": 18,
  "client_experience_required": false,
  "work_location_id": "120",
  "work_location_specification": "At the entrance",
  "registrations_via_application": true,
  "published": true,
  "relative_checkin_start": "00:30",
  "relative_checkin_duration": "00:15",
  "checkin_appointment_id": "157",
  "maximum_travel_distance": 20,
  "shifts_attributes": [
    {
      "start_datetime": "2017-04-01T09:00:00.000+02:00",
      "end_datetime": "2017-04-01T18:00:00.000+02:00",
      "break_duration": "00:30"
    }
  ],
  "contract_details_attributes": [
    {
      "contract_type": "volunteer",
      "be_collar_type": "arbeider",
      "local_legal_entity_id": "4",
      "compensation_hour_id": "3",
      "compensation_day_id": "1",
      "compensation_team_id": "2"
    }
  ],
  "planning_custom_fields": [
    {
      "planning_custom_field_id": "123",
      "value": "Some text"
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created team"
    },
    "name": {
      "type": "string",
      "description": "The team name. Does not need to be passed, if automatic_name is true"
    },
    "function": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "name": {
          "type": "string",
          "description": "The name of the function"
        },
        "description": {
          "type": "string",
          "description": "The longer description"
        }
      },
      "description": "The function of the team"
    },
    "extra_practical_info": {
      "type": "string",
      "description": "Text to describe some extra info"
    },
    "volunteers_needed": {
      "type": "number",
      "description": "The number of collaborators needed"
    },
    "minimal_age": {
      "type": "number",
      "description": "The minimal age for collaborators to be enrolled in this team"
    },
    "client_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the address of the work station"
    },
    "work_location_specification": {
      "type": "string",
      "description": "An addition to the work station"
    },
    "registrations_via_application": {
      "type": "boolean",
      "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the team is published"
    },
    "relative_checkin_start": {
      "type": "string",
      "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
    },
    "relative_checkin_duration": {
      "type": "string",
      "description": "A time (HH:MM) to indicate how long the checkin lasts"
    },
    "checkin_appointment_id": {
      "type": "string",
      "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
    },
    "maximum_travel_distance": {
      "type": "number",
      "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
    },
    "shifts_attributes": {
      "type": "array",
      "description": "A list of shifts"
    },
    "contract_details_attributes": {
      "type": "array",
      "description": "A list of contract details"
    },
    "planning_custom_fields": {
      "type": "array",
      "description": "A list of planning custom fields"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "volunteers_needed",
    "work_location_id",
    "work_location_specification",
    "published",
    "shifts_attributes"
  ]
}

Create in subproject
POST/subprojects/{sub_project_id}/teams

Example URI

POST /subprojects/87643/teams
URI Parameters
HideShow
sub_project_id
string (required) Example: 87643

The Beeple ID of the subproject that you want to manage teams of

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "team": {
    "automatic_name": false,
    "name": "Example Team",
    "function_id": "9",
    "replace_required_profile_for_function": true,
    "remove_required_profile_for_function": true,
    "extra_practical_info": "Some practical info",
    "volunteers_needed": 5,
    "minimal_age": 18,
    "client_experience_required": false,
    "work_location_id": "120",
    "work_location_specification": "At the entrance",
    "registrations_via_application": true,
    "published": true,
    "relative_checkin_start": "00:30",
    "relative_checkin_duration": "00:15",
    "checkin_appointment_id": "157",
    "maximum_travel_distance": 20,
    "shifts_attributes": [
      {
        "start_datetime": "2017-04-01T09:00:00.000+02:00",
        "end_datetime": "2017-04-01T18:00:00.000+02:00",
        "break_duration": "00:30"
      }
    ],
    "contract_details_attributes": [
      {
        "contract_type": "volunteer",
        "be_collar_type": "arbeider",
        "local_legal_entity_id": "4",
        "compensation_hour_id": "3",
        "compensation_day_id": "1",
        "compensation_team_id": "2"
      }
    ],
    "planning_custom_fields": [
      {
        "planning_custom_field_id": "123",
        "value": "Some text"
      }
    ],
    "profile_property_requirements_attributes": [
      {
        "profile_property_id": "7",
        "must_have": true,
        "weight": 25,
        "boolean_selected": true,
        "numeric_min": 7,
        "numeric_max": 125,
        "date_min": "2018-01-15",
        "date_max": "2020-12-25",
        "datetime_min": "Hello, world!",
        "datetime_max": "Hello, world!",
        "time_min": "05:15",
        "time_max": "23:30",
        "list_multi_or": true,
        "list_single_options": [
          "Hello, world!"
        ],
        "list_multi_options": [
          "Hello, world!"
        ],
        "_destroy": true
      }
    ],
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "team": {
      "type": "object",
      "properties": {
        "automatic_name": {
          "type": "boolean",
          "description": "Flag to indicate the use of automatic team name generation"
        },
        "name": {
          "type": "string",
          "description": "The team name. Does not need to be passed, if automatic_name is true"
        },
        "function_id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "replace_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple replace the required profile properties of the team with those of the new function"
        },
        "remove_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple remove the required profile properties of the team if the new function does not demand a required profile"
        },
        "extra_practical_info": {
          "type": "string",
          "description": "Text to describe some extra info"
        },
        "volunteers_needed": {
          "type": "number",
          "description": "The number of collaborators needed"
        },
        "minimal_age": {
          "type": "number",
          "description": "The minimal age for collaborators to be enrolled in this team"
        },
        "client_experience_required": {
          "type": "boolean",
          "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the address of the work station"
        },
        "work_location_specification": {
          "type": "string",
          "description": "An addition to the work station"
        },
        "registrations_via_application": {
          "type": "boolean",
          "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
        },
        "published": {
          "type": "boolean",
          "description": "Indication whether the team is published"
        },
        "relative_checkin_start": {
          "type": "string",
          "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
        },
        "relative_checkin_duration": {
          "type": "string",
          "description": "A time (HH:MM) to indicate how long the checkin lasts"
        },
        "checkin_appointment_id": {
          "type": "string",
          "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
        },
        "maximum_travel_distance": {
          "type": "number",
          "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
        },
        "shifts_attributes": {
          "type": "array",
          "description": "A list of shifts"
        },
        "contract_details_attributes": {
          "type": "array",
          "description": "A list of contract details"
        },
        "planning_custom_fields": {
          "type": "array",
          "description": "A list of planning custom fields"
        },
        "profile_property_requirements_attributes": {
          "type": "array",
          "description": "A list of profile properties.  Only changes (additions or removals) need to passed"
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        }
      },
      "required": [
        "automatic_name",
        "function_id",
        "volunteers_needed",
        "work_location_id",
        "work_location_specification",
        "published",
        "shifts_attributes"
      ]
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "27",
  "name": "Example Team",
  "function": {
    "id": "7",
    "name": "A Name",
    "description": "A longer description"
  },
  "extra_practical_info": "Some practical info",
  "volunteers_needed": 5,
  "minimal_age": 18,
  "client_experience_required": false,
  "work_location_id": "120",
  "work_location_specification": "At the entrance",
  "registrations_via_application": true,
  "published": true,
  "relative_checkin_start": "00:30",
  "relative_checkin_duration": "00:15",
  "checkin_appointment_id": "157",
  "maximum_travel_distance": 20,
  "shifts_attributes": [
    {
      "start_datetime": "2017-04-01T09:00:00.000+02:00",
      "end_datetime": "2017-04-01T18:00:00.000+02:00",
      "break_duration": "00:30"
    }
  ],
  "contract_details_attributes": [
    {
      "contract_type": "volunteer",
      "be_collar_type": "arbeider",
      "local_legal_entity_id": "4",
      "compensation_hour_id": "3",
      "compensation_day_id": "1",
      "compensation_team_id": "2"
    }
  ],
  "planning_custom_fields": [
    {
      "planning_custom_field_id": "123",
      "value": "Some text"
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created team"
    },
    "name": {
      "type": "string",
      "description": "The team name. Does not need to be passed, if automatic_name is true"
    },
    "function": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "name": {
          "type": "string",
          "description": "The name of the function"
        },
        "description": {
          "type": "string",
          "description": "The longer description"
        }
      },
      "description": "The function of the team"
    },
    "extra_practical_info": {
      "type": "string",
      "description": "Text to describe some extra info"
    },
    "volunteers_needed": {
      "type": "number",
      "description": "The number of collaborators needed"
    },
    "minimal_age": {
      "type": "number",
      "description": "The minimal age for collaborators to be enrolled in this team"
    },
    "client_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the address of the work station"
    },
    "work_location_specification": {
      "type": "string",
      "description": "An addition to the work station"
    },
    "registrations_via_application": {
      "type": "boolean",
      "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the team is published"
    },
    "relative_checkin_start": {
      "type": "string",
      "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
    },
    "relative_checkin_duration": {
      "type": "string",
      "description": "A time (HH:MM) to indicate how long the checkin lasts"
    },
    "checkin_appointment_id": {
      "type": "string",
      "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
    },
    "maximum_travel_distance": {
      "type": "number",
      "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
    },
    "shifts_attributes": {
      "type": "array",
      "description": "A list of shifts"
    },
    "contract_details_attributes": {
      "type": "array",
      "description": "A list of contract details"
    },
    "planning_custom_fields": {
      "type": "array",
      "description": "A list of planning custom fields"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "volunteers_needed",
    "work_location_id",
    "work_location_specification",
    "published",
    "shifts_attributes"
  ]
}

Details
GET/api/v1/admin/teams/{team_id}

Example URI

GET /api/v1/admin/teams/78102
URI Parameters
HideShow
team_id
string (required) Example: 78102

The Beeple ID of the team

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "27",
  "name": "Example Team",
  "subproject": "Subproject name",
  "project": "Project name",
  "function": {
    "name": "A Name",
    "description": "A longer description"
  },
  "extra_practical_info": "Some practical info",
  "shifts": [
    {
      "start_datetime": "2017-04-01T09:00:00.000+02:00",
      "end_datetime": "2017-04-01T18:00:00.000+02:00",
      "break_duration": "00:30"
    }
  ],
  "planning_custom_fields": [
    {
      "planning_custom_field_id": "123",
      "value": "Some text"
    }
  ],
  "profile_property_requirements": [
    {
      "profile_property_id": "7",
      "must_have": true,
      "weight": 25,
      "boolean_selected": true,
      "numeric_min": 7,
      "numeric_max": 125,
      "date_min": "2018-01-15",
      "date_max": "2020-12-25",
      "datetime_min": "Hello, world!",
      "datetime_max": "Hello, world!",
      "time_min": "05:15",
      "time_max": "23:30",
      "list_multi_or": true,
      "list_single_options": [
        "Hello, world!"
      ],
      "list_multi_options": [
        "Hello, world!"
      ],
      "_destroy": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created team"
    },
    "name": {
      "type": "string",
      "description": "The team name. Does not need to be passed, if automatic_name is true"
    },
    "subproject": {
      "type": "string",
      "description": "The subproject name."
    },
    "project": {
      "type": "string",
      "description": "The project name."
    },
    "function": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the function"
        },
        "description": {
          "type": "string",
          "description": "The longer description"
        }
      },
      "description": "The function of the team"
    },
    "extra_practical_info": {
      "type": "string",
      "description": "Text to describe some extra info"
    },
    "shifts": {
      "type": "array",
      "description": "A list of shifts"
    },
    "planning_custom_fields": {
      "type": "array",
      "description": "A list of planning custom fields"
    },
    "profile_property_requirements": {
      "type": "array",
      "description": "A list of planning custom fields"
    }
  },
  "required": [
    "id",
    "shifts"
  ]
}

Update
PATCH/api/v1/admin/teams/{team_id}

Example URI

PATCH /api/v1/admin/teams/78102
URI Parameters
HideShow
team_id
string (required) Example: 78102

The Beeple ID of the team

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "team": {
    "automatic_name": false,
    "name": "Example Team",
    "function_id": "9",
    "replace_required_profile_for_function": true,
    "remove_required_profile_for_function": true,
    "extra_practical_info": "Some practical info",
    "volunteers_needed": 5,
    "minimal_age": 18,
    "client_experience_required": false,
    "work_location_id": "120",
    "work_location_specification": "At the entrance",
    "registrations_via_application": true,
    "published": true,
    "relative_checkin_start": "00:30",
    "relative_checkin_duration": "00:15",
    "checkin_appointment_id": "157",
    "maximum_travel_distance": 20,
    "shifts_attributes": [
      {
        "start_datetime": "2017-04-01T09:00:00.000+02:00",
        "end_datetime": "2017-04-01T18:00:00.000+02:00",
        "break_duration": "00:30"
      }
    ],
    "contract_details_attributes": [
      {
        "contract_type": "volunteer",
        "be_collar_type": "arbeider",
        "local_legal_entity_id": "4",
        "compensation_hour_id": "3",
        "compensation_day_id": "1",
        "compensation_team_id": "2"
      }
    ],
    "planning_custom_fields": [
      {
        "planning_custom_field_id": "123",
        "value": "Some text"
      }
    ],
    "profile_property_requirements_attributes": [
      {
        "profile_property_id": "7",
        "must_have": true,
        "weight": 25,
        "boolean_selected": true,
        "numeric_min": 7,
        "numeric_max": 125,
        "date_min": "2018-01-15",
        "date_max": "2020-12-25",
        "datetime_min": "Hello, world!",
        "datetime_max": "Hello, world!",
        "time_min": "05:15",
        "time_max": "23:30",
        "list_multi_or": true,
        "list_single_options": [
          "Hello, world!"
        ],
        "list_multi_options": [
          "Hello, world!"
        ],
        "_destroy": true
      }
    ],
    "managers_attributes": [
      {
        "collaborator_id": "8",
        "_destroy": true
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "team": {
      "type": "object",
      "properties": {
        "automatic_name": {
          "type": "boolean",
          "description": "Flag to indicate the use of automatic team name generation"
        },
        "name": {
          "type": "string",
          "description": "The team name. Does not need to be passed, if automatic_name is true"
        },
        "function_id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "replace_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple replace the required profile properties of the team with those of the new function"
        },
        "remove_required_profile_for_function": {
          "type": "boolean",
          "description": "When updating a team's function, set to true to have Beeple remove the required profile properties of the team if the new function does not demand a required profile"
        },
        "extra_practical_info": {
          "type": "string",
          "description": "Text to describe some extra info"
        },
        "volunteers_needed": {
          "type": "number",
          "description": "The number of collaborators needed"
        },
        "minimal_age": {
          "type": "number",
          "description": "The minimal age for collaborators to be enrolled in this team"
        },
        "client_experience_required": {
          "type": "boolean",
          "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
        },
        "work_location_id": {
          "type": "string",
          "description": "The ID of the address of the work station"
        },
        "work_location_specification": {
          "type": "string",
          "description": "An addition to the work station"
        },
        "registrations_via_application": {
          "type": "boolean",
          "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
        },
        "published": {
          "type": "boolean",
          "description": "Indication whether the team is published"
        },
        "relative_checkin_start": {
          "type": "string",
          "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
        },
        "relative_checkin_duration": {
          "type": "string",
          "description": "A time (HH:MM) to indicate how long the checkin lasts"
        },
        "checkin_appointment_id": {
          "type": "string",
          "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
        },
        "maximum_travel_distance": {
          "type": "number",
          "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
        },
        "shifts_attributes": {
          "type": "array",
          "description": "A list of shifts"
        },
        "contract_details_attributes": {
          "type": "array",
          "description": "A list of contract details"
        },
        "planning_custom_fields": {
          "type": "array",
          "description": "A list of planning custom fields"
        },
        "profile_property_requirements_attributes": {
          "type": "array",
          "description": "A list of profile properties.  Only changes (additions or removals) need to passed"
        },
        "managers_attributes": {
          "type": "array",
          "description": "A list of extra admins with access. Only changes (additions or removals) need to passed"
        }
      },
      "required": [
        "automatic_name",
        "function_id",
        "volunteers_needed",
        "work_location_id",
        "work_location_specification",
        "published",
        "shifts_attributes"
      ]
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "27",
  "name": "Example Team",
  "function": {
    "id": "7",
    "name": "A Name",
    "description": "A longer description"
  },
  "extra_practical_info": "Some practical info",
  "volunteers_needed": 5,
  "minimal_age": 18,
  "client_experience_required": false,
  "work_location_id": "120",
  "work_location_specification": "At the entrance",
  "registrations_via_application": true,
  "published": true,
  "relative_checkin_start": "00:30",
  "relative_checkin_duration": "00:15",
  "checkin_appointment_id": "157",
  "maximum_travel_distance": 20,
  "shifts_attributes": [
    {
      "start_datetime": "2017-04-01T09:00:00.000+02:00",
      "end_datetime": "2017-04-01T18:00:00.000+02:00",
      "break_duration": "00:30"
    }
  ],
  "contract_details_attributes": [
    {
      "contract_type": "volunteer",
      "be_collar_type": "arbeider",
      "local_legal_entity_id": "4",
      "compensation_hour_id": "3",
      "compensation_day_id": "1",
      "compensation_team_id": "2"
    }
  ],
  "planning_custom_fields": [
    {
      "planning_custom_field_id": "123",
      "value": "Some text"
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created team"
    },
    "name": {
      "type": "string",
      "description": "The team name. Does not need to be passed, if automatic_name is true"
    },
    "function": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "name": {
          "type": "string",
          "description": "The name of the function"
        },
        "description": {
          "type": "string",
          "description": "The longer description"
        }
      },
      "description": "The function of the team"
    },
    "extra_practical_info": {
      "type": "string",
      "description": "Text to describe some extra info"
    },
    "volunteers_needed": {
      "type": "number",
      "description": "The number of collaborators needed"
    },
    "minimal_age": {
      "type": "number",
      "description": "The minimal age for collaborators to be enrolled in this team"
    },
    "client_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the address of the work station"
    },
    "work_location_specification": {
      "type": "string",
      "description": "An addition to the work station"
    },
    "registrations_via_application": {
      "type": "boolean",
      "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the team is published"
    },
    "relative_checkin_start": {
      "type": "string",
      "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
    },
    "relative_checkin_duration": {
      "type": "string",
      "description": "A time (HH:MM) to indicate how long the checkin lasts"
    },
    "checkin_appointment_id": {
      "type": "string",
      "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
    },
    "maximum_travel_distance": {
      "type": "number",
      "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
    },
    "shifts_attributes": {
      "type": "array",
      "description": "A list of shifts"
    },
    "contract_details_attributes": {
      "type": "array",
      "description": "A list of contract details"
    },
    "planning_custom_fields": {
      "type": "array",
      "description": "A list of planning custom fields"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "volunteers_needed",
    "work_location_id",
    "work_location_specification",
    "published",
    "shifts_attributes"
  ]
}

Delete
DELETE/api/v1/admin/teams/{team_id}

Example URI

DELETE /api/v1/admin/teams/78102
URI Parameters
HideShow
team_id
string (required) Example: 78102

The Beeple ID of the team

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "27",
  "name": "Example Team",
  "function": {
    "id": "7",
    "name": "A Name",
    "description": "A longer description"
  },
  "extra_practical_info": "Some practical info",
  "volunteers_needed": 5,
  "minimal_age": 18,
  "client_experience_required": false,
  "work_location_id": "120",
  "work_location_specification": "At the entrance",
  "registrations_via_application": true,
  "published": true,
  "relative_checkin_start": "00:30",
  "relative_checkin_duration": "00:15",
  "checkin_appointment_id": "157",
  "maximum_travel_distance": 20,
  "shifts_attributes": [
    {
      "start_datetime": "2017-04-01T09:00:00.000+02:00",
      "end_datetime": "2017-04-01T18:00:00.000+02:00",
      "break_duration": "00:30"
    }
  ],
  "contract_details_attributes": [
    {
      "contract_type": "volunteer",
      "be_collar_type": "arbeider",
      "local_legal_entity_id": "4",
      "compensation_hour_id": "3",
      "compensation_day_id": "1",
      "compensation_team_id": "2"
    }
  ],
  "planning_custom_fields": [
    {
      "planning_custom_field_id": "123",
      "value": "Some text"
    }
  ],
  "errors": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the created team"
    },
    "name": {
      "type": "string",
      "description": "The team name. Does not need to be passed, if automatic_name is true"
    },
    "function": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the function"
        },
        "name": {
          "type": "string",
          "description": "The name of the function"
        },
        "description": {
          "type": "string",
          "description": "The longer description"
        }
      },
      "description": "The function of the team"
    },
    "extra_practical_info": {
      "type": "string",
      "description": "Text to describe some extra info"
    },
    "volunteers_needed": {
      "type": "number",
      "description": "The number of collaborators needed"
    },
    "minimal_age": {
      "type": "number",
      "description": "The minimal age for collaborators to be enrolled in this team"
    },
    "client_experience_required": {
      "type": "boolean",
      "description": "Whether customer experience is required for collaborators to be enrolled in this team. Only applicable, if the project to which the team belongs has a linked customer"
    },
    "work_location_id": {
      "type": "string",
      "description": "The ID of the address of the work station"
    },
    "work_location_specification": {
      "type": "string",
      "description": "An addition to the work station"
    },
    "registrations_via_application": {
      "type": "boolean",
      "description": "Indicating whether the team is planned with candicacies (true) or direct registrations (false)"
    },
    "published": {
      "type": "boolean",
      "description": "Indication whether the team is published"
    },
    "relative_checkin_start": {
      "type": "string",
      "description": "A time (HH:MM) to indicate when checkin starts before the first shift"
    },
    "relative_checkin_duration": {
      "type": "string",
      "description": "A time (HH:MM) to indicate how long the checkin lasts"
    },
    "checkin_appointment_id": {
      "type": "string",
      "description": "The ID of checkin appointment. Either this or 2 relative checkin fields need to be passed"
    },
    "maximum_travel_distance": {
      "type": "number",
      "description": "The maximum distance collaborators are allowed to travel to work for this team in kilometers"
    },
    "shifts_attributes": {
      "type": "array",
      "description": "A list of shifts"
    },
    "contract_details_attributes": {
      "type": "array",
      "description": "A list of contract details"
    },
    "planning_custom_fields": {
      "type": "array",
      "description": "A list of planning custom fields"
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\nthe team. The keys refer to the name of the field (eg. function_id) but\ncan also be “base” for generic errors. The value is a list of human\nreadable errors for that specific field."
    }
  },
  "required": [
    "id",
    "volunteers_needed",
    "work_location_id",
    "work_location_specification",
    "published",
    "shifts_attributes"
  ]
}

Collaborators

Collaborators

Create
POST/api/v1/admin/collaborators

Example URI

POST /api/v1/admin/collaborators
Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "collaborator": {
    "other_names": "Jane",
    "family_name": "Doe",
    "prefix": "De",
    "email": "example@example.org",
    "birth_country": "BE",
    "birth_place": "Brussels",
    "birth_date": "01/01/2000",
    "social_statute": "career_pause",
    "receive_email_campaigns": false,
    "receive_sms_campaigns": false,
    "receive_facebook_campaigns": false,
    "gender": "male",
    "language": "nl",
    "color": "#e63333",
    "national_identification_be": "01.01.00-000.12",
    "national_identification_nl": "123456",
    "national_identification_de": "123456",
    "mobile_phone_number": "+32 498 00 00 00",
    "nationality": "NL",
    "default_contract_type": "freelancer",
    "payroll_identification_code": "12246",
    "contract_types": [
      "freelancer",
      "freelancer",
      "volunteer",
      "interim",
      "contractual",
      "intern"
    ],
    "private_remark": "12246",
    "profile_picture": {
      "filename": "'Hello_world.png'",
      "file": "'SGVsbG8gd29ybGQ='"
    },
    "remove_profile_picture": false,
    "contacts_attributes": {
      "id": "Hello, world!",
      "name": "Hello, world!",
      "mobile": "Hello, world!",
      "relationship": "Hello, world!"
    },
    "department_ids": [
      7487,
      5646
    ],
    "primary_department_id": 7487,
    "manager_ids": [
      1722,
      2423
    ],
    "bank_account": {
      "iban": "BE12345678901",
      "bic": "GEBABEBB"
    },
    "primary_address": {
      "street1": "Dorpstraat 1",
      "street2": "Bus 1",
      "zip": "2018",
      "city": "Antwerpen",
      "country": "BE"
    },
    "profile_properties": [
      {
        "profile_property_id,": "Hello, world!",
        "freetext_verified,": "Hello, world!",
        "numeric_verified,": "Hello, world!",
        "boolean_verified,": "Hello, world!",
        "list_single_verified,": "Hello, world!",
        "datetime_verified,": "Hello, world!",
        "date_verified,": "Hello, world!",
        "time_verified,": "Hello, world!",
        "upload_verified,": "Hello, world!",
        "comment_verified,": "Hello, world!",
        "documented_proof_verified,": "Hello, world!",
        "remove_documented_proof_verified,": "Hello, world!",
        "expiration_date_verified,": "Hello, world!",
        "freetext_multiline_verified,": "Hello, world!",
        "list_multi_verified": [
          {
            "slug": "Hello, world!",
            "selected": "Hello, world!"
          }
        ]
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "collaborator": {
      "type": "object",
      "properties": {
        "other_names": {
          "type": "string",
          "description": "The first name(s) of the collaborator"
        },
        "family_name": {
          "type": "string",
          "description": "The last name of the collaborator"
        },
        "prefix": {
          "type": "string",
          "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
        },
        "email": {
          "type": "string",
          "description": "The  emailaddress of the collaborator. Should be unique for the site"
        },
        "birth_country": {
          "type": "string",
          "description": "Birth country (2 letter code) of the collaborator"
        },
        "birth_place": {
          "type": "string",
          "description": "Birth city of the collaborator"
        },
        "birth_date": {
          "type": "string",
          "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
        },
        "social_statute": {
          "type": "string",
          "enum": [
            "career_pause",
            "disabled_entrepreneur",
            "early_retired",
            "entrepreneur",
            "flexijobs",
            "functionary",
            "incapacitated",
            "living_wager",
            "retired",
            "student",
            "unemployed",
            "unemployed_waiting_period",
            "unknown",
            "working_class",
            "working_class_blue_collar",
            "work_student"
          ],
          "description": "The social statute"
        },
        "receive_email_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive email campaigns"
        },
        "receive_sms_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive SMS campaigns"
        },
        "receive_facebook_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive facebook campaigns"
        },
        "gender": {
          "type": "string",
          "enum": [
            "male",
            "female"
          ],
          "description": "The gender"
        },
        "language": {
          "type": "string",
          "description": "The language the collaborator prefers"
        },
        "color": {
          "type": "string",
          "description": "HEX code representing the desired color for the collaborator."
        },
        "national_identification_be": {
          "type": "string",
          "description": "The Belgiam National Identity number (Rijkregister number)"
        },
        "national_identification_nl": {
          "type": "string",
          "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
        },
        "national_identification_de": {
          "type": "string",
          "description": "The German National Identity number"
        },
        "mobile_phone_number": {
          "type": "string",
          "description": "The mobile phone number"
        },
        "nationality": {
          "type": "string",
          "description": "The nationality (2 letter country code)"
        },
        "default_contract_type": {
          "type": "string",
          "enum": [
            "freelancer",
            "volunteer",
            "interim",
            "contractual",
            "intern"
          ],
          "description": "The default contract type of the collaborator"
        },
        "payroll_identification_code": {
          "type": "string",
          "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
        },
        "contract_types": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "The allowed contract types"
        },
        "private_remark": {
          "type": "string",
          "description": "This is a remark that only admins can see about the collaborators"
        },
        "profile_picture": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "description": "The name of the file you wish to upload"
            },
            "file": {
              "type": "string",
              "description": "base64 string of the image you want to upload"
            }
          },
          "required": [
            "filename",
            "file"
          ],
          "description": "The hash representing the profile picture"
        },
        "remove_profile_picture": {
          "type": "boolean",
          "description": "Whether or not the profile picture should be removed."
        },
        "contacts_attributes": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "mobile": {
              "type": "string"
            },
            "relationship": {
              "type": "string"
            }
          },
          "description": "Contact information."
        },
        "department_ids": {
          "type": "array",
          "items": [
            {
              "type": "number"
            },
            {
              "type": "number"
            }
          ],
          "description": "List of department IDS"
        },
        "primary_department_id": {
          "type": "number",
          "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
        },
        "manager_ids": {
          "type": "array",
          "items": [
            {
              "type": "number"
            },
            {
              "type": "number"
            }
          ],
          "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
        },
        "bank_account": {
          "type": "object",
          "properties": {
            "iban": {
              "type": "string",
              "description": "The IBAN number"
            },
            "bic": {
              "type": "string",
              "description": "The BIC number"
            }
          },
          "required": [
            "iban",
            "bic"
          ],
          "description": "The current bank account of the collaborator"
        },
        "primary_address": {
          "type": "object",
          "properties": {
            "street1": {
              "type": "string",
              "description": "Street + house number"
            },
            "street2": {
              "type": "string",
              "description": "Extension of street1"
            },
            "zip": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "country": {
              "type": "string",
              "description": "According to ISO 3166-1 alpha-2"
            }
          },
          "description": "The current address of the collaborator"
        },
        "profile_properties": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "profile_property_id,": {
                "type": "string"
              },
              "freetext_verified,": {
                "type": "string"
              },
              "numeric_verified,": {
                "type": "string"
              },
              "boolean_verified,": {
                "type": "string"
              },
              "list_single_verified,": {
                "type": "string"
              },
              "datetime_verified,": {
                "type": "string"
              },
              "date_verified,": {
                "type": "string"
              },
              "time_verified,": {
                "type": "string"
              },
              "upload_verified,": {
                "type": "string"
              },
              "comment_verified,": {
                "type": "string"
              },
              "documented_proof_verified,": {
                "type": "string"
              },
              "remove_documented_proof_verified,": {
                "type": "string"
              },
              "expiration_date_verified,": {
                "type": "string"
              },
              "freetext_multiline_verified,": {
                "type": "string"
              },
              "list_multi_verified": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "type": "string"
                    },
                    "selected": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "description": "A list of profile properties for the collaboator"
        }
      },
      "required": [
        "other_names",
        "family_name",
        "prefix",
        "email",
        "primary_department_id"
      ]
    }
  },
  "required": [
    "collaborator"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "other_names": "Jane",
  "family_name": "Doe",
  "prefix": "De",
  "email": "example@example.org",
  "birth_country": "BE",
  "birth_country_name": "Belgium",
  "birth_place": "Brussels",
  "birth_date": "01/01/2000",
  "social_statute": "employee",
  "receive_email_campaigns": false,
  "receive_sms_campaigns": false,
  "gender": "employee",
  "language": "nl",
  "national_identification_be": "01.01.00-000.12",
  "national_identification_nl": "123456",
  "national_identification_de": "123456",
  "mobile": "32498000000",
  "phone": "32232840000",
  "nationality": "NL",
  "default_contract_type": "contractual",
  "payroll_identification_code": "12246",
  "contract_types": [
    "freelancer",
    "freelancer",
    "volunteer",
    "interim",
    "contractual",
    "intern"
  ],
  "iban": "BE1223445544",
  "bic": "GEBABEBB",
  "primary_address": {
    "street1": "Dorpstraat 1",
    "street2": "Bus 1",
    "zip": "2018",
    "city": "Antwerpen",
    "country": "BE"
  },
  "departments": [
    {
      "id": "7845",
      "name": "Example Department"
    }
  ],
  "department_ids": [
    7487,
    5646
  ],
  "primary_department_id": 7487,
  "manager_ids": [
    1722,
    2423
  ],
  "profile_properties": "``",
  "profile_property_groups": [
    {
      "name": "Example Info group",
      "profile_properties": [
        {}
      ]
    }
  ],
  "errors": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator. Will be empty if the collaborator could not be saved"
    },
    "other_names": {
      "type": "string",
      "description": "The first name(s) of the collaborator"
    },
    "family_name": {
      "type": "string",
      "description": "The last name of the collaborator"
    },
    "prefix": {
      "type": "string",
      "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
    },
    "email": {
      "type": "string",
      "description": "The  emailaddress of the collaborator. Should be unique for the site"
    },
    "birth_country": {
      "type": "string",
      "description": "Birth country (2 letter code) of the collaborator"
    },
    "birth_country_name": {
      "type": "string",
      "description": "Birth country"
    },
    "birth_place": {
      "type": "string",
      "description": "Birth city of the collaborator"
    },
    "birth_date": {
      "type": "string",
      "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
    },
    "social_statute": {
      "type": "string",
      "enum": [
        "career_pause",
        "disabled_entrepreneur",
        "early_retired",
        "entrepreneur",
        "flexijobs",
        "functionary",
        "incapacitated",
        "living_wager",
        "retired",
        "student",
        "unemployed",
        "unemployed_waiting_period",
        "unknown",
        "working_class",
        "working_class_blue_collar",
        "work_student"
      ],
      "description": "The social statute"
    },
    "receive_email_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive email campaigns"
    },
    "receive_sms_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive SMS campaigns"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "The gender"
    },
    "language": {
      "type": "string",
      "description": "The language the collaborator prefers"
    },
    "national_identification_be": {
      "type": "string",
      "description": "The Belgiam National Identity number (Rijkregister number)"
    },
    "national_identification_nl": {
      "type": "string",
      "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
    },
    "national_identification_de": {
      "type": "string",
      "description": "The German National Identity number"
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number"
    },
    "phone": {
      "type": "string",
      "description": "The secondary phone number"
    },
    "nationality": {
      "type": "string",
      "description": "The nationality (2 letter country code)"
    },
    "default_contract_type": {
      "type": "string",
      "enum": [
        "freelancer",
        "volunteer",
        "interim",
        "contractual",
        "intern"
      ],
      "description": "The default contract type of the collaborator"
    },
    "payroll_identification_code": {
      "type": "string",
      "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
    },
    "contract_types": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The allowed contract types"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account"
    },
    "bic": {
      "type": "string",
      "description": "The BIC of the bank account"
    },
    "primary_address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "description": "Street + house number"
        },
        "street2": {
          "type": "string",
          "description": "Extension of street1"
        },
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "According to ISO 3166-1 alpha-2"
        }
      },
      "description": "The current address of the collaborator"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the department"
          },
          "name": {
            "type": "string",
            "description": "The Name of the department"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "description": "List of Departments"
    },
    "department_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "List of department IDS"
    },
    "primary_department_id": {
      "type": "number",
      "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
    },
    "manager_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
    },
    "profile_properties": {
      "type": "string",
      "description": "Deprecated"
    },
    "profile_property_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the group"
          },
          "profile_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "A list of profile property values under this group"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\n    the project. The keys refer to the name of the field (eg. start_date) but\n    can also be “base” for generic errors. The value is a list of human\n    readable errors for that specific field."
    }
  },
  "required": [
    "other_names",
    "family_name",
    "prefix",
    "email",
    "primary_department_id"
  ]
}

Update
PATCH/api/v1/admin/collaborators/{id}

Example URI

PATCH /api/v1/admin/collaborators/7
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "collaborator": {
    "other_names": "Jane",
    "family_name": "Doe",
    "prefix": "De",
    "email": "example@example.org",
    "birth_country": "BE",
    "birth_place": "Brussels",
    "birth_date": "01/01/2000",
    "social_statute": "career_pause",
    "receive_email_campaigns": false,
    "receive_sms_campaigns": false,
    "receive_facebook_campaigns": false,
    "gender": "male",
    "language": "nl",
    "color": "#e63333",
    "national_identification_be": "01.01.00-000.12",
    "national_identification_nl": "123456",
    "national_identification_de": "123456",
    "mobile_phone_number": "+32 498 00 00 00",
    "nationality": "NL",
    "default_contract_type": "freelancer",
    "payroll_identification_code": "12246",
    "contract_types": [
      "freelancer",
      "freelancer",
      "volunteer",
      "interim",
      "contractual",
      "intern"
    ],
    "private_remark": "12246",
    "profile_picture": {
      "filename": "'Hello_world.png'",
      "file": "'SGVsbG8gd29ybGQ='"
    },
    "remove_profile_picture": false,
    "contacts_attributes": {
      "id": "Hello, world!",
      "name": "Hello, world!",
      "mobile": "Hello, world!",
      "relationship": "Hello, world!"
    },
    "department_ids": [
      7487,
      5646
    ],
    "primary_department_id": 7487,
    "manager_ids": [
      1722,
      2423
    ],
    "bank_account": {
      "iban": "BE12345678901",
      "bic": "GEBABEBB"
    },
    "primary_address": {
      "street1": "Dorpstraat 1",
      "street2": "Bus 1",
      "zip": "2018",
      "city": "Antwerpen",
      "country": "BE"
    },
    "profile_properties": [
      {
        "profile_property_id,": "Hello, world!",
        "freetext_verified,": "Hello, world!",
        "numeric_verified,": "Hello, world!",
        "boolean_verified,": "Hello, world!",
        "list_single_verified,": "Hello, world!",
        "datetime_verified,": "Hello, world!",
        "date_verified,": "Hello, world!",
        "time_verified,": "Hello, world!",
        "upload_verified,": "Hello, world!",
        "comment_verified,": "Hello, world!",
        "documented_proof_verified,": "Hello, world!",
        "remove_documented_proof_verified,": "Hello, world!",
        "expiration_date_verified,": "Hello, world!",
        "freetext_multiline_verified,": "Hello, world!",
        "list_multi_verified": [
          {
            "slug": "Hello, world!",
            "selected": "Hello, world!"
          }
        ]
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "collaborator": {
      "type": "object",
      "properties": {
        "other_names": {
          "type": "string",
          "description": "The first name(s) of the collaborator"
        },
        "family_name": {
          "type": "string",
          "description": "The last name of the collaborator"
        },
        "prefix": {
          "type": "string",
          "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
        },
        "email": {
          "type": "string",
          "description": "The  emailaddress of the collaborator. Should be unique for the site"
        },
        "birth_country": {
          "type": "string",
          "description": "Birth country (2 letter code) of the collaborator"
        },
        "birth_place": {
          "type": "string",
          "description": "Birth city of the collaborator"
        },
        "birth_date": {
          "type": "string",
          "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
        },
        "social_statute": {
          "type": "string",
          "enum": [
            "career_pause",
            "disabled_entrepreneur",
            "early_retired",
            "entrepreneur",
            "flexijobs",
            "functionary",
            "incapacitated",
            "living_wager",
            "retired",
            "student",
            "unemployed",
            "unemployed_waiting_period",
            "unknown",
            "working_class",
            "working_class_blue_collar",
            "work_student"
          ],
          "description": "The social statute"
        },
        "receive_email_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive email campaigns"
        },
        "receive_sms_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive SMS campaigns"
        },
        "receive_facebook_campaigns": {
          "type": "boolean",
          "description": "If the collaboraotr wants to receive facebook campaigns"
        },
        "gender": {
          "type": "string",
          "enum": [
            "male",
            "female"
          ],
          "description": "The gender"
        },
        "language": {
          "type": "string",
          "description": "The language the collaborator prefers"
        },
        "color": {
          "type": "string",
          "description": "HEX code representing the desired color for the collaborator."
        },
        "national_identification_be": {
          "type": "string",
          "description": "The Belgiam National Identity number (Rijkregister number)"
        },
        "national_identification_nl": {
          "type": "string",
          "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
        },
        "national_identification_de": {
          "type": "string",
          "description": "The German National Identity number"
        },
        "mobile_phone_number": {
          "type": "string",
          "description": "The mobile phone number"
        },
        "nationality": {
          "type": "string",
          "description": "The nationality (2 letter country code)"
        },
        "default_contract_type": {
          "type": "string",
          "enum": [
            "freelancer",
            "volunteer",
            "interim",
            "contractual",
            "intern"
          ],
          "description": "The default contract type of the collaborator"
        },
        "payroll_identification_code": {
          "type": "string",
          "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
        },
        "contract_types": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "The allowed contract types"
        },
        "private_remark": {
          "type": "string",
          "description": "This is a remark that only admins can see about the collaborators"
        },
        "profile_picture": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "description": "The name of the file you wish to upload"
            },
            "file": {
              "type": "string",
              "description": "base64 string of the image you want to upload"
            }
          },
          "required": [
            "filename",
            "file"
          ],
          "description": "The hash representing the profile picture"
        },
        "remove_profile_picture": {
          "type": "boolean",
          "description": "Whether or not the profile picture should be removed."
        },
        "contacts_attributes": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "mobile": {
              "type": "string"
            },
            "relationship": {
              "type": "string"
            }
          },
          "description": "Contact information."
        },
        "department_ids": {
          "type": "array",
          "items": [
            {
              "type": "number"
            },
            {
              "type": "number"
            }
          ],
          "description": "List of department IDS"
        },
        "primary_department_id": {
          "type": "number",
          "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
        },
        "manager_ids": {
          "type": "array",
          "items": [
            {
              "type": "number"
            },
            {
              "type": "number"
            }
          ],
          "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
        },
        "bank_account": {
          "type": "object",
          "properties": {
            "iban": {
              "type": "string",
              "description": "The IBAN number"
            },
            "bic": {
              "type": "string",
              "description": "The BIC number"
            }
          },
          "required": [
            "iban",
            "bic"
          ],
          "description": "The current bank account of the collaborator"
        },
        "primary_address": {
          "type": "object",
          "properties": {
            "street1": {
              "type": "string",
              "description": "Street + house number"
            },
            "street2": {
              "type": "string",
              "description": "Extension of street1"
            },
            "zip": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "country": {
              "type": "string",
              "description": "According to ISO 3166-1 alpha-2"
            }
          },
          "description": "The current address of the collaborator"
        },
        "profile_properties": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "profile_property_id,": {
                "type": "string"
              },
              "freetext_verified,": {
                "type": "string"
              },
              "numeric_verified,": {
                "type": "string"
              },
              "boolean_verified,": {
                "type": "string"
              },
              "list_single_verified,": {
                "type": "string"
              },
              "datetime_verified,": {
                "type": "string"
              },
              "date_verified,": {
                "type": "string"
              },
              "time_verified,": {
                "type": "string"
              },
              "upload_verified,": {
                "type": "string"
              },
              "comment_verified,": {
                "type": "string"
              },
              "documented_proof_verified,": {
                "type": "string"
              },
              "remove_documented_proof_verified,": {
                "type": "string"
              },
              "expiration_date_verified,": {
                "type": "string"
              },
              "freetext_multiline_verified,": {
                "type": "string"
              },
              "list_multi_verified": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "type": "string"
                    },
                    "selected": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "description": "A list of profile properties for the collaboator"
        }
      },
      "required": [
        "other_names",
        "family_name",
        "prefix",
        "email",
        "primary_department_id"
      ]
    }
  },
  "required": [
    "collaborator"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "other_names": "Jane",
  "family_name": "Doe",
  "prefix": "De",
  "email": "example@example.org",
  "birth_country": "BE",
  "birth_country_name": "Belgium",
  "birth_place": "Brussels",
  "birth_date": "01/01/2000",
  "social_statute": "employee",
  "receive_email_campaigns": false,
  "receive_sms_campaigns": false,
  "gender": "employee",
  "language": "nl",
  "national_identification_be": "01.01.00-000.12",
  "national_identification_nl": "123456",
  "national_identification_de": "123456",
  "mobile": "32498000000",
  "phone": "32232840000",
  "nationality": "NL",
  "default_contract_type": "contractual",
  "payroll_identification_code": "12246",
  "contract_types": [
    "freelancer",
    "freelancer",
    "volunteer",
    "interim",
    "contractual",
    "intern"
  ],
  "iban": "BE1223445544",
  "bic": "GEBABEBB",
  "primary_address": {
    "street1": "Dorpstraat 1",
    "street2": "Bus 1",
    "zip": "2018",
    "city": "Antwerpen",
    "country": "BE"
  },
  "departments": [
    {
      "id": "7845",
      "name": "Example Department"
    }
  ],
  "department_ids": [
    7487,
    5646
  ],
  "primary_department_id": 7487,
  "manager_ids": [
    1722,
    2423
  ],
  "profile_properties": "``",
  "profile_property_groups": [
    {
      "name": "Example Info group",
      "profile_properties": [
        {}
      ]
    }
  ],
  "errors": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator. Will be empty if the collaborator could not be saved"
    },
    "other_names": {
      "type": "string",
      "description": "The first name(s) of the collaborator"
    },
    "family_name": {
      "type": "string",
      "description": "The last name of the collaborator"
    },
    "prefix": {
      "type": "string",
      "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
    },
    "email": {
      "type": "string",
      "description": "The  emailaddress of the collaborator. Should be unique for the site"
    },
    "birth_country": {
      "type": "string",
      "description": "Birth country (2 letter code) of the collaborator"
    },
    "birth_country_name": {
      "type": "string",
      "description": "Birth country"
    },
    "birth_place": {
      "type": "string",
      "description": "Birth city of the collaborator"
    },
    "birth_date": {
      "type": "string",
      "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
    },
    "social_statute": {
      "type": "string",
      "enum": [
        "career_pause",
        "disabled_entrepreneur",
        "early_retired",
        "entrepreneur",
        "flexijobs",
        "functionary",
        "incapacitated",
        "living_wager",
        "retired",
        "student",
        "unemployed",
        "unemployed_waiting_period",
        "unknown",
        "working_class",
        "working_class_blue_collar",
        "work_student"
      ],
      "description": "The social statute"
    },
    "receive_email_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive email campaigns"
    },
    "receive_sms_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive SMS campaigns"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "The gender"
    },
    "language": {
      "type": "string",
      "description": "The language the collaborator prefers"
    },
    "national_identification_be": {
      "type": "string",
      "description": "The Belgiam National Identity number (Rijkregister number)"
    },
    "national_identification_nl": {
      "type": "string",
      "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
    },
    "national_identification_de": {
      "type": "string",
      "description": "The German National Identity number"
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number"
    },
    "phone": {
      "type": "string",
      "description": "The secondary phone number"
    },
    "nationality": {
      "type": "string",
      "description": "The nationality (2 letter country code)"
    },
    "default_contract_type": {
      "type": "string",
      "enum": [
        "freelancer",
        "volunteer",
        "interim",
        "contractual",
        "intern"
      ],
      "description": "The default contract type of the collaborator"
    },
    "payroll_identification_code": {
      "type": "string",
      "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
    },
    "contract_types": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The allowed contract types"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account"
    },
    "bic": {
      "type": "string",
      "description": "The BIC of the bank account"
    },
    "primary_address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "description": "Street + house number"
        },
        "street2": {
          "type": "string",
          "description": "Extension of street1"
        },
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "According to ISO 3166-1 alpha-2"
        }
      },
      "description": "The current address of the collaborator"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the department"
          },
          "name": {
            "type": "string",
            "description": "The Name of the department"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "description": "List of Departments"
    },
    "department_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "List of department IDS"
    },
    "primary_department_id": {
      "type": "number",
      "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
    },
    "manager_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
    },
    "profile_properties": {
      "type": "string",
      "description": "Deprecated"
    },
    "profile_property_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the group"
          },
          "profile_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "A list of profile property values under this group"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\n    the project. The keys refer to the name of the field (eg. start_date) but\n    can also be “base” for generic errors. The value is a list of human\n    readable errors for that specific field."
    }
  },
  "required": [
    "other_names",
    "family_name",
    "prefix",
    "email",
    "primary_department_id"
  ]
}

Details
GET/api/v1/admin/collaborators/{id}

Example URI

GET /api/v1/admin/collaborators/7
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "other_names": "Jane",
  "family_name": "Doe",
  "prefix": "De",
  "email": "example@example.org",
  "birth_country": "BE",
  "birth_country_name": "Belgium",
  "birth_place": "Brussels",
  "birth_date": "01/01/2000",
  "social_statute": "employee",
  "receive_email_campaigns": false,
  "receive_sms_campaigns": false,
  "gender": "employee",
  "language": "nl",
  "national_identification_be": "01.01.00-000.12",
  "national_identification_nl": "123456",
  "national_identification_de": "123456",
  "mobile": "32498000000",
  "phone": "32232840000",
  "nationality": "NL",
  "default_contract_type": "contractual",
  "payroll_identification_code": "12246",
  "contract_types": [
    "freelancer",
    "freelancer",
    "volunteer",
    "interim",
    "contractual",
    "intern"
  ],
  "iban": "BE1223445544",
  "bic": "GEBABEBB",
  "primary_address": {
    "street1": "Dorpstraat 1",
    "street2": "Bus 1",
    "zip": "2018",
    "city": "Antwerpen",
    "country": "BE"
  },
  "departments": [
    {
      "id": "7845",
      "name": "Example Department"
    }
  ],
  "department_ids": [
    7487,
    5646
  ],
  "primary_department_id": 7487,
  "manager_ids": [
    1722,
    2423
  ],
  "profile_properties": "``",
  "profile_property_groups": [
    {
      "name": "Example Info group",
      "profile_properties": [
        {}
      ]
    }
  ],
  "errors": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator. Will be empty if the collaborator could not be saved"
    },
    "other_names": {
      "type": "string",
      "description": "The first name(s) of the collaborator"
    },
    "family_name": {
      "type": "string",
      "description": "The last name of the collaborator"
    },
    "prefix": {
      "type": "string",
      "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
    },
    "email": {
      "type": "string",
      "description": "The  emailaddress of the collaborator. Should be unique for the site"
    },
    "birth_country": {
      "type": "string",
      "description": "Birth country (2 letter code) of the collaborator"
    },
    "birth_country_name": {
      "type": "string",
      "description": "Birth country"
    },
    "birth_place": {
      "type": "string",
      "description": "Birth city of the collaborator"
    },
    "birth_date": {
      "type": "string",
      "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
    },
    "social_statute": {
      "type": "string",
      "enum": [
        "career_pause",
        "disabled_entrepreneur",
        "early_retired",
        "entrepreneur",
        "flexijobs",
        "functionary",
        "incapacitated",
        "living_wager",
        "retired",
        "student",
        "unemployed",
        "unemployed_waiting_period",
        "unknown",
        "working_class",
        "working_class_blue_collar",
        "work_student"
      ],
      "description": "The social statute"
    },
    "receive_email_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive email campaigns"
    },
    "receive_sms_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive SMS campaigns"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "The gender"
    },
    "language": {
      "type": "string",
      "description": "The language the collaborator prefers"
    },
    "national_identification_be": {
      "type": "string",
      "description": "The Belgiam National Identity number (Rijkregister number)"
    },
    "national_identification_nl": {
      "type": "string",
      "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
    },
    "national_identification_de": {
      "type": "string",
      "description": "The German National Identity number"
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number"
    },
    "phone": {
      "type": "string",
      "description": "The secondary phone number"
    },
    "nationality": {
      "type": "string",
      "description": "The nationality (2 letter country code)"
    },
    "default_contract_type": {
      "type": "string",
      "enum": [
        "freelancer",
        "volunteer",
        "interim",
        "contractual",
        "intern"
      ],
      "description": "The default contract type of the collaborator"
    },
    "payroll_identification_code": {
      "type": "string",
      "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
    },
    "contract_types": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The allowed contract types"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account"
    },
    "bic": {
      "type": "string",
      "description": "The BIC of the bank account"
    },
    "primary_address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "description": "Street + house number"
        },
        "street2": {
          "type": "string",
          "description": "Extension of street1"
        },
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "According to ISO 3166-1 alpha-2"
        }
      },
      "description": "The current address of the collaborator"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the department"
          },
          "name": {
            "type": "string",
            "description": "The Name of the department"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "description": "List of Departments"
    },
    "department_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "List of department IDS"
    },
    "primary_department_id": {
      "type": "number",
      "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
    },
    "manager_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
    },
    "profile_properties": {
      "type": "string",
      "description": "Deprecated"
    },
    "profile_property_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the group"
          },
          "profile_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "A list of profile property values under this group"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\n    the project. The keys refer to the name of the field (eg. start_date) but\n    can also be “base” for generic errors. The value is a list of human\n    readable errors for that specific field."
    }
  },
  "required": [
    "other_names",
    "family_name",
    "prefix",
    "email",
    "primary_department_id"
  ]
}

Enrolments per collaborator
GET/api/v1/admin/collaborators/{id}/enrolments{?page,page_items}

Example URI

GET /api/v1/admin/collaborators/7/enrolments?page=2&page_items=25
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

filter[period_start_at]
string (optional) Example: 2020-09-28

enrolment start date

filter[period_end_at]
string (optional) Example: 2020-09-29

enrolment end date

filter[statuses]
array (optional) Example: ['confirmed', 'expired']

status

filter[functions]
array (optional) Example: [7, 2]

function ids

page_items
number (optional) Example: 25

items per page

page
number (optional) Example: 2

page number

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "enrolments": [
    {
      "id": "27",
      "uuid": "187a5d1a-f54c-4b09-a4e6-e6644e223b2c",
      "fee": 127.4,
      "team": {
        "id": "27",
        "name": "Example Team",
        "function": {
          "id": "7",
          "name": "A Name",
          "description": "A longer description"
        },
        "extra_practical_info": "Some practical info",
        "volunteers_needed": 5,
        "minimal_age": 18,
        "client_experience_required": false,
        "work_location_id": "120",
        "work_location_specification": "At the entrance",
        "registrations_via_application": true,
        "published": true,
        "relative_checkin_start": "00:30",
        "relative_checkin_duration": "00:15",
        "checkin_appointment_id": "157",
        "maximum_travel_distance": 20,
        "shifts_attributes": [
          {
            "start_datetime": "2017-04-01T09:00:00.000+02:00",
            "end_datetime": "2017-04-01T18:00:00.000+02:00",
            "break_duration": "00:30"
          }
        ],
        "contract_details_attributes": [
          {
            "contract_type": "volunteer",
            "be_collar_type": "arbeider",
            "local_legal_entity_id": "4",
            "compensation_hour_id": "3",
            "compensation_day_id": "1",
            "compensation_team_id": "2"
          }
        ],
        "planning_custom_fields": [
          {
            "planning_custom_field_id": "123",
            "value": "Some text"
          }
        ],
        "errors": [
          "Hello, world!"
        ]
      },
      "contract_type": "interim",
      "collaborator": {
        "name": "John Doe",
        "id": 2403,
        "email": "john.doe@example.org",
        "mobile": "+32498525251",
        "gender": "male",
        "nationality": "BE",
        "social_statute_code": "career_pause",
        "national_registration_numbers": [
          {
            "country": "BE",
            "number": "95.05.07-997.47"
          }
        ],
        "language": "en",
        "birth_date": "1995-05-07",
        "birth_place": "Antwerpen",
        "birth_country": "BE",
        "contact_person": {
          "email": "john.doe@example.org",
          "mobile": "+32498525251"
        },
        "iban": "BE68539007547034",
        "bic": "HBKABE22",
        "primary_address": {
          "street1": "Dorpstraat 1",
          "street2": "Bus 1",
          "zip": "2018",
          "city": "Antwerpen",
          "administrative_area_level_1": "Hello, world!",
          "administrative_area_level_2": "Hello, world!",
          "administrative_area_level_3": "Hello, world!",
          "administrative_area_level_4": "Hello, world!",
          "administrative_area_level_5": "Hello, world!",
          "country": "BE"
        }
      },
      "cancelled": true,
      "blip_management": true,
      "blip": {
        "in_at": "2017-04-28T13:05:00",
        "in_by": "John Doe",
        "out_at": "2017-04-28T13:05:00",
        "out_by": "John Doe"
      },
      "enrolment_property_values": [
        {
          "id": "545",
          "name": "Food",
          "description": "What kind of food do you want",
          "required": true,
          "type": "boolean",
          "remark": "Some remark",
          "value": "true",
          "extras": "Hello, world!"
        }
      ]
    }
  ],
  "count": 1,
  "previous ``": "Hello, world!",
  "next `http://127.0.0.1/api/v1/en/admin/collaborators/311206967/enrolments?filter%5Bfunctions%5D%5B%5D=461245875&filter%5Bperiod_end_at%5D=2020-09-30&filter%5Bperiod_start_at%5D=2020-09-27+13%3A53%3A34+UTC&filter%5Bstatuses%5D%5B%5D=confirmed&filter%5Bstatuses%5D%5B%5D=expired&page=2&page_items=1`": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator."
    },
    "enrolments": {
      "type": "array",
      "description": "filtered enrolments for given collaborator"
    },
    "count": {
      "type": "number",
      "description": "filtered enrolments count"
    },
    "previous ``": {
      "type": "string",
      "description": "url for previous page of results"
    },
    "next `http://127.0.0.1/api/v1/en/admin/collaborators/311206967/enrolments?filter%5Bfunctions%5D%5B%5D=461245875&filter%5Bperiod_end_at%5D=2020-09-30&filter%5Bperiod_start_at%5D=2020-09-27+13%3A53%3A34+UTC&filter%5Bstatuses%5D%5B%5D=confirmed&filter%5Bstatuses%5D%5B%5D=expired&page=2&page_items=1`": {
      "type": "string",
      "description": "url for next page of results"
    }
  },
  "required": [
    "count"
  ]
}

Block
PATCH/api/v1/admin/collaborators/{id}/block

Example URI

PATCH /api/v1/admin/collaborators/7/block
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "block_release_reason": "Comment why the collaborator is blocked",
  "predefined_block_release_reason_id": "2",
  "block_release_remark": "Some longer text describing the reason for blocking the collaborator"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "block_release_reason": {
      "type": "string",
      "description": "Provides a reason why the collaborator is blocked. This can also be sent as `comment`."
    },
    "predefined_block_release_reason_id": {
      "type": "string",
      "description": "The ID of one of the entries in the predefined list of reasons in Settings > Collaborators > Blocking and releasing reasons. The list is only available if setting \"Blocking and releasing reasons\" include \"Limited list\""
    },
    "block_release_remark": {
      "type": "string",
      "description": "A text description of the reason for blocking the collaborator"
    }
  },
  "required": [
    "block_release_reason",
    "predefined_block_release_reason_id",
    "block_release_remark"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "other_names": "Jane",
  "family_name": "Doe",
  "prefix": "De",
  "email": "example@example.org",
  "birth_country": "BE",
  "birth_country_name": "Belgium",
  "birth_place": "Brussels",
  "birth_date": "01/01/2000",
  "social_statute": "employee",
  "receive_email_campaigns": false,
  "receive_sms_campaigns": false,
  "gender": "employee",
  "language": "nl",
  "national_identification_be": "01.01.00-000.12",
  "national_identification_nl": "123456",
  "national_identification_de": "123456",
  "mobile": "32498000000",
  "phone": "32232840000",
  "nationality": "NL",
  "default_contract_type": "contractual",
  "payroll_identification_code": "12246",
  "contract_types": [
    "freelancer",
    "freelancer",
    "volunteer",
    "interim",
    "contractual",
    "intern"
  ],
  "iban": "BE1223445544",
  "bic": "GEBABEBB",
  "primary_address": {
    "street1": "Dorpstraat 1",
    "street2": "Bus 1",
    "zip": "2018",
    "city": "Antwerpen",
    "country": "BE"
  },
  "departments": [
    {
      "id": "7845",
      "name": "Example Department"
    }
  ],
  "department_ids": [
    7487,
    5646
  ],
  "primary_department_id": 7487,
  "manager_ids": [
    1722,
    2423
  ],
  "profile_properties": "``",
  "profile_property_groups": [
    {
      "name": "Example Info group",
      "profile_properties": [
        {}
      ]
    }
  ],
  "errors": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator. Will be empty if the collaborator could not be saved"
    },
    "other_names": {
      "type": "string",
      "description": "The first name(s) of the collaborator"
    },
    "family_name": {
      "type": "string",
      "description": "The last name of the collaborator"
    },
    "prefix": {
      "type": "string",
      "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
    },
    "email": {
      "type": "string",
      "description": "The  emailaddress of the collaborator. Should be unique for the site"
    },
    "birth_country": {
      "type": "string",
      "description": "Birth country (2 letter code) of the collaborator"
    },
    "birth_country_name": {
      "type": "string",
      "description": "Birth country"
    },
    "birth_place": {
      "type": "string",
      "description": "Birth city of the collaborator"
    },
    "birth_date": {
      "type": "string",
      "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
    },
    "social_statute": {
      "type": "string",
      "enum": [
        "career_pause",
        "disabled_entrepreneur",
        "early_retired",
        "entrepreneur",
        "flexijobs",
        "functionary",
        "incapacitated",
        "living_wager",
        "retired",
        "student",
        "unemployed",
        "unemployed_waiting_period",
        "unknown",
        "working_class",
        "working_class_blue_collar",
        "work_student"
      ],
      "description": "The social statute"
    },
    "receive_email_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive email campaigns"
    },
    "receive_sms_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive SMS campaigns"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "The gender"
    },
    "language": {
      "type": "string",
      "description": "The language the collaborator prefers"
    },
    "national_identification_be": {
      "type": "string",
      "description": "The Belgiam National Identity number (Rijkregister number)"
    },
    "national_identification_nl": {
      "type": "string",
      "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
    },
    "national_identification_de": {
      "type": "string",
      "description": "The German National Identity number"
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number"
    },
    "phone": {
      "type": "string",
      "description": "The secondary phone number"
    },
    "nationality": {
      "type": "string",
      "description": "The nationality (2 letter country code)"
    },
    "default_contract_type": {
      "type": "string",
      "enum": [
        "freelancer",
        "volunteer",
        "interim",
        "contractual",
        "intern"
      ],
      "description": "The default contract type of the collaborator"
    },
    "payroll_identification_code": {
      "type": "string",
      "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
    },
    "contract_types": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The allowed contract types"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account"
    },
    "bic": {
      "type": "string",
      "description": "The BIC of the bank account"
    },
    "primary_address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "description": "Street + house number"
        },
        "street2": {
          "type": "string",
          "description": "Extension of street1"
        },
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "According to ISO 3166-1 alpha-2"
        }
      },
      "description": "The current address of the collaborator"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the department"
          },
          "name": {
            "type": "string",
            "description": "The Name of the department"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "description": "List of Departments"
    },
    "department_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "List of department IDS"
    },
    "primary_department_id": {
      "type": "number",
      "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
    },
    "manager_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
    },
    "profile_properties": {
      "type": "string",
      "description": "Deprecated"
    },
    "profile_property_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the group"
          },
          "profile_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "A list of profile property values under this group"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\n    the project. The keys refer to the name of the field (eg. start_date) but\n    can also be “base” for generic errors. The value is a list of human\n    readable errors for that specific field."
    }
  },
  "required": [
    "other_names",
    "family_name",
    "prefix",
    "email",
    "primary_department_id"
  ]
}

Unblock
PATCH/api/v1/admin/collaborators/{id}/unblock

Example URI

PATCH /api/v1/admin/collaborators/7/unblock
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "block_release_reason": "Comment why the collaborator is unblocked",
  "predefined_block_release_reason_id": "2",
  "block_release_remark": "Some longer text describing the reason for releasing the collaborator"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "block_release_reason": {
      "type": "string",
      "description": "Provides a reason why the collaborator is unblocked. This can also be sent as `‘comment`."
    },
    "predefined_block_release_reason_id": {
      "type": "string",
      "description": "The ID of one of the entries in the predefined list defined in Settings > Collaborators > Blocking and releasing reasons. The list is only available if setting \"Blocking and releasing reasons\" include \"Limited list\""
    },
    "block_release_remark": {
      "type": "string",
      "description": "A text description of the reason for releasing the collaborator"
    }
  },
  "required": [
    "block_release_reason",
    "predefined_block_release_reason_id",
    "block_release_remark"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "7",
  "other_names": "Jane",
  "family_name": "Doe",
  "prefix": "De",
  "email": "example@example.org",
  "birth_country": "BE",
  "birth_country_name": "Belgium",
  "birth_place": "Brussels",
  "birth_date": "01/01/2000",
  "social_statute": "employee",
  "receive_email_campaigns": false,
  "receive_sms_campaigns": false,
  "gender": "employee",
  "language": "nl",
  "national_identification_be": "01.01.00-000.12",
  "national_identification_nl": "123456",
  "national_identification_de": "123456",
  "mobile": "32498000000",
  "phone": "32232840000",
  "nationality": "NL",
  "default_contract_type": "contractual",
  "payroll_identification_code": "12246",
  "contract_types": [
    "freelancer",
    "freelancer",
    "volunteer",
    "interim",
    "contractual",
    "intern"
  ],
  "iban": "BE1223445544",
  "bic": "GEBABEBB",
  "primary_address": {
    "street1": "Dorpstraat 1",
    "street2": "Bus 1",
    "zip": "2018",
    "city": "Antwerpen",
    "country": "BE"
  },
  "departments": [
    {
      "id": "7845",
      "name": "Example Department"
    }
  ],
  "department_ids": [
    7487,
    5646
  ],
  "primary_department_id": 7487,
  "manager_ids": [
    1722,
    2423
  ],
  "profile_properties": "``",
  "profile_property_groups": [
    {
      "name": "Example Info group",
      "profile_properties": [
        {}
      ]
    }
  ],
  "errors": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the collaborator. Will be empty if the collaborator could not be saved"
    },
    "other_names": {
      "type": "string",
      "description": "The first name(s) of the collaborator"
    },
    "family_name": {
      "type": "string",
      "description": "The last name of the collaborator"
    },
    "prefix": {
      "type": "string",
      "description": "Last name prefix, this is what appears on the screen of the web application as \"infix\"; for example Jane De Doe"
    },
    "email": {
      "type": "string",
      "description": "The  emailaddress of the collaborator. Should be unique for the site"
    },
    "birth_country": {
      "type": "string",
      "description": "Birth country (2 letter code) of the collaborator"
    },
    "birth_country_name": {
      "type": "string",
      "description": "Birth country"
    },
    "birth_place": {
      "type": "string",
      "description": "Birth city of the collaborator"
    },
    "birth_date": {
      "type": "string",
      "description": "Birth date of the collaborator. ISO DD/MM/YYYY format."
    },
    "social_statute": {
      "type": "string",
      "enum": [
        "career_pause",
        "disabled_entrepreneur",
        "early_retired",
        "entrepreneur",
        "flexijobs",
        "functionary",
        "incapacitated",
        "living_wager",
        "retired",
        "student",
        "unemployed",
        "unemployed_waiting_period",
        "unknown",
        "working_class",
        "working_class_blue_collar",
        "work_student"
      ],
      "description": "The social statute"
    },
    "receive_email_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive email campaigns"
    },
    "receive_sms_campaigns": {
      "type": "boolean",
      "description": "If the collaboraotr wants to receive SMS campaigns"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "The gender"
    },
    "language": {
      "type": "string",
      "description": "The language the collaborator prefers"
    },
    "national_identification_be": {
      "type": "string",
      "description": "The Belgiam National Identity number (Rijkregister number)"
    },
    "national_identification_nl": {
      "type": "string",
      "description": "The Dutch National Identity number (Sociaal zekerheids nummer)"
    },
    "national_identification_de": {
      "type": "string",
      "description": "The German National Identity number"
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number"
    },
    "phone": {
      "type": "string",
      "description": "The secondary phone number"
    },
    "nationality": {
      "type": "string",
      "description": "The nationality (2 letter country code)"
    },
    "default_contract_type": {
      "type": "string",
      "enum": [
        "freelancer",
        "volunteer",
        "interim",
        "contractual",
        "intern"
      ],
      "description": "The default contract type of the collaborator"
    },
    "payroll_identification_code": {
      "type": "string",
      "description": "The payroll code. Only applicable if there is only 1 payroll service for this site"
    },
    "contract_types": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The allowed contract types"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account"
    },
    "bic": {
      "type": "string",
      "description": "The BIC of the bank account"
    },
    "primary_address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "description": "Street + house number"
        },
        "street2": {
          "type": "string",
          "description": "Extension of street1"
        },
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "According to ISO 3166-1 alpha-2"
        }
      },
      "description": "The current address of the collaborator"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the department"
          },
          "name": {
            "type": "string",
            "description": "The Name of the department"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "description": "List of Departments"
    },
    "department_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "List of department IDS"
    },
    "primary_department_id": {
      "type": "number",
      "description": "The ID of the collaborator's primary department. Must be one of the ids included in department_ids"
    },
    "manager_ids": {
      "type": "array",
      "items": [
        {
          "type": "number"
        },
        {
          "type": "number"
        }
      ],
      "description": "Manager IDS. They must be admin collaborators with access rights to approve availabilities."
    },
    "profile_properties": {
      "type": "string",
      "description": "Deprecated"
    },
    "profile_property_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the group"
          },
          "profile_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "A list of profile property values under this group"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "A key-value list of any errors encountered while creating\n\n    the project. The keys refer to the name of the field (eg. start_date) but\n    can also be “base” for generic errors. The value is a list of human\n    readable errors for that specific field."
    }
  },
  "required": [
    "other_names",
    "family_name",
    "prefix",
    "email",
    "primary_department_id"
  ]
}

Link to payroll
POST/api/v1/admin/collaborators/{id}/link_to_payroll

Example URI

POST /api/v1/admin/collaborators/7/link_to_payroll
URI Parameters
HideShow
id
string (required) Example: 7

The collaborator ID

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "collaborator_payroll_identification": {
    "payroll_service_id": "3",
    "code": "ABC123",
    "payroll_type: `admin`  (enum[string], required) - either `admin` or `payroll_only`": {
      "admin": "Hello, world!",
      "payroll_only": "Hello, world!"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "collaborator_payroll_identification": {
      "type": "object",
      "properties": {
        "payroll_service_id": {
          "type": "string",
          "description": "The ID of the payroll integration"
        },
        "code": {
          "type": "string",
          "description": "The code of the collaborator in the payroll integration"
        },
        "payroll_type: `admin`  (enum[string], required) - either `admin` or `payroll_only`": {
          "type": "object",
          "properties": {
            "admin": {
              "type": "string"
            },
            "payroll_only": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "payroll_service_id",
        "code"
      ]
    }
  },
  "required": [
    "collaborator_payroll_identification"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json

Availabilities

Availabilities determine the days or periods of time where a collaborator is available or unavailable for work. The availability start and end is handled as follows: when creating or updating an availability, you must provide:

  • starts_at (date)

  • ends_at (date)

  • start_time (hour HH:MM)

  • end_time (hour HH:MM)

ends_at and end_time can be omitted if the request specifies a day_part_id or whole_day: true. whole_day availabilities run from 00:00 on starts_at day until 00:00 on ends_at day effectively counting 24 hours.

Based on those parameters, Beeple calculates a start_datetime and end_datetime that you will receive in the responses where an availability detail is included such as list, create, details and update. start_datetime and end_datetime are expressed in UTC time. This allows you to specify an availability from 2019-06-01 to 2019-06-11 from 08:00 to 12:00 and thus have a continuous period of 10 days where the collaborator is (un)available from 8am to noon. Beeple internally handles the time periods, although the start_datetime will result in 2019-06-01T08:00:00.000+00:00 and end_datetime in 2019-06-11T12:00:00.000+00:00.

If you want an availability to go over midnight, say from 22:00 to 06:00 the next day, use this in the request:

  • starts_at 2019-06-01

  • start_time 22:00

  • end_time 06:00

This will be handled by Beeple as two periods 2019-06-01 from 22:00 to 23:59 and 2019-06-02 from 00:00 to 06:00

List
GET/api/v1/admin/collaborators/{collaborator_id}/availabilities2?start={start}&end={end}

Example URI

GET /api/v1/admin/collaborators/5/availabilities2?start=2019-01-01&end=2019-01-31
URI Parameters
HideShow
collaborator_id
string (required) Example: 5

The Beeple ID of the collaborator whose availabilities you want to manage

start
date (required) Example: 2019-01-01

YYYY-MM-DD formatted date of start of availabilities

end
date (required) Example: 2019-01-31

YYYY-MM-DD formatted date of end of availabilities

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "availabilities": [
    {
      "id": 1,
      "availability_type_id": 1,
      "starts_at": "2017-04-01",
      "ends_at": "2017-04-01",
      "whole_day": true,
      "start_time": "06:00",
      "end_time": "23:59",
      "period": "single_date",
      "payroll_code_id": 1,
      "duration_in_hours": 8,
      "day_part_id": 1,
      "remark_by_collaborator": "Cannot be present on the 20th at 8am",
      "is_approved": true,
      "approved_by_id": 5,
      "admin_reject_reason": "Did not attach evidence",
      "payroll_approval_status": "not_required",
      "payroll_reject_reason": "An example",
      "payroll_approved": true,
      "payroll_approved_by": "Some name",
      "payroll_approved_at": "2019-04-01T06:00:00.000+00:00",
      "is_locked": true,
      "locked_by_id": 5,
      "start_datetime": "2019-04-01T06:00:00.000+00:00",
      "end_datetime": "2019-04-01T00:23:59.000+00:00",
      "other_availabilities_in_same_repetition": [
        1,
        1
      ],
      "pieces_of_evidence": [
        {
          "id": "546",
          "filename": "Maternity_leave.pdf",
          "url": "https://my.beeple.eu/evidences/87234"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "availabilities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The ID of the collaborator availability"
          },
          "availability_type_id": {
            "type": "number",
            "description": "The id of the Availability Type associated with this collaborator availability"
          },
          "starts_at": {
            "type": "string",
            "description": "Period starts according RFC 3339."
          },
          "ends_at": {
            "type": "string",
            "description": "Period ends according RFC 3339."
          },
          "whole_day": {
            "type": "boolean",
            "description": "when true, the availability will run from starts at 00:00 to ends at 00:00 (midnight to midnight)"
          },
          "start_time": {
            "type": "string",
            "description": "Time of availability start in HH:MM 24 hour format"
          },
          "end_time": {
            "type": "string",
            "description": "Time of availability end in HH:MM 24 hour format"
          },
          "period": {
            "type": "string",
            "enum": [
              "single_date",
              "repeat_daily",
              "repeat_weekly",
              "repeat_monthly"
            ],
            "description": "a single date, a daily, weekly or monthly recurring availability."
          },
          "payroll_code_id": {
            "type": "number",
            "description": "The id of an Availability Type Payroll Code"
          },
          "duration_in_hours": {
            "type": "number",
            "description": "The number of hours associated with this availability"
          },
          "day_part_id": {
            "type": "number",
            "description": "The id of a Day Part"
          },
          "remark_by_collaborator": {
            "type": "string",
            "description": "The remark provided with the availability"
          },
          "is_approved": {
            "type": "boolean",
            "description": "set to true when the availability is approved. False when rejected."
          },
          "approved_by_id": {
            "type": "number",
            "description": "The ID of the admin that approved the availability"
          },
          "admin_reject_reason": {
            "type": "string",
            "description": "an optional remark that describes the reason for rejection"
          },
          "payroll_approval_status": {
            "type": "string",
            "enum": [
              "not_required",
              "unknown",
              "accepted",
              "rejected"
            ],
            "description": "The status according to the payroll. Should ideally only be set to accepted or rejected by the API"
          },
          "payroll_reject_reason": {
            "type": "string",
            "description": "Reason why the payroll rejected the request. Only applicable if payroll_approval_status is rejected"
          },
          "payroll_approved": {
            "type": "boolean",
            "description": "true if payroll service approves the availability; false if payroll service rejects the availability"
          },
          "payroll_approved_by": {
            "type": "string",
            "description": "A name or identification received from the payroll indicating who approved or rejected the availability"
          },
          "payroll_approved_at": {
            "type": "string",
            "description": "Timestamp according RFC 3339 of when availability was approved or rejected."
          },
          "is_locked": {
            "type": "boolean",
            "description": "whether the availability is locked or not (only useful when setting Enable availability locking is set to Yes)"
          },
          "locked_by_id": {
            "type": "number",
            "description": "The ID of the admin or collaborator that locked the availability"
          },
          "start_datetime": {
            "type": "string",
            "description": "Date and time of availability start in UTC time zone"
          },
          "end_datetime": {
            "type": "string",
            "description": "Date and time of availability end in UTC time zone"
          },
          "other_availabilities_in_same_repetition": {
            "type": "array",
            "description": "Only when the availability is part of a repetition list of IDs of other availability records tied to this one in the same repetition"
          },
          "pieces_of_evidence": {
            "type": "array",
            "description": "A list of the evidence files attached to this availability"
          }
        },
        "required": [
          "id",
          "starts_at",
          "start_time",
          "period",
          "is_approved",
          "is_locked",
          "start_datetime"
        ]
      }
    }
  }
}

Create
POST/api/v1/admin/collaborators/{collaborator_id}/availabilities2

Example URI

POST /api/v1/admin/collaborators/5/availabilities2
URI Parameters
HideShow
collaborator_id
string (required) Example: 5

The Beeple ID of the collaborator whose availabilities you want to manage

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "availability": {
    "id": 1,
    "availability_type_id": 1,
    "starts_at": "2017-04-01",
    "ends_at": "2017-04-01",
    "whole_day": true,
    "start_time": "06:00",
    "end_time": "23:59",
    "period": "single_date",
    "payroll_code_id": 1,
    "duration_in_hours": 8,
    "day_part_id": 1,
    "remark_by_collaborator": "Cannot be present on the 20th at 8am",
    "is_approved": true,
    "approved_by_id": 5,
    "admin_reject_reason": "Did not attach evidence",
    "payroll_approval_status": "not_required",
    "payroll_reject_reason": "An example",
    "payroll_approved": true,
    "payroll_approved_by": "Some name",
    "payroll_approved_at": "2019-04-01T06:00:00.000+00:00",
    "is_locked": true,
    "locked_by_id": 5,
    "repetition_schedule_attributes": {
      "repeat_until: `a_date`": "a_date",
      "repeats_every": 1,
      "end_date: `2017-04-01` (string, required) - A final date when the repetition ends according RFC 3339. (only if `repeat_until` is `a_date`)": "Hello, world!",
      "occurrences": 3,
      "monthly_repeat_system": "day_of_month",
      "weekly_repeats_on": [
        1
      ]
    },
    "pieces_of_evidence_attributes": [
      {
        "id": "1234",
        "file": "BCAAAQhAAAI+AQSLT4N9CEAAAhCAAAQySeD/AbfFFlz+mn2AAAAAAElFTkSuQmCC",
        "filename": "a-picture.jpg",
        "_destroy": false
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "availability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the collaborator availability"
        },
        "availability_type_id": {
          "type": "number",
          "description": "The id of the Availability Type associated with this collaborator availability"
        },
        "starts_at": {
          "type": "string",
          "description": "Period starts according RFC 3339."
        },
        "ends_at": {
          "type": "string",
          "description": "Period ends according RFC 3339."
        },
        "whole_day": {
          "type": "boolean",
          "description": "when true, the availability will run from starts at 00:00 to ends at 00:00 (midnight to midnight)"
        },
        "start_time": {
          "type": "string",
          "description": "Time of availability start in HH:MM 24 hour format"
        },
        "end_time": {
          "type": "string",
          "description": "Time of availability end in HH:MM 24 hour format"
        },
        "period": {
          "type": "string",
          "enum": [
            "single_date",
            "repeat_daily",
            "repeat_weekly",
            "repeat_monthly"
          ],
          "description": "a single date, a daily, weekly or monthly recurring availability."
        },
        "payroll_code_id": {
          "type": "number",
          "description": "The id of an Availability Type Payroll Code"
        },
        "duration_in_hours": {
          "type": "number",
          "description": "The number of hours associated with this availability"
        },
        "day_part_id": {
          "type": "number",
          "description": "The id of a Day Part"
        },
        "remark_by_collaborator": {
          "type": "string",
          "description": "The remark provided with the availability"
        },
        "is_approved": {
          "type": "boolean",
          "description": "set to true when the availability is approved. False when rejected."
        },
        "approved_by_id": {
          "type": "number",
          "description": "The ID of the admin that approved the availability"
        },
        "admin_reject_reason": {
          "type": "string",
          "description": "an optional remark that describes the reason for rejection"
        },
        "payroll_approval_status": {
          "type": "string",
          "enum": [
            "not_required",
            "unknown",
            "accepted",
            "rejected"
          ],
          "description": "The status according to the payroll. Should ideally only be set to accepted or rejected by the API"
        },
        "payroll_reject_reason": {
          "type": "string",
          "description": "Reason why the payroll rejected the request. Only applicable if payroll_approval_status is rejected"
        },
        "payroll_approved": {
          "type": "boolean",
          "description": "true if payroll service approves the availability; false if payroll service rejects the availability"
        },
        "payroll_approved_by": {
          "type": "string",
          "description": "A name or identification received from the payroll indicating who approved or rejected the availability"
        },
        "payroll_approved_at": {
          "type": "string",
          "description": "Timestamp according RFC 3339 of when availability was approved or rejected."
        },
        "is_locked": {
          "type": "boolean",
          "description": "whether the availability is locked or not (only useful when setting Enable availability locking is set to Yes)"
        },
        "locked_by_id": {
          "type": "number",
          "description": "The ID of the admin or collaborator that locked the availability"
        },
        "repetition_schedule_attributes": {
          "type": "object",
          "properties": {
            "repeat_until: `a_date`": {
              "type": "string",
              "enum": [
                "a_date",
                "number_of_repetitions"
              ],
              "description": "How to determine the end date of the repetition"
            },
            "repeats_every": {
              "type": "number",
              "description": "the interval at which the repetition occurs: every N days, weeks or months"
            },
            "end_date: `2017-04-01` (string, required) - A final date when the repetition ends according RFC 3339. (only if `repeat_until` is `a_date`)": {
              "type": "string"
            },
            "occurrences": {
              "type": "number"
            },
            "monthly_repeat_system": {
              "type": "string",
              "enum": [
                "day_of_month",
                "week_of_month"
              ],
              "description": "When does the repetition occur: `day_of_month` (Monthly, on the 25)  `week_of_month` (Monthly, on the fourth Thursday)"
            },
            "weekly_repeats_on": {
              "type": "array"
            }
          },
          "required": [
            "repeats_every"
          ],
          "description": "The definition of how the availability will repeat (only if `period` is `repeat_weekly` or `repeat_monthly`)"
        },
        "pieces_of_evidence_attributes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "the ID of the evidence file to attach"
              },
              "file": {
                "type": "string",
                "description": "the Base64-encoded contents of the file"
              },
              "filename": {
                "type": "string",
                "description": "the file name of the evidence"
              },
              "_destroy": {
                "type": "boolean",
                "description": "when set to true, the evidence with the provided ID will be removed"
              }
            },
            "required": [
              "file",
              "filename"
            ]
          },
          "description": "Optional evidence files attached to the availability"
        }
      },
      "required": [
        "id",
        "starts_at",
        "start_time",
        "period",
        "is_approved",
        "is_locked"
      ]
    }
  },
  "required": [
    "availability"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "availability_type_id": 1,
  "starts_at": "2017-04-01",
  "ends_at": "2017-04-01",
  "whole_day": true,
  "start_time": "06:00",
  "end_time": "23:59",
  "period": "single_date",
  "payroll_code_id": 1,
  "duration_in_hours": 8,
  "day_part_id": 1,
  "remark_by_collaborator": "Cannot be present on the 20th at 8am",
  "is_approved": true,
  "approved_by_id": 5,
  "admin_reject_reason": "Did not attach evidence",
  "payroll_approval_status": "not_required",
  "payroll_reject_reason": "An example",
  "payroll_approved": true,
  "payroll_approved_by": "Some name",
  "payroll_approved_at": "2019-04-01T06:00:00.000+00:00",
  "is_locked": true,
  "locked_by_id": 5,
  "start_datetime": "2019-04-01T06:00:00.000+00:00",
  "end_datetime": "2019-04-01T00:23:59.000+00:00",
  "other_availabilities_in_same_repetition": [
    1,
    1
  ],
  "pieces_of_evidence": [
    {
      "id": "546",
      "filename": "Maternity_leave.pdf",
      "url": "https://my.beeple.eu/evidences/87234"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The ID of the collaborator availability"
    },
    "availability_type_id": {
      "type": "number",
      "description": "The id of the Availability Type associated with this collaborator availability"
    },
    "starts_at": {
      "type": "string",
      "description": "Period starts according RFC 3339."
    },
    "ends_at": {
      "type": "string",
      "description": "Period ends according RFC 3339."
    },
    "whole_day": {
      "type": "boolean",
      "description": "when true, the availability will run from starts at 00:00 to ends at 00:00 (midnight to midnight)"
    },
    "start_time": {
      "type": "string",
      "description": "Time of availability start in HH:MM 24 hour format"
    },
    "end_time": {
      "type": "string",
      "description": "Time of availability end in HH:MM 24 hour format"
    },
    "period": {
      "type": "string",
      "enum": [
        "single_date",
        "repeat_daily",
        "repeat_weekly",
        "repeat_monthly"
      ],
      "description": "a single date, a daily, weekly or monthly recurring availability."
    },
    "payroll_code_id": {
      "type": "number",
      "description": "The id of an Availability Type Payroll Code"
    },
    "duration_in_hours": {
      "type": "number",
      "description": "The number of hours associated with this availability"
    },
    "day_part_id": {
      "type": "number",
      "description": "The id of a Day Part"
    },
    "remark_by_collaborator": {
      "type": "string",
      "description": "The remark provided with the availability"
    },
    "is_approved": {
      "type": "boolean",
      "description": "set to true when the availability is approved. False when rejected."
    },
    "approved_by_id": {
      "type": "number",
      "description": "The ID of the admin that approved the availability"
    },
    "admin_reject_reason": {
      "type": "string",
      "description": "an optional remark that describes the reason for rejection"
    },
    "payroll_approval_status": {
      "type": "string",
      "enum": [
        "not_required",
        "unknown",
        "accepted",
        "rejected"
      ],
      "description": "The status according to the payroll. Should ideally only be set to accepted or rejected by the API"
    },
    "payroll_reject_reason": {
      "type": "string",
      "description": "Reason why the payroll rejected the request. Only applicable if payroll_approval_status is rejected"
    },
    "payroll_approved": {
      "type": "boolean",
      "description": "true if payroll service approves the availability; false if payroll service rejects the availability"
    },
    "payroll_approved_by": {
      "type": "string",
      "description": "A name or identification received from the payroll indicating who approved or rejected the availability"
    },
    "payroll_approved_at": {
      "type": "string",
      "description": "Timestamp according RFC 3339 of when availability was approved or rejected."
    },
    "is_locked": {
      "type": "boolean",
      "description": "whether the availability is locked or not (only useful when setting Enable availability locking is set to Yes)"
    },
    "locked_by_id": {
      "type": "number",
      "description": "The ID of the admin or collaborator that locked the availability"
    },
    "start_datetime": {
      "type": "string",
      "description": "Date and time of availability start in UTC time zone"
    },
    "end_datetime": {
      "type": "string",
      "description": "Date and time of availability end in UTC time zone"
    },
    "other_availabilities_in_same_repetition": {
      "type": "array",
      "description": "Only when the availability is part of a repetition list of IDs of other availability records tied to this one in the same repetition"
    },
    "pieces_of_evidence": {
      "type": "array",
      "description": "A list of the evidence files attached to this availability"
    }
  },
  "required": [
    "id",
    "starts_at",
    "start_time",
    "period",
    "is_approved",
    "is_locked",
    "start_datetime"
  ]
}

Details
GET/api/v1/admin/collaborators/{collaborator_id}/availabilities2/{id}

Example URI

GET /api/v1/admin/collaborators/5/availabilities2/1
URI Parameters
HideShow
collaborator_id
string (required) Example: 5

The Beeple ID of the collaborator whose availability you want to manage

id
integer (required) Example: 1

ID of the Availability

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "availability_type_id": 1,
  "starts_at": "2017-04-01",
  "ends_at": "2017-04-01",
  "whole_day": true,
  "start_time": "06:00",
  "end_time": "23:59",
  "period": "single_date",
  "payroll_code_id": 1,
  "duration_in_hours": 8,
  "day_part_id": 1,
  "remark_by_collaborator": "Cannot be present on the 20th at 8am",
  "is_approved": true,
  "approved_by_id": 5,
  "admin_reject_reason": "Did not attach evidence",
  "payroll_approval_status": "not_required",
  "payroll_reject_reason": "An example",
  "payroll_approved": true,
  "payroll_approved_by": "Some name",
  "payroll_approved_at": "2019-04-01T06:00:00.000+00:00",
  "is_locked": true,
  "locked_by_id": 5,
  "start_datetime": "2019-04-01T06:00:00.000+00:00",
  "end_datetime": "2019-04-01T00:23:59.000+00:00",
  "other_availabilities_in_same_repetition": [
    1,
    1
  ],
  "pieces_of_evidence": [
    {
      "id": "546",
      "filename": "Maternity_leave.pdf",
      "url": "https://my.beeple.eu/evidences/87234"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The ID of the collaborator availability"
    },
    "availability_type_id": {
      "type": "number",
      "description": "The id of the Availability Type associated with this collaborator availability"
    },
    "starts_at": {
      "type": "string",
      "description": "Period starts according RFC 3339."
    },
    "ends_at": {
      "type": "string",
      "description": "Period ends according RFC 3339."
    },
    "whole_day": {
      "type": "boolean",
      "description": "when true, the availability will run from starts at 00:00 to ends at 00:00 (midnight to midnight)"
    },
    "start_time": {
      "type": "string",
      "description": "Time of availability start in HH:MM 24 hour format"
    },
    "end_time": {
      "type": "string",
      "description": "Time of availability end in HH:MM 24 hour format"
    },
    "period": {
      "type": "string",
      "enum": [
        "single_date",
        "repeat_daily",
        "repeat_weekly",
        "repeat_monthly"
      ],
      "description": "a single date, a daily, weekly or monthly recurring availability."
    },
    "payroll_code_id": {
      "type": "number",
      "description": "The id of an Availability Type Payroll Code"
    },
    "duration_in_hours": {
      "type": "number",
      "description": "The number of hours associated with this availability"
    },
    "day_part_id": {
      "type": "number",
      "description": "The id of a Day Part"
    },
    "remark_by_collaborator": {
      "type": "string",
      "description": "The remark provided with the availability"
    },
    "is_approved": {
      "type": "boolean",
      "description": "set to true when the availability is approved. False when rejected."
    },
    "approved_by_id": {
      "type": "number",
      "description": "The ID of the admin that approved the availability"
    },
    "admin_reject_reason": {
      "type": "string",
      "description": "an optional remark that describes the reason for rejection"
    },
    "payroll_approval_status": {
      "type": "string",
      "enum": [
        "not_required",
        "unknown",
        "accepted",
        "rejected"
      ],
      "description": "The status according to the payroll. Should ideally only be set to accepted or rejected by the API"
    },
    "payroll_reject_reason": {
      "type": "string",
      "description": "Reason why the payroll rejected the request. Only applicable if payroll_approval_status is rejected"
    },
    "payroll_approved": {
      "type": "boolean",
      "description": "true if payroll service approves the availability; false if payroll service rejects the availability"
    },
    "payroll_approved_by": {
      "type": "string",
      "description": "A name or identification received from the payroll indicating who approved or rejected the availability"
    },
    "payroll_approved_at": {
      "type": "string",
      "description": "Timestamp according RFC 3339 of when availability was approved or rejected."
    },
    "is_locked": {
      "type": "boolean",
      "description": "whether the availability is locked or not (only useful when setting Enable availability locking is set to Yes)"
    },
    "locked_by_id": {
      "type": "number",
      "description": "The ID of the admin or collaborator that locked the availability"
    },
    "start_datetime": {
      "type": "string",
      "description": "Date and time of availability start in UTC time zone"
    },
    "end_datetime": {
      "type": "string",
      "description": "Date and time of availability end in UTC time zone"
    },
    "other_availabilities_in_same_repetition": {
      "type": "array",
      "description": "Only when the availability is part of a repetition list of IDs of other availability records tied to this one in the same repetition"
    },
    "pieces_of_evidence": {
      "type": "array",
      "description": "A list of the evidence files attached to this availability"
    }
  },
  "required": [
    "id",
    "starts_at",
    "start_time",
    "period",
    "is_approved",
    "is_locked",
    "start_datetime"
  ]
}

Update/modify
PATCH/api/v1/admin/collaborators/{collaborator_id}/availabilities2/{id}

Example URI

PATCH /api/v1/admin/collaborators/5/availabilities2/1
URI Parameters
HideShow
collaborator_id
string (required) Example: 5

The Beeple ID of the collaborator whose availabilities you want to manage

id
integer (required) Example: 1

ID of the Availability

Request
HideShow
Headers
Content-Type: application/json
Token: AAAA-BBBB-CCCC
Body
{
  "availability": {
    "id": 1,
    "availability_type_id": 1,
    "starts_at": "2017-04-01",
    "ends_at": "2017-04-01",
    "whole_day": true,
    "start_time": "06:00",
    "end_time": "23:59",
    "period": "single_date",
    "payroll_code_id": 1,
    "duration_in_hours": 8,
    "day_part_id": 1,
    "remark_by_collaborator": "Cannot be present on the 20th at 8am",
    "is_approved": true,
    "approved_by_id": 5,
    "admin_reject_reason": "Did not attach evidence",
    "payroll_approval_status": "not_required",
    "payroll_reject_reason": "An example",
    "payroll_approved": true,
    "payroll_approved_by": "Some name",
    "payroll_approved_at": "2019-04-01T06:00:00.000+00:00",
    "is_locked": true,
    "locked_by_id": 5,
    "split_and_keep_old_entry": true,
    "split_and_keep_overlaps: `true` (boolean, optional) - when true, if the availability overlaps with existing availability/ies the system will try to modify the existing one(s) to make the change fit (similar to what split_and_keep_old_entry does) and if it cannot change them, it will remove them and save the one being updated.": "Hello, world!",
    "repetition_change_which_ids:  `only_on_this_instance`": "only_on_this_instance",
    "n_following_instances": "3"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "availability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the collaborator availability"
        },
        "availability_type_id": {
          "type": "number",
          "description": "The id of the Availability Type associated with this collaborator availability"
        },
        "starts_at": {
          "type": "string",
          "description": "Period starts according RFC 3339."
        },
        "ends_at": {
          "type": "string",
          "description": "Period ends according RFC 3339."
        },
        "whole_day": {
          "type": "boolean",
          "description": "when true, the availability will run from starts at 00:00 to ends at 00:00 (midnight to midnight)"
        },
        "start_time": {
          "type": "string",
          "description": "Time of availability start in HH:MM 24 hour format"
        },
        "end_time": {
          "type": "string",
          "description": "Time of availability end in HH:MM 24 hour format"
        },
        "period": {
          "type": "string",
          "enum": [
            "single_date",
            "repeat_daily",
            "repeat_weekly",
            "repeat_monthly"
          ],
          "description": "a single date, a daily, weekly or monthly recurring availability."
        },
        "payroll_code_id": {
          "type": "number",
          "description": "The id of an Availability Type Payroll Code"
        },
        "duration_in_hours": {
          "type": "number",
          "description": "The number of hours associated with this availability"
        },
        "day_part_id": {
          "type": "number",
          "description": "The id of a Day Part"
        },
        "remark_by_collaborator": {
          "type": "string",
          "description": "The remark provided with the availability"
        },
        "is_approved": {
          "type": "boolean",
          "description": "set to true when the availability is approved. False when rejected."
        },
        "approved_by_id": {
          "type": "number",
          "description": "The ID of the admin that approved the availability"
        },
        "admin_reject_reason": {
          "type": "string",
          "description": "an optional remark that describes the reason for rejection"
        },
        "payroll_approval_status": {
          "type": "string",
          "enum": [
            "not_required",
            "unknown",
            "accepted",
            "rejected"
          ],
          "description": "The status according to the payroll. Should ideally only be set to accepted or rejected by the API"
        },
        "payroll_reject_reason": {
          "type": "string",
          "description": "Reason why the payroll rejected the request. Only applicable if payroll_approval_status is rejected"
        },
        "payroll_approved": {
          "type": "boolean",
          "description": "true if payroll service approves the availability; false if payroll service rejects the availability"
        },
        "payroll_approved_by": {
          "type": "string",
          "description": "A name or identi