Listing all Citations tied to an Authority Document

The /authority-document/{id}/details endpoint returns all of the basic information about an Authority Document, plus all of it's associated Citations:

curl -X GET --header "Accept: application/vnd.ucf.v1+json" --header "Authorization: Bearer <YOUR TOKEN HERE>" "https://api.unifiedcompliance.com/authority-document/517/details"

/authority-document/517/details response

 

{
    "availability": "Free",
    "check_digit": 9,
    "citation_format": "\u00b6 (Numbered Paragraphs)",
    "citations": [
        {
            "asset": null,
            "audit_item": null,
            "authority_document": {
                "id": 517
            },
            "check_digit": 5,
            "compliance_document": null,
            "configurable_item_with_settings": null,
            "control": {
                "_href": "https://api.unifiedcompliance.com/control/597/details",
                "check_digit": 4,
                "classification": "IT Impact Zone",
                "date_added": "2005-12-28",
                "date_modified": "2014-08-25",
                "deprecated_by": null,
                "deprecation_notes": null,
                "genealogy": "00000",
                "id": 597,
                "impact_zone": "Leadership and high level objectives",
                "language": "eng",
                "license_info": "http://www.unifiedcompliance.com/licenses/index.html",
                "live": true,
                "metric_calculation": null,
                "metric_image_reference": null,
                "metric_information_source": null,
                "metric_name": null,
                "metric_presentation_format": null,
                "metric_target_result": null,
                "name": "Leadership and high level objectives",
                "parent": {
                    "_href": "https://api.unifiedcompliance.com/control/0/details",
                    "id": 0
                },
                "sentence": null,
                "sort_id": "000 001",
                "sort_value": 1,
                "time_created": "2005-12-28T00:00:00+0000",
                "time_updated": "2014-08-25T00:00:00+0000",
                "type": "IT Impact Zone"
            },
            ......
    ],
    "common_name": "South African King Report 2002",
    "date_added": "2009-03-16",
    "date_modified": "2015-02-23",
    "deprecated_by": null,
    "deprecation_notes": null,
    "description": "Institute of Directors in Southern Africa. The King Committee on Corporate Governance, Executive Summary of the King Report 2002, March 2002, Issued by European Corporate Governance Institute (ecgi).\n\nThis is document has a type of \"Regulation or Statute\" and is mapped as UCF AD ID 0000517 as a part of the Africa category.\nThis document's availability is \"Free\".\nIt was originally found online at: http://www.ecgi.org/codes/documents/executive_summary.pdf\n\nThis Authority Document has 32 citations mapped to 32 UCF Common Controls.\nThe document as a whole was last reviewed and released on 2008-10-08.",
    "effective_date": "2002-03-01",
    "genealogy": "0000000 0002352 0001626 0000722",
    "id": 517,
    "issuer": {
        "category": "Asia and Pacific Rim Guidance; Other European and African Guidance",
        "check_digit": 0,
        "date_added": "2013-01-07",
        "date_modified": "2013-05-23",
        "deprecated_by": null,
        "deprecation_notes": null,
        "document_type": "Regulation or Statute",
        "id": 287,
        "issuer_top_level": {
            "id": 75
        },
        "language": "eng",
        "live": true,
        "name": "European Corporate Governance Institute (ecgi)",
        "sub_directory": null,
        "time_created": "2013-01-07T00:00:00+0000",
        "time_updated": "2013-05-23T00:00:00+0000",
        "url": "http://www.ecgi.org/"
    },
    "language": "eng",
    "live": true,
    "official_name": "The King Committee on Corporate Governance, Executive Summary of the King Report 2002, March 2002",
    "originator": "Institute of Directors in Southern Africa",
    "parent": {
        "id": 722
    },
    "parent_category": "Africa",
    "published_name": "The King Committee on Corporate Governance, Executive Summary of the King Report 2002",
    "published_version": "March 2002",
    "release_date": "2008-10-08",
    "request_id": null,
    "sort_id": "000 001 044 001 002",
    "sort_value": 2,
    "status": "Released",
    "subject_matter": null,
    "tab_category": null,
    "term": null,
    "time_created": "2009-03-16T00:00:00+0000",
    "time_updated": "2015-02-23T00:00:00+0000",
    "title_type": "AD",
    "type": "Regulation or Statute",
    "will_supercede_id": null
}

If you just want the Citations tied to an Authority Document, use the /authority-document/{id}/citations endpoint:

curl -X GET --header "Accept: application/vnd.ucf.v1+json" --header "Authorization: Bearer <YOUR TOKEN HERE>" "https://api.unifiedcompliance.com/authority-document/517/citations"

/authority-document/517/citations response

 

[
    {
        "asset": null,
        "audit_item": null,
        "authority_document": {
            "id": 517
        },
        "check_digit": 5,
        "children": {
        },
        "compliance_document": null,
        "configurable_item_with_settings": null,
        "control": {
            "id": 597
        },
        "data_content": null,
        "date_added": "2009-07-29",
        "date_modified": "2016-06-14",
        "deprecated_by": null,
        "deprecation_notes": null,
        "genealogy": "0016296",
        "guidance": "Generally recognized frameworks of risk management and internal controls should be used by the Board of Directors to provide assurance that the organizational objectives are being met for safeguarding the organization's assets, complying with laws and regulations, operating effectively and efficiently, reporting reliably, and supporting business operations in normal and adverse conditions.",
        "guidance_as_tagged": null,
        "id": 16296,
        "language": "eng",
        "live": true,
        "metric": null,
        "monitored_event": null,
        "organizational_function": null,
        "organizational_task": null,
        "parent": null,
        "record_category": null,
        "record_example": null,
        "reference": "\u00b6 3.1.4",
        "role": null,
        "sentence": null,
        "sort_id": "000",
        "sort_value": null,
        "time_created": "2009-07-29T00:00:00+0000",
        "time_updated": "2016-06-14T00:00:00+0000"
    },
]
Have more questions? Submit a request

Comments

Powered by Zendesk