Retrieve a specific class

GET 
/api/v3/class/:class_id

Allows you to retrieve a specific class based on its class_id.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

class_id integer

Class ID #

name string

Class name

accounting_sku string

Accounting system SKU

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "class_id": 0,
    "name": "string",
    "accounting_sku": "string"
  }
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "class_id": 1,
    "name": "Test -UGG-01",
    "accounting_sku": "UGG-01"
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...