API docs by Redocly

Membership portal (1.0.0)

Download OpenAPI specification:Download

License: Eclipse Public License - 2.0

Membership form

Definitions related to membership form data in the database

Membership form list

Returns a list of tracked membership forms

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Membership form create

Using the passed form object, updates or inserts are made to save the data.

Request Body schema: application/json

The form to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

user_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

membership_level
string

The level of membership with the Eclipse Foundation that is being targeted.

signing_authority
boolean

Whether the currently submitting user has signing authority for membership contracts.

purchase_order_required
string or null
Enum: "yes" "no" "na"

Indicator for whether a purchase order is required, either yes, no, or not applicable.

vat_number
string or null

The EU VAT registration number, if applicable

registration_country
string or null

The EU country the organization is registered under for VAT.

updated_date
string <datetime> (DateTime)

Date string in the RFC 3339 format. Example, 1990-12-31T"15":"59":60-"08":00.

More on this standard can be read at https://tools.ietf.org/html/rfc3339.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "membership_level": "string",
  • "signing_authority": true,
  • "purchase_order_required": "yes",
  • "vat_number": "string",
  • "registration_country": "string",
  • "updated_date": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "membership_level": "string",
  • "signing_authority": true,
  • "purchase_order_required": "yes",
  • "vat_number": "string",
  • "registration_country": "string",
  • "updated_date": "string"
}

Membership form

Returns a membership form entry that has a matching ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "membership_level": "string",
  • "signing_authority": true,
  • "purchase_order_required": "yes",
  • "vat_number": "string",
  • "registration_country": "string",
  • "updated_date": "string"
}

Membership form update

Using the passed form object, updates or inserts are made to save the data.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Request Body schema: application/json

The form to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

user_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

membership_level
string

The level of membership with the Eclipse Foundation that is being targeted.

signing_authority
boolean

Whether the currently submitting user has signing authority for membership contracts.

purchase_order_required
string or null
Enum: "yes" "no" "na"

Indicator for whether a purchase order is required, either yes, no, or not applicable.

vat_number
string or null

The EU VAT registration number, if applicable

registration_country
string or null

The EU country the organization is registered under for VAT.

updated_date
string <datetime> (DateTime)

Date string in the RFC 3339 format. Example, 1990-12-31T"15":"59":60-"08":00.

More on this standard can be read at https://tools.ietf.org/html/rfc3339.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "membership_level": "string",
  • "signing_authority": true,
  • "purchase_order_required": "yes",
  • "vat_number": "string",
  • "registration_country": "string",
  • "updated_date": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "membership_level": "string",
  • "signing_authority": true,
  • "purchase_order_required": "yes",
  • "vat_number": "string",
  • "registration_country": "string",
  • "updated_date": "string"
}

Membership form delete

Remove a membership form entry with the given ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Membership form submit

Submit a finalized form to the membership team

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Membership form validation

Validate the current form as CONFIRMED or REJECTED

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

transactionId
required
number

Unique ID of the transaction entry

query Parameters
token
required
string

Unique token of the transaction entry

state
required
string (FormState)
Enum: "SUBMITTED" "INPROGRESS" "COMPLETE" "CONFIRMED" "REJECTED"

The validated state of the current form

Responses

Form Contacts

Definitions related to membership form designated contacts

Contacts list

Returns a list of tracked contacts

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contacts create

Using the passed contact object, updates or inserts are made to save the data.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Request Body schema: application/json

The contact to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

first_name
string

First name of the contact

last_name
string

Last name of the contact

email
string

Professional email address at which the individual can be reached at

job_title
string

Job title of the contact

type
string (ContactType)
Enum: "COMPANY" "WORKING_GROUP" "MARKETING" "ACCOUNTING" "SIGNING"

The type of contact that is being stored

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "job_title": "string",
  • "type": "COMPANY"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "job_title": "string",
  • "type": "COMPANY"
}

Contacts

Returns a contact for the form given a form ID and contact ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

contactID
required
string or null (ObjectID) >= 1

Unique ID of the contact for the current form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "job_title": "string",
  • "type": "COMPANY"
}

Contacts update

Using the passed contact object, updates or inserts are made to save the data.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

contactID
required
string or null (ObjectID) >= 1

