function _course_enrollment_resource in Course 6

@file course_enrollment_resource.inc Expose course enrollment as as service resource.

1 call to _course_enrollment_resource()

course_services_resources in ./course.module

Implements hook_services_resources().

File

services/course_enrollment_resource.inc, line 7

course_enrollment_resource.inc Expose course enrollment as as service resource.

Code

function _course_enrollment_resource() {
  return array(
    'course_enrollment' => array(
      'retrieve' => array(
        'file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_enrollment_resource',
        ),
        'access callback file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_report_resource',
        ),
        'callback' => '_course_enrollment_retrieve',
        'access callback' => '_course_access_services',
        'access arguments' => array(
          'course_enrollment',
          'retrieve',
        ),
        'access arguments append' => TRUE,
        'args' => array(
          array(
            'name' => 'ccaid',
            'optional' => FALSE,
            'source' => array(
              'path' => 0,
            ),
            'type' => 'int',
            'description' => 'The course credit ID to get.',
          ),
        ),
      ),
      'index' => array(
        'file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_enrollment_resource',
        ),
        'access callback file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_report_resource',
        ),
        'callback' => '_course_enrollment_index',
        'access callback' => '_course_access_services',
        'access arguments' => array(
          'course_enrollment',
          'index',
        ),
        'access arguments append' => TRUE,
        'args' => array(
          array(
            'name' => 'page',
            'optional' => TRUE,
            'type' => 'int',
            'description' => 'The zero-based index of the page to get, defaults to 0.',
            'default value' => 0,
            'source' => array(
              'param' => 'page',
            ),
          ),
          array(
            'name' => 'fields',
            'optional' => TRUE,
            'type' => 'string',
            'description' => 'The fields to get.',
            'default value' => '*',
            'source' => array(
              'param' => 'fields',
            ),
          ),
          array(
            'name' => 'parameters',
            'optional' => TRUE,
            'type' => 'array',
            'description' => 'Parameters array',
            'default value' => array(),
            'source' => array(
              'param' => 'parameters',
            ),
          ),
          array(
            'name' => 'pagesize',
            'optional' => TRUE,
            'type' => 'int',
            'description' => 'Number of records to get per page.',
            'default value' => variable_get('services_course_enrollment_index_page_size', 20),
            'source' => array(
              'param' => 'pagesize',
            ),
          ),
        ),
      ),
      'create' => array(
        'file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_enrollment_resource',
        ),
        'callback' => '_course_enrollment_create',
        'args' => array(
          array(
            'name' => 'enrollment',
            'optional' => FALSE,
            'source' => 'data',
            'description' => 'The enrollment to create',
            'type' => 'array',
          ),
        ),
        'access callback' => '_course_access_services',
        'access callback file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_report_resource',
        ),
        'access arguments' => array(
          'course_enrollment',
          'create',
        ),
        'access arguments append' => TRUE,
      ),
      'delete' => array(
        'file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_enrollment_resource',
        ),
        'callback' => '_course_enrollment_delete',
        'args' => array(
          array(
            'name' => 'eid',
            'optional' => FALSE,
            'type' => 'int',
            'source' => array(
              'path' => 0,
            ),
          ),
        ),
        'access callback' => '_course_access_services',
        'access callback file' => array(
          'type' => 'inc',
          'module' => 'course',
          'name' => 'services/course_report_resource',
        ),
        'access arguments' => array(
          'course_enrollment',
          'delete',
        ),
        'access arguments append' => TRUE,
      ),
    ),
  );
}