Organization profiles REST API

Use this REST API to manage organization profiles.

Available HTTP Methods

GET REST APIs for organization profiles

Table 1. GET REST APIs for organization profiles
HTTP Method URI Pattern Data Format Success Codes Error Codes
GET /resources/chargebackProfiles application/json
200
Returns the list of organization profiles available to the user.
403
This code is returned if the requester does not have access to list organization profiles.
500
This code is returned if the system encountered an internal error while processing the request.
GET /resources/chargebackProfiles/{id} application/json
200
Returns the organization profile with the specified ID.
403
This code is returned if the requester does not have access to the requested organization profile.
404
This code is returned if the requested organization profile is not defined.
500
This code is returned if the system encountered an internal error while processing the request.
Example:
{
	"id" : "133b61dc-7ad0-4c6e-b7c8-5d2bd181060d",
	"updated" : 1452706044569,
	"created" : 1452706044569,
	"description" : "",
	"name" : "OP1",
	"uuid" : "133b61dc-7ad0-4c6e-b7c8-5d2bd181060d"
}
where:
id
A unique identifier for the organization.
updated
The last time the organization was updated, represented as the number of milliseconds since midnight January 1, 1970 Coordinated Universal Time (UTC).
created
The creation time of the organization, represented as the number of milliseconds since midnight January 1, 1970 UTC.
description
An optional description of the organization.
name
The name of the organization.
uuid
A unique identifier for the organization.

POST REST APIs for organization profiles

Table 2. POST REST APIs for organization profiles
HTTP Method URI Pattern Data Format Success Codes Error Codes
POST /resources/chargebackProfiles application/json
201
The organization profile is created.
403
This code is returned if the requester does not have access to create organization profiles.
500
This code is returned if the system encountered an error while processing the request.
Example:
{
	"description" : "description of OP1",
	"name" : "OP1",
}
where:
description
An optional description of the organization.
name
The name of the organization. The name of the organization must be unique within the system.

PUT REST APIs for organization profiles

Table 3. PUT REST APIs for organization profiles
HTTP Method URI Pattern Data Format Success Codes Error Codes
PUT /resources/chargebackProfiles/{id} application/json
200
The organization profile is updated.
403
This code is returned if the requester does not have access to update the organization profile.
500
This code is returned if the system encountered an error while processing the request.
Example:
{
	"description" : "description of OP1",
	"name" : "OP1",
}
where:
description
An optional description of the organization.
name
The name of the organization. The name of the organization must be unique within the system.

DELETE REST APIs for organization profiles

Table 4. DELETE REST APIs for organization profiles
HTTP Method URI Pattern Data Format Success Codes Error Codes
DELETE /resources/chargebackProfiles/{id} N/A
200
The organization profile is deleted.
403
This code is returned if the requester does not have access to delete the organization profile.
500
This code is returned if the system encountered an error while processing the request.