Unique ID of the contact for the current form

Request Body schema: application/json

The contact to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

first_name
string

First name of the contact

last_name
string

Last name of the contact

email
string

Professional email address at which the individual can be reached at

job_title
string

Job title of the contact

type
string (ContactType)
Enum: "COMPANY" "WORKING_GROUP" "MARKETING" "ACCOUNTING" "SIGNING"

The type of contact that is being stored

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "job_title": "string",
  • "type": "COMPANY"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "job_title": "string",
  • "type": "COMPANY"
}

Contacts delete

Remove a contact entry with the given ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

contactID
required
string or null (ObjectID) >= 1

Unique ID of the contact for the current form

Responses

Form Organizations

Definitions related to membership form organizations

Form Organizations list

Returns a list of tracked organizationsfor the form

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Form Organizations create

Using the passed organization object, a new organization object is saved to the dataset.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Request Body schema: application/json

The organization to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

legal_name
string

Legal Name of the Organization

organization_type
string
Enum: "NON_PROFIT_OPEN_SOURCE" "ACADEMIC" "STANDARDS" "GOVERNMENT_ORGANIZATION_AGENCY_NGO" "MEDIA_ORGANIZATION" "RESEARCH" "OTHER"

The category of organization used for fee determination for current entity

twitter
string

The Twitter handle of the organization

aggregate_revenue
string

The aggregate revenue of the organization and its affiliates

employee_count
string

The number of employees for the given organization

object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "legal_name": "string",
  • "organization_type": "NON_PROFIT_OPEN_SOURCE",
  • "twitter": "string",
  • "aggregate_revenue": "string",
  • "employee_count": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "legal_name": "string",
  • "organization_type": "NON_PROFIT_OPEN_SOURCE",
  • "twitter": "string",
  • "aggregate_revenue": "string",
  • "employee_count": "string",
  • "address": {
    }
}

Form Organizations update

Using the passed organization object, updates or inserts are made to save the data.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

orgID
required
string or null (ObjectID) >= 1

Unique ID of the organization for the form entry

Request Body schema: application/json

The organization to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

legal_name
string

Legal Name of the Organization

organization_type
string
Enum: "NON_PROFIT_OPEN_SOURCE" "ACADEMIC" "STANDARDS" "GOVERNMENT_ORGANIZATION_AGENCY_NGO" "MEDIA_ORGANIZATION" "RESEARCH" "OTHER"

The category of organization used for fee determination for current entity

twitter
string

The Twitter handle of the organization

aggregate_revenue
string

The aggregate revenue of the organization and its affiliates

employee_count
string

The number of employees for the given organization

object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "legal_name": "string",
  • "organization_type": "NON_PROFIT_OPEN_SOURCE",
  • "twitter": "string",
  • "aggregate_revenue": "string",
  • "employee_count": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "legal_name": "string",
  • "organization_type": "NON_PROFIT_OPEN_SOURCE",
  • "twitter": "string",
  • "aggregate_revenue": "string",
  • "employee_count": "string",
  • "address": {
    }
}

Form Organizations delete

Remove an organization for the form given a form ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

orgID
required
string or null (ObjectID) >= 1

Unique ID of the organization for the form entry

Responses

Form Working Groups

Definitions related to membership form working group targets

Form Working Groups list

Returns a list of tracked Form Working Groups for membership form

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Form Working Groups create

Using the passed Form Working Groups object, creates a new object in the dataset.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

Request Body schema: application/json

The working group to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

working_group
string

The ID of the working group relationship to be formed

participation_level
string

The desired participation level desired within the new working group

effective_date
string <datetime> (DateTime)

Date string in the RFC 3339 format. Example, 1990-12-31T"15":"59":60-"08":00.

More on this standard can be read at https://tools.ietf.org/html/rfc3339.

object (Contact)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "working_group": "string",
  • "participation_level": "string",
  • "effective_date": "string",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "working_group": "string",
  • "participation_level": "string",
  • "effective_date": "string",
  • "contact": {
    }
}

Form Working Group

Returns a working group entry that has a matching ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

workingGroupID
required
string or null (ObjectID) >= 1

