Customers Categories

Get customer category history values

For a given customer id, returns the history for category updates

GET /orgs/{org_id}/customers/{customer_id}/categories/historical

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/historical \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Customer Category History returned successfully	CustomerCategoryHistory
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

Post new customer category

Associates a new category id for a specified customer id

POST /orgs/{org_id}/customers/{customer_id}/categories

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
body	body	PostCustomerCategory	true	‘none’

Request body - instance of PostCustomerCategory

1
2
3
4
5
6


{
  "id": 214748364,
  "value": "influencer",
  "description": "Bill discount",
  "reason": "Masmovil sponsors their videos"
}

Name	Type	Required	Description
id	integer(int32)	true	Category id
value	string¦null	true	Category value.
description	string	false	Description of the category value.
reason	string	false	Reason for the set of value.

Request example

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



curl -X POST https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'id': 214748364,
  'value': 'influencer',
  'description': 'Bill discount',
  'reason': 'Masmovil sponsors their videos'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Categories added 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

400 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.998",
        "title": "Bad request",
        "ref": "http://",
        "message": "Bad request"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

401 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.996",
        "title": "Unauthorized",
        "ref": "http://",
        "message": "Unauthorized"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

403 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.995",
        "title": "Forbidden",
        "ref": "http://",
        "message": "Forbidden"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

404 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.997",
        "title": "Resource not found",
        "ref": "http://",
        "message": "Resource not found"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

409 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.994",
        "title": "Conflict",
        "ref": "http://",
        "message": "The resource already exists"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

500 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.999.999",
        "title": "Unexpected error",
        "ref": "http://",
        "message": "Unexpected error"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

503 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.001.005",
        "title": "Database error",
        "ref": "http://",
        "message": "Connection los"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

504 - instance of ErrorResponse

Custom schema example

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


{
  "errors": [
    {
      "error": {
        "code": "MCUS.001.009",
        "title": "Database error",
        "ref": "http://",
        "message": "Statement timeout"
      }
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error

Get customer categories

Returns all categories for the specified customer id

GET /orgs/{org_id}/customers/{customer_id}/categories

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Categories returned successfully	CustomerCategories
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

Get customer category by id

Returns one category for the specified customer id and category id

GET /orgs/{org_id}/customers/{customer_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
category_id	path	integer(int32)	true	Category id to be returned

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Category returned successfully	CustomerCategory
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

Delete customer category by id

Delete one category for the specified customer id and category id

DELETE /orgs/{org_id}/customers/{customer_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
category_id	path	integer(int32)	true	Category id to be returned

Request example

1
2
3
4
5



curl -X DELETE https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
204	No Content	successful operation	None
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 customer category information by customer and category id

PATCH /orgs/{org_id}/customers/{customer_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
category_id	path	integer(int32)	true	Category id to be returned
body	body	PatchCustomerCategory	true	‘none’

Request body - instance of PatchCustomerCategory

1
2
3
4
5


{
  "value": "influencer",
  "description": "This is an a of category 1",
  "reason": "Riesgo por campañas de fidelizacion: Fidelizacion CP Outbound MM"
}

Name	Type	Required	Description
value	string¦null	false	Category value.
description	string¦null	false	Description of the category value.
reason	string¦null	false	Reason for the set of value.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X PATCH https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'value': 'influencer',
  'description': 'This is an a of category 1',
  'reason': 'Riesgo por campañas de fidelizacion: Fidelizacion CP Outbound MM'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	successful operation	None
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