{
    "description": "An applicant applies to one or more **programs** through **designations**.  **Programs** render a **decision** for the **designation**.",
    "links": [
        {
            "description": "Display the designation for the applicant with the given applicant CAS ID and program ID.",
            "href": "/api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/designation",
            "http_header": {
                "x-api-key": "0123456789abcdef0123456789abcdef"
            },
            "method": "GET",
            "rel": "self",
            "title": "Show"
        },
        {
            "description": "Update the designation with the given applicant CASID and program ID. **WARNING:** You'll get this error when you're trying to set a decision_id to a designation that already has a local status assigned. If you want to be able to force the decision_id please contact Liaison to turn on the \"Disassociate Decision Codes from Local Status\" feature which will allow you to set the decision even if the local_status is present.",
            "href": "/api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/designation",
            "http_header": {
                "x-api-key": "0123456789abcdef0123456789abcdef"
            },
            "method": "PATCH",
            "rel": "update",
            "schema": {
                "properties": {
                    "designation": {
                        "properties": {
                            "decision_id": {
                                "description": "The unique identifier for the decision to set. If the designation is in received status and the preliminary_data_handling feature is on, the code will prevent changes to the decision code.",
                                "example": 43,
                                "type": [
                                    "integer",
                                    "null"
                                ]
                            }
                        },
                        "type": "object"
                    }
                },
                "type": "object"
            },
            "targetSchema": {
                "properties": {
                    "decision": {
                        "properties": {
                            "id": {
                                "example": 43,
                                "type": "integer"
                            },
                            "name": {
                                "example": "Matriculated",
                                "type": "string"
                            }
                        },
                        "type": [
                            "object",
                            "null"
                        ]
                    },
                    "decisions_href": {
                        "description": "Hypertext reference for valid decisions.",
                        "example": "/api/v1/user_identities/1/decisions",
                        "pattern": "/api/v1/user_identities/\\d+/decisions",
                        "type": "string"
                    },
                    "href": {
                        "description": "Hypertext reference to this resource.",
                        "example": "/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/4/designation",
                        "pattern": "/api/v1/user_identities/\\d+/programs/\\d+/applicants_by_cas_id/\\d+/designation",
                        "type": "string"
                    },
                    "local_status": {
                        "type": "null"
                    }
                }
            },
            "title": "Update"
        }
    ],
    "properties": {
        "designation": {
            "properties": {
                "decision": {
                    "properties": {
                        "id": {
                            "description": "Unique identifier of this decision.",
                            "example": 42,
                            "type": "integer"
                        },
                        "name": {
                            "description": "Human-readable name for this decision.",
                            "example": "Offer Accepted",
                            "type": "string"
                        }
                    },
                    "type": [
                        "object",
                        "null"
                    ]
                },
                "decisions_href": {
                    "description": "Hypertext reference for valid decisions.",
                    "example": "/api/v1/user_identities/1/decisions",
                    "pattern": "/api/v1/user_identities/\\d+/decisions",
                    "type": "string"
                },
                "href": {
                    "description": "Hypertext reference to this resource.",
                    "example": "/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/3/designation",
                    "pattern": "/api/v1/user_identities/\\d+/programs/\\d+/applicants_by_cas_id/\\d+/designation",
                    "type": "string"
                },
                "local_status": {
                    "description": "For programs using WebAdMIT to manage their admissions process, a local status is a way for those programs to enter their workflow into WebAdMIT.  Typically, these programs will tie a decision to a local status.  Decisions are used for reporting at a national level (or school-wide level for UniCAS), but local statuses are for an individual program's process.",
                    "properties": {
                        "id": {
                            "description": "Unique identifier of this local status.",
                            "example": 123456,
                            "type": "integer"
                        },
                        "title": {
                            "description": "Human-readable title for this local status.",
                            "example": "Deposit Made",
                            "type": "string"
                        }
                    },
                    "type": [
                        "object",
                        "null"
                    ]
                }
            },
            "type": "object"
        }
    },
    "title": "Designation",
    "type": "object"
}