Tiers (Company Level)
tiers

Discussion

The tiers which can be used to categorize units

>>>

GET /v1/companies/:company_id/tiers
Show all tiers for a company

Params

Param name Description
including_deleted
optional

Validations:

  • Must be one of: true, false, 1, 0.
>>>

GET /v1/companies/:company_id/tiers/:id
Gets a single tier

Params

Param name Description
id
required

ID of the tier to be returned

Validations:

  • Must be a String
>>>

POST /v1/companies/:company_id/tiers
Creates a single tier

Params

Param name Description
tier
required

Validations:

  • Must be a Hash
tier[description]
required

The description of the tier

Validations:

  • Must be a String
tier[external_description]
optional

The external description of the tier

Validations:

  • Must be a String
>>>

PATCH /v1/companies/:company_id/tiers/:id
Updates a single tier

PUT /v1/companies/:company_id/tiers/:id
Updates a single tier

Params

Param name Description
tier
required

Validations:

  • Must be a Hash
tier[description]
required

The description of the tier

Validations:

  • Must be a String
tier[external_description]
optional

The external description of the tier

Validations:

  • Must be a String
>>>

DELETE /v1/companies/:company_id/tiers/:id
Deletes a tier and reranks the remaining tiers

Params

Param name Description
id
required

ID of the tier to be deleted

Validations:

  • Must be a String
user_id
optional

ID of the user deleting the tier

Validations:

  • Must be a String
>>>

PATCH /v1/companies/:company_id/tiers/reorder
Updates the rank of each active tier in the company

Params

Param name Description
tiers
required

An array of ids and ranks for all active tiers for the company

Validations:

  • Must be an Array of nested elements
tiers[id]
required

Validations:

  • Must be a String
tiers[rank]
required

Validations:

  • Must be a Integer