GET /api/v1/countries
List Sector Mandates

Examples

GET /api/v2/sectors
200
{
  "data": [
    {
      "id": "25",
      "type": "sectors",
      "links": {
        "self": "http://test.host/api/v2/sectors/25"
      },
      "attributes": {
        "slug": "finance",
        "useful-links": [],
        "name": "Finance",
        "total-insights": 0,
        "total-entities": 0
      },
      "relationships": {
        "classification-distribution": {
          "links": {
            "self": "http://test.host/api/v2/sectors/25/relationships/classification-distribution",
            "related": "http://test.host/api/v2/sectors/25/classification-distribution"
          }
        },
        "industry-groups": {
          "links": {
            "self": "http://test.host/api/v2/sectors/25/relationships/industry-groups",
            "related": "http://test.host/api/v2/sectors/25/industry-groups"
          }
        }
      }
    },
    {
      "id": "26",
      "type": "sectors",
      "links": {
        "self": "http://test.host/api/v2/sectors/26"
      },
      "attributes": {
        "slug": "energy",
        "useful-links": [],
        "name": "Energy",
        "total-insights": 0,
        "total-entities": 0
      },
      "relationships": {
        "classification-distribution": {
          "links": {
            "self": "http://test.host/api/v2/sectors/26/relationships/classification-distribution",
            "related": "http://test.host/api/v2/sectors/26/classification-distribution"
          }
        },
        "industry-groups": {
          "links": {
            "self": "http://test.host/api/v2/sectors/26/relationships/industry-groups",
            "related": "http://test.host/api/v2/sectors/26/industry-groups"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 2
  }
}

GET /api/v1/countries/:id
Show a Sector Mandate

Examples

GET /api/v2/sectors/31
200
{
  "data": {
    "id": "31",
    "type": "sectors",
    "links": {
      "self": "http://test.host/api/v2/sectors/31"
    },
    "attributes": {
      "slug": "finance",
      "useful-links": [],
      "name": "Finance",
      "total-insights": 0,
      "total-entities": 0
    },
    "relationships": {
      "classification-distribution": {
        "links": {
          "self": "http://test.host/api/v2/sectors/31/relationships/classification-distribution",
          "related": "http://test.host/api/v2/sectors/31/classification-distribution"
        }
      },
      "industry-groups": {
        "links": {
          "self": "http://test.host/api/v2/sectors/31/relationships/industry-groups",
          "related": "http://test.host/api/v2/sectors/31/industry-groups"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Sector ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/countries
Create a Sector Mandate

Examples

POST /foundry-api/v1/sectors
{
  "data": {
    "type": "sectors",
    "attributes": {
      "slug": null,
      "useful-links": [],
      "name": "Technology",
      "total-insights": "0"
    },
    "relationships": {}
  }
}
401
{
  "errors": [
    {
      "title": "You are not authorized to access this request"
    }
  ]
}

PATCH /api/v2/countries/:id
Update a Sector Mandate

Examples

PATCH /foundry-api/v1/sectors/63
{
  "data": {
    "id": "63",
    "type": "sectors",
    "attributes": {
      "slug": "technology",
      "useful-links": [],
      "name": "IT",
      "total-insights": "0"
    },
    "relationships": {}
  }
}
200
{
  "data": {
    "id": "63",
    "type": "sectors",
    "links": {
      "self": "http://test.host/foundry-api/v1/sectors/63"
    },
    "attributes": {
      "slug": "technology",
      "useful-links": [],
      "name": "IT",
      "total-insights": 0
    },
    "relationships": {
      "classification-distribution": {
        "links": {
          "self": "http://test.host/foundry-api/v1/sectors/63/relationships/classification-distribution",
          "related": "http://test.host/foundry-api/v1/sectors/63/classification-distribution"
        }
      },
      "industry-groups": {
        "links": {
          "self": "http://test.host/foundry-api/v1/sectors/63/relationships/industry-groups",
          "related": "http://test.host/foundry-api/v1/sectors/63/industry-groups"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Sector ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/countries/:id
Delete a Sector Mandate

Examples

DELETE /foundry-api/v1/sectors/53
401
{
  "errors": [
    {
      "title": "You are not authorized to access this request"
    }
  ]
}

Params

Param name Description
id
required

Sector ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.