API Overview Resources Schemas

Special Treatment

Access to special treatment

Get special treatment

Returns all special treatments for the specific tenant

GET /orgs/{org_id}/special-treatment

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/special-treatment \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	List of special treatment values	SpecialTreatmentValues
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Update special treatment

Update the list of valid special treatment values for this tenant

PATCH /orgs/{org_id}/special-treatment

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
body	body	SpecialTreatmentValues	true	‘none’

Request body - instance of SpecialTreatmentValues

1
2
3
4
5
6
7
8


{
  "values": [
    "silver",
    "gold",
    "platinum",
    "vip"
  ]
}

Name	Type	Required	Description
values	[string]	true	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14



curl -X PATCH https://customers.sta.masstack.com/v4/orgs/telco/special-treatment \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'values': [
    'silver',
    'gold',
    'platinum',
    'vip'
  ]
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Special treatment values updated successfully	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Endpoints

Accounts

External accounts

Customers

External customers