Common Responses

401 Authorization header not present or token expired or invalid

500 Unexpected server error

Organization Teams Controller

This controller allows for creating org chart teams entries and assigning their hierarchy.

GET /odata/OrganizationTeamHierarchies(id)

Retrieve the Organization Team with the given id

Returns:

200: success, response body is an Organization Team in JSON format

404: team not found

GET /odata/OrganizationTeamHierarchies

Get a list of all teams defined.  The output can be filtered using OData parameters.

Returns:

200: success, response body is an OData list of all matching Organization Team objects in JSON format

POST /odata/OrganizationTeamHierarchies

Create a new Organization Team entity in the system.  Request body is expected to be an Organization Team object in JSON format.

Returns:

200: success, response body is the resulting Organization Team (with Id populated).

400: invalid request: format error or CompanyId of team doesn't match id of authenticated user making the request

PATCH /odata/OrganizationTeamHierarchies(id)

PUT /odata/OrganizationTeamHierarchies(id)

Update the existing entry for the team with key id.

Returns:

204: success

400: invalid request: format error or CompanyId of team doesn't match id of authenticated user making the request

404: no such team found

DELETE /odata/OrganizationTeamHierarchies(id)

Remove the team from the system

Returns:

204: success

400: invalid request: CompanyId of team doesn't match id of authenticated user making the request

404: no such team found

Organization Team Members Controller

This controller allows for assigning/removing users to/from org chart teams.

GET /odata/

...

OrganizationTeamMemberHierarchies(id)

Retrieve the Team Membership with the Organization Team given id

Returns:

200: success, response body is an Organization Team in JSON format

404: entry not found for that id

GET /odata/OrganizationTeamMemberHierarchies

Get a list of all team memberships defined.  The output can be filtered using OData parameters.

Returns:

200: success, response body is an OData list of all matching Organization Team Membership objects in JSON format

POST /odata/OrganizationTeamMemberHierarchies

Create a new Organization Team entity in the system.  Request body is expected to be an Organization Team object in JSON format.

Returns:

200: success, response body is the resulting entry (with Id populated).

400: invalid request: format error or CompanyId of team doesn't match id of authenticated user making the request

409: an entry already exists for this user and team

DELETE /odata/OrganizationTeamMemberHierarchies(id)

Remove the membership for the given user in the given team.

Returns:

204: success

404: no such entry found

Users controller

This controller provides read/write access to User (=> employee/personnel) records.

...

200 on success, User object as JSON payload

404 on user not found403 on unauthorized request

500 on exception

GET /odata/Users

Get all accessible user objects.  Administrators can see all users but otherwise only users in teams managed by the authenticated user will be visible.

...

200 on success, OData query result as JSON payload403 on unauthorized request

500 on exception

POST /odata/Users

Create a new user object.  Body of request is a User object in JSON format.

...

400 on invalid request: duplicate username or invalid fields

403 on unauthorized request

500 on exception

PATCH /odata/Users(id)

PUT /odata/Users(id)

...

400 on invalid request: invalid fields or Id in body doesn't match the one provided in the URL.

403 on unauthorized request

404 on no such user500 on exception