Org Unit

Allows accessing and manipulating organizational units.

`GET /v1/org-unit`

Provides a list of org units, with optional filtering.

Params

token - Required. Parameter or cookie of user token.
type - Type of org unit to show.
types - A comma-separated list of org unit types to show.
venue - Venue type.
code - Search of codes. Cannot be venue type.
parent - Search for org units which are the parent id or its children
name - Search of names.
limit - Integer. Number of results to return, defaults to 100.
offset - Integer. Offset for results, defaults to 0.

Responses

Code: 200
Content: Array of org unit objects.

[
  {
      "id": 1,
      "name": "United States",
      "code": "US",
      "type": "Nation"
  }
]

Invalid org unit type specified.
Code: 400
Content: { status: 400, message: 'Invalid type specified' }
Using non-venue type while specifying venue.
Code: 400
Content: { status: 400, message: 'Invalid type with "venue" option' }
Specifying a code with a venue type.
Code: 400
Content: { status: 400, message: 'Venue type does not have codes' }
Other errors.
Code: 500
Content: { status: 400, message: 'Search failed' }

`GET /v1/org-unit/{id}`

Provides details about a given org unit.

Params

{id} - Required. Can be the numeric ID, the code for non-venues, or “me” for the current user’s associated org unit.
token - Required. Parameter or cookie of user token.
users - If set to 0, hide users from response.
offices - If set to 0, hide offices from response.
children - Sets depth of children returned, -1 is all and 0 is none. Defaults to all.
parents - Sets number of parents returned, -1 is all and 0 is none. Defaults to all.

Responses

Code: 200
Content: Details of org unit.

{
  "unit":{
      "id":1,
      "name":"United States",
      "code":"US",
      "location":null,
      "website":"https://windingpath.club",
      "type":"Nation",
      "defDoc":null,
      "users":[],
      "offices":[
          {
              "id":1,
              "name":"Club Manager",
              "type":"Primary",
              "user":{
                  "membershipNumber":"WPI20180002",
                  "firstName":"Jeremy",
                  "lastName":"White",
                  "userID":2
              }
          }
      ]
  },
  "children":[
      {
          "id":2,
          "name":"North East",
          "code":"NE",
          "type":"Region",
          "children":[
              {
                  "id":3,
                  "name":"Children of the Lost Eden",
                  "code":"NY-004",
                  "type":"Chapter",
                  "children":[]
              }
          ]
      },
  ],
  "parents":[]
}

Code: 404
Content: { status: 404, message: 'Org unit not found' }

`GET /v1/org-unit/types`

Provide list of org unit types

Responses

Code: 200
Content: List of org unit types.
```
["Nation","Region","Chapter","Venue"]
```

`POST /v1/org-unit`

Creates a new org unit, along with the given offices.

Params

token - Required. Parameter or cookie of user token. Needs org_create_{type} role, with {type} being the org unit type being created.

Body

type: Required. The type of unit.
parentID: Required. The parent ID of the unit.
name: Required. Unit name.
code: Required except for venue type. The code for the unit.
venueType: Required for venue type. The two-letter code for a given venue.
location: Location of the venue.
defDoc: A definition doc, such as a VSS or chapter info.
website: A URL to find the org unit at.
id: The org unit ID. Should not normally be specified.

Responses

Code: 200
Content: Details of org unit.
No body data provided.
Code: 400
Content: { status: 400, message: 'No data provided' }
The parent ID wasn’t specified.
Code: 400
Content: { status: 400, message: 'No parent provided' }
Code: 400
Content: { status: 400, message: 'Invalid org unit type' }
Code: 400
Content: { status: 400, message: 'Parent not found' }
Parent org unit type wasn’t the expected type, such as a venue under a region.
Code: 400
Content: { status: 400, message: 'Org type doesn't match expected type' }
Invalid body data provided.
Code: 400
Content: { status: 400, message: 'Invalid data provided: [errors]' }
Unknown error.
Code: 500
Content: { status: 500, message: 'There was an error creating the org unit' }

`PUT /v1/org-unit/{id}`

Updates an org unit.

Params

{id} - Required. Can be the numeric ID, the code for non-venues, or “me” for the current user’s associated org unit.
token - Required. Parameter or cookie of user token. Needs org_update role over unit.

Body

name: Unit name.
code: Ignored for venue type. The code for the unit.
location: Location of the venue.
defDoc: A definition doc, such as a VSS or chapter info.
website: A URL to find the org unit at.

Responses

Code: 200
Content: Updated details of org unit.
No body data provided.
Code: 400
Content: { status: 400, message: 'No data provided' }
Code: 404
Content: { status: 404, message: 'Org unit not found' }
Invalid body data provided.
Code: 400
Content: { status: 400, message: 'Invalid data provided: [errors]' }

`DELETE /v1/org-unit/{id}`

Deletes an org unit, and associated offices. Users attached to the unit are moved to the parent.

Params

{id} - Required. Can be the numeric ID, the code for non-venues, or “me” for the current user’s associated org unit.
token - Required. Parameter or cookie of user token. Needs org_create_{type} role over the unit, with {type} being the org unit type being created.

Responses

Code: 200
Content: { success: true }
Deleting the root org isn’t allowed.
Code: 500
Content: { status: 400, message: 'Cannot delete root org' }
Code: 404
Content: { status: 404, message: 'Org unit not found' }
Deleting an org unit with children units is forbidden.
Code: 500
Content: { status: 500, message: 'Cannot delete org with children' }
When moving the users, the parent org unit wasn’t found.
Code: 500
Content: { status: 500, message: 'No parent found' }
Deleting the org unit had a problem.
Code: 500
Content: { status: 500, message: 'Could not delete org' }

WPI User Hub

WPI User Hub

Org Unit

`GET /v1/org-unit`

`GET /v1/org-unit/{id}`

`GET /v1/org-unit/types`

`POST /v1/org-unit`

`PUT /v1/org-unit/{id}`

`DELETE /v1/org-unit/{id}`