NAV
shell ruby python csharp php

CustomInfoField

The CustomInfoField object

See example response for details.

index (admissions)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 14,
            "name": "Favorite ice cream flavor",
            "input_type": "text_area",
            "type": "admissions",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the admissions type.

HTTP Request

GET /admissionscustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (campus life)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 19,
            "name": "Preferred sports team",
            "input_type": "text_area",
            "type": "campus_life",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the campus life type.

HTTP Request

GET /campuslifecustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (donation)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 17,
            "name": "Proxy gift description",
            "input_type": "text_area",
            "type": "donation",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the donation type.

HTTP Request

GET /donationcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (donor)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 20,
            "name": "VIP",
            "input_type": "text_area",
            "type": "donor",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the donor type.

HTTP Request

GET /donorcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (financial aid)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 15,
            "name": "Favorite kind of loan",
            "input_type": "text_area",
            "type": "financial_aid",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the financial aid type.

HTTP Request

GET /financialaidcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (financial)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 16,
            "name": "Favorite coin",
            "input_type": "text_area",
            "type": "financial",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the financial type.

HTTP Request

GET /financialcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (organization)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 18,
            "name": "Business membership number",
            "input_type": "text_area",
            "type": "organization",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the organization type.

HTTP Request

GET /organizationcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (person)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 11,
    "results": 11,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 10,
            "name": "Another decimal?",
            "input_type": "decimal",
            "type": "person",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the person type.

HTTP Request

GET /personcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (student)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 12,
            "name": "Favorite school subject",
            "input_type": "text_area",
            "type": "student",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the student type.

HTTP Request

GET /studentcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

index (term student)

Example code to call this method:

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "custom_info_field",
            "id": 13,
            "name": "Favorite color",
            "input_type": "text_area",
            "type": "term_student",
            "description": null,
            "value_permissions": "default"
        }
    ],
    "sandbox": true
}

Retrieves all CustomInfoField objects, of the term student type.

HTTP Request

GET /termstudentcustominfofields

Parameters

None

Permissions

One of the following roles is required to call this method:

show (admissions)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 14,
    "name": "Favorite ice cream flavor",
    "input_type": "text_area",
    "type": "admissions",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the admissions type.

HTTP Request

GET /admissionscustominfofields/(admissionscustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (campus life)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 19,
    "name": "Preferred sports team",
    "input_type": "text_area",
    "type": "campus_life",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the campus life type.

HTTP Request

GET /campuslifecustominfofields/(campuslifecustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (donation)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 17,
    "name": "Proxy gift description",
    "input_type": "text_area",
    "type": "donation",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the donation type.

HTTP Request

GET /donationcustominfofields/(donationcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (donor)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 20,
    "name": "VIP",
    "input_type": "text_area",
    "type": "donor",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the donor type.

HTTP Request

GET /donorcustominfofields/(donorcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (financial aid)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 15,
    "name": "Favorite kind of loan",
    "input_type": "text_area",
    "type": "financial_aid",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the financial aid type.

HTTP Request

GET /financialaidcustominfofields/(financialaidcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (financial)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 16,
    "name": "Favorite coin",
    "input_type": "text_area",
    "type": "financial",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the financial type.

HTTP Request

GET /financialcustominfofields/(financialcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (organization)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 18,
    "name": "Business membership number",
    "input_type": "text_area",
    "type": "organization",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the organization type.

HTTP Request

GET /organizationcustominfofields/(organizationcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (person)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 10,
    "name": "Another decimal?",
    "input_type": "decimal",
    "type": "person",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the person type.

HTTP Request

GET /personcustominfofields/(personcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (student)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 12,
    "name": "Favorite school subject",
    "input_type": "text_area",
    "type": "student",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the student type.

HTTP Request

GET /studentcustominfofields/(studentcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

show (term student)

Example code to call this method:

Example response:

{
    "object": "custom_info_field",
    "id": 13,
    "name": "Favorite color",
    "input_type": "text_area",
    "type": "term_student",
    "description": null,
    "value_permissions": "default",
    "sandbox": true
}

Retrieves a specific CustomInfoField object, of the term student type.

HTTP Request

GET /termstudentcustominfofields/(termstudentcustominfofield)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

shell ruby python csharp php