Organization Details

This route will return all Organizations associated with the authenticated user login. Each organization detail contains the resource URI to users, addresses and organization_roles associated with that organization.

The response contains the following components for each organization:

– organization_uuid: Unique identifier of the specified organization
– orgnization_name: Name of the specified Organization
– organization_description: Description of the specified Organization
– parent_organization: In case the organizations are nested this will identify the parent of specified Organization.
– users: Path to the users of specifed Organization
– addresses: Path to the addresses associated to specified Organization
– job_code_prefix: Jobs associated with this organization will have a job number starting with this job_code_prefix.

Resource URI

GET /organizations

Sample Request

html

https://api.4over.com/organizations

Sample Response

JSON
{
entities: [
  {
        organization_uuid: "5f985c6b-36b5-4fb4-daae-d4e8dcdef61e",
        organization_name: "Test Printers",
        organization_description: "Test Printers",
        parent_organization: {
          organization_uuid: "d6d4e03e-7e88-4f69-9664-2e16da4da2b1",
          organization_name: "API",
          organization_description: "API Subscriber Organizations",
        parent_organization: {
          organization_uuid: "8a17ef16-d997-4544-9f7c-d313febf9c40",
          organization_name: "4over, Inc.",
          organization_description: "4over corporate",
          users: "http://api.4over.com/organizations/8a17ef16-d997-4544-9f7c-d313febf9c40/users",
          job_code_prefix: "Z"
      },
      users: "http://api.4over.com/organizations/d6d4e03e-7e88-4f69-9664-2e16da4da2b1/users",
      job_code_prefix: ""
      },
      users: "http://api.4over.com/organizations/5f985c6b-36b5-4fb4-daae-d4e8dcdef61e/users",
      job_code_prefix: "Z"
    }
  ],
  currentPage: 0,
  maximumPages: 20
}

To get a specific Organization data:

Resource URI

GET /organizations/{organization_uuid}

Input Parameters

@param organization_uuid {uuid} The uuid of an Organization.

Sample Request

html

https://api.4over.com/organizations/45514e13-b131-4c1d-b4eb-b40fbf8a3e69

Sample Response

JSON
{
  {
    organization_uuid: "5f985c6b-36b5-4fb4-daae-d4e8dcdef61e",
    organization_name: "Test Printers",
    organization_description: "My Printer",
    parent_organization: {
      organization_uuid: "d6d4e03e-7e88-4f69-9664-2e16da4da2b1",
      organization_name: "API",
      organization_description: "API Subscriber Organizations",
      parent_organization: {
        organization_uuid: "8a17ef16-d997-4544-9f7c-d313febf9c40",
        organization_name: "4over, Inc.",
        organization_description: "4over corporate",
        users: "http://api.4over.com/organizations/8a17ef16-d997-4544-9f7c-d313febf9c40/users",
        job_code_prefix: "Z"
        },
        users: "http://api.4over.com/organizations/d6d4e03e-7e88-4f69-9664-2e16da4da2b1/users",
        job_code_prefix: ""
      },
      users: "http://api.4over.com/organizations/5f985c6b-36b5-4fb4-daae-d4e8dcdef61e/users",
      job_code_prefix: "Z"
    }
}