/federal_account/:federal_account_id/available_object_classes

federal_account_object_class.md

Rollup of Object Classes for Federal Account

Route:/api/v2/federal_accounts/:federal_account_id/available_object_classes

Method: GET

This route sends a request to the backend to retrieve minor object classes rolled up under major classes filtered by federal account.

Required Parameters

• federal_account_id: required - an integer representing the federal account id to filter on

Response (JSON)

HTTP Status Code: 200

{
    "results": [
        {
            "id": "20",
            "name": "Contractual services and supplies",
            "minor_object_class": [
                {
                    "id": "220",
                    "name": "Transportation of things"
                },
            ...]
        },
    ...]
}

Response Attributes Description

• id: Major object class id (Major object class code) Reference for filtering
• name: Major object class name/label
• minor_object_class:id: Minor object class id (Minor object class code). Reference for filtering
• minor_object_class:name: Minor object class name/label

Errors

Possible HTTP Status Codes:

• 400: Missing Parameter
• 500: All other errors

Can we update the sample response so that "results" is wrapped in a JSON object as well? so like { "results": ... }

Can we update the docs to use the correct endpoint: v2/federal_accounts

• Update results Json
• Updated route endpoint

-Updated id fields to string based on Kevin's findings:

 {
            "id": "90",
            "name": "Other",
            "minor_object_class": [
                {
                    "id": "940",
                    "name": "Financial transfers"
                }
            ]
 },
{
            "name": "Other",
            "minor_object_class": [
                {
                    "name": "",
                    "id": 0
                }
            ],
            "id": 0
 }

• 'Other' major object class code should be "00", with a minor object class code: "000", and minor class code name: ""
• 'Other' is the major object class name for multiple major class codes