Unique ID of the working group relationship within a form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "working_group": "string",
  • "participation_level": "string",
  • "effective_date": "string",
  • "contact": {
    }
}

Form Working Groups update

Using the passed Form Working Groups object, updates or inserts are made to save the data.

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

workingGroupID
required
string or null (ObjectID) >= 1

Unique ID of the working group relationship within a form

Request Body schema: application/json

The working group to be updated or inserted into the data set.

id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

form_id
string or null (ObjectID) >= 1

Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.

working_group
string

The ID of the working group relationship to be formed

participation_level
string

The desired participation level desired within the new working group

effective_date
string <datetime> (DateTime)

Date string in the RFC 3339 format. Example, 1990-12-31T"15":"59":60-"08":00.

More on this standard can be read at https://tools.ietf.org/html/rfc3339.

object (Contact)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "working_group": "string",
  • "participation_level": "string",
  • "effective_date": "string",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "working_group": "string",
  • "participation_level": "string",
  • "effective_date": "string",
  • "contact": {
    }
}

Form Working Groups delete

Remove a working group form entry with the given ID

path Parameters
id
required
string or null (ObjectID) >= 1

Unique ID of the membership form entry

workingGroupID
required
string or null (ObjectID) >= 1

Unique ID of the working group relationship within a form

Responses

Working Groups

Definitions related to Eclipse Foundation working group entities

Membership forms

Membership form report

Returns a CSV report of the current forms with the given state

path Parameters
state
required
string (FormState)
Enum: "SUBMITTED" "INPROGRESS" "COMPLETE" "CONFIRMED" "REJECTED"

Unique ID of the membership form entry

Responses

Working Group Application

Working Group Application list

Returns a list of working group applications

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Working Group Application create

Creates a new working group application

Request Body schema: application/json

The working group to be updated or inserted into the data set.

id
integer or null

Unique ID for the working group application, can be ommitted for new applications.

user
string

Requesting user from the organization

org_id
integer

The organization associated with the request

Array of objects or null
created
string

The time the application was created

updated
string

The time the application was last updated

state
string
Enum: "INPROGRESS" "SUBMITTED" "COMPLETE"

The current state of the application

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "user": "string",
  • "org_id": 0,
  • "contacts": [
    ],
  • "created": "string",
  • "updated": "string",
  • "state": "INPROGRESS"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user": "string",
  • "org_id": 0,
  • "contacts": [
    ],
  • "created": "string",
  • "updated": "string",
  • "state": "INPROGRESS"
}

Working Group Application single

Returns a list of working group applications

path Parameters
id
required
int

Unique ID of the working group application form

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user": "string",
  • "org_id": 0,
  • "contacts": [
    ],
  • "created": "string",
  • "updated": "string",
  • "state": "INPROGRESS"
}

Working Group Application update

Updates an existing working group application

path Parameters
id
required
int

Unique ID of the working group application form

Request Body schema: application/json

The working group to be updated in the data set.

id
integer or null

Unique ID for the working group application, can be ommitted for new applications.

user
string

Requesting user from the organization

org_id
integer

The organization associated with the request

Array of objects or null
created
string

The time the application was created

updated
string

The time the application was last updated

state
string
Enum: "INPROGRESS" "SUBMITTED" "COMPLETE"

The current state of the application

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "user": "string",
  • "org_id": 0,
  • "contacts": [
    ],
  • "created": "string",
  • "updated": "string",
  • "state": "INPROGRESS"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user": "string",
  • "org_id": 0,
  • "contacts": [
    ],
  • "created": "string",
  • "updated": "string",
  • "state": "INPROGRESS"
}

Working Group Application complete

Completes an existing working group application

path Parameters
id
required
int

Unique ID of the working group application form

Responses

Email

Opt out an email

Adds an email to our opt-out list to be excluded from further emails

path Parameters
id
required
string

Unique contact ID

transactionId
required
number

Unique ID of the transaction entry

query Parameters
token
required
string

Secure Transaction token for validation

email
required
string

Contact email to be opted out from further emails

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "message": "string",
  • "url": "string"
}

User Info

Info on currently logged in user

returns information about the currently logged in user

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "given_name": "string",
  • "family_name": "string",
  • "email": "string",
  • "organizational_roles": {
    }
}