# Get enrollment status

This endpoint provides an assessment of the student's enrollment status.  MeasureOne uses a set of heuristics to make a final determination.   These heuristics are summarized in Reason Codes as detailed in the following table.

###  Reason Codes 
  |Code|Description|
  |--- |--- |
  |MES_EXPLICIT_STATUS|Enrollment Status explicitly available on school website|
  |MES_CURRENTLY_ENROLLED|Currently enrolled in a program|
  |MES_COURSE_IN_PRG|One or more courses in progress|
  |MES_COURSE_IN_PRG_DEG_AWD_LT_90|One or more courses in progress but degree awarded before 90 days of the date available in the data|
  |MES_LAST_TERM_LT_180|Last term ended within 180 days of date available in the data|
  |MES_LAST_TERM_LT_180_DEG_AWD_GT_270|Last term ended within 180 days of item creation but degree awarded date is greater than 270 days|
  |MES_COURSE_IN_PRG_DEG_AWD_LT_60|One or more courses in progress, but degree awarded before 60 days of item creation|
  |MES_LAST_TERM_GT_180|Last term ended greater than 180 days of the date available in the data|
  |MES_WITHDRAWN|Withdrawn from all programs|
  |MES_VERIFIED_CREDENTIALS|Successfully verified Individual’s login credentials|
  |MES_INSUFFICIENT_DATA|Insufficient Data|
  |MES_VF_DAC|Verification method: Direct school account connection|
  |MES_VF_USD|Verification method: User-submitted transcript|
  |MES_VF_DAC_USD|Verification method: Direct school account connection and one or more user-submitted transcript|


Endpoint: POST /v3/services/get_enrollment_status
Version: 3.0
Security: Bearer

## Header parameters:

  - `version` (number)
    Version number of the MeasureOne API you wish to integrate.

  - `Authorization` (string)
    Authorization API Key

  - `Content-type` (string)
    Content-type of the request payload. MeasureOne accepts content in application/json format unless specified otherwise

## Response 200 fields (application/json):

  - `individual` (object)

  - `individual.individual_id` (string)
    Unique ID of the Individual identified by MeasureOne

  - `individual.datasources` (array)

  - `datarequest_id` (string)
    Unique ID of the Data Request identified by MeasureOne

  - `processing_status` (string)
    Processing status of the request.  - MeasureOne has finished processing of the request.  - We have received the request and system is acquiring the enrollment status. Note that if MeasureOne system requires any intervention from our team, the status will update to IN_PROGRESS.  - We have received the request and our team is working to process the the enrollment status.
    Enum: "COMPLETED", "ACQUIRING", "IN_PROGRESS"

  - `service_context_id` (string)
    Unique ID of the service context identified by MeasureOne

  - `metadata` (object)
    metadata can be used for storing additional information in a structured format. metadata will be sent in webhooks and report response.

  - `enrollment_status` (array)

  - `enrollment_status.datasource_id` (string)
    Unique ID of the datasource identified by MeasureOne

  - `enrollment_status.enrollment_status` (string)
    Enrollment Status of the individual as presented in the academic profile
    Enum: "ACTIVE", "INACTIVE", "INSUFFICIENT_DATA"

  - `enrollment_status.reason_codes` (array)
    Array of reason codes used for determining the enrollment status. Helps developer understand how has the enrollment status been derived.

  - `enrollment_status.reason_codes.code` (string)
    Reason code applicable

  - `enrollment_status.reason_codes.description` (string)
    Description providing details to understand how has the enrollment status been derived.

  - `enrollment_status.as_of_date` (number)
    Date of status

  - `transaction_id` (string)
    Unique identifier for this transaction.

## Response 400 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 401 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 404 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 405 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds
    Example: 1655227025839

  - `error_code` (string)
    MeasureOne Error code
    Example: "METHOD_NOT_ALLOWED"

  - `error_message` (string)
    Details of the error
    Example: "Given Method not allowed"

## Response 409 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds
    Example: 1655227025839

  - `http_code` (number)
    Error status code
    Example: 409

  - `error_code` (string)
    MeasureOne Error code
    Example: "MULTIPLE_REPORT_INSTANCES"

  - `error_message` (string)
    Details of the error
    Example: "Multiple instances of the report ENROLLMENT_STATUS found in the Data Request. Please provide params/metadata in request"

## Response 422 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

  - `reason_codes` (array)
    List of reason codes. Helps developer understand what error occurred during processing an item.

  - `reason_codes.code` (string)
    Reason code applicable
 |Reason Code|Description|
 |--- |--- |
 |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
 |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
 |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
 |NO_ITEMS| The report could not be generated as there are no items for this Individual.

  - `reason_codes.description` (string)
    Description providing details to understand what error occurred during processing an item.

  - `reason_codes.context` (object)
    Context to understand where the reason code is applicable

  - `reason_codes.context.items` (array)
    List of Items where the reason code is applicable

## Response 500 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error