CampusAPI Financials Services API documentation version 0.1.5
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAccountType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAccountType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAccountType%40campusapi.org

• code: (string)

  query string to match code.

  Example:

  S9374

• businessId: (string)

  The id string to match a business

  Example:

  financials.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular account type to create

  Example:

  type.Type%3AexampleAccountType%40dxtera.org

• recordType: (array of )

  specify support for one or more account record types

  Example:

  [
    "type.Type%3AexampleAccountRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this account

  Example:

  financials.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Account",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this account, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this account, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this account for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this account.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "creditBalance": {
      "description": "Tests if this account is a credit or debit account.",
      "type": "boolean"
    },
    "code": {
      "description": "A code for this G/L account.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Account",
  "description": "The description of this Account",
  "creditBalance": true,
  "code": "This is the string for Code"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AccountQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchCreditBalance": {
      "description": "Match boolean value for creditBalance.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchCode": {
      "description": "List of Code strings to match. Boolean OR performed among multiple codes.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "codes": {
            "description": "codes to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCode": {
      "description": "Match codes with any value. true to match Accounts with any code, false to match ProgramOfferings with no code",
      "type": "boolean"

    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular account type to create

  Example:

  type.Type%3AexampleAccountType%40dxtera.org

• recordType: (array of )

  specify support for one or more account record types

  Example:

  [
    "type.Type%3AexampleAccountRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this account

  Example:

  financials.Business%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "financials.Account:4240@base.url",
    "uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4240%40base.url",
    "displayName": "Display Name of this Account",
    "description": "The description of this Account",
    "genusTypeId": "type.Type:defaultAccountType@base.url",
    "recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
    "creditBalance": true,
    "code": "This is the string for Code"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Account",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this account, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this account, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this account for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this account.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "creditBalance": {
      "description": "Tests if this account is a credit or debit account.",
      "type": "boolean"
    },
    "code": {
      "description": "A code for this G/L account.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Account",
  "description": "The description of this Account",
  "creditBalance": true,
  "code": "This is the string for Code"
}

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)

URI Parameters

• accountId: required(string)
• childId: required(string)

URI Parameters

• accountId: required(string)
• childId: required(string)

URI Parameters

• accountId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "organization", "supervisor", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleActivityType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleActivityType%40campusapi.org

• fromDate: (string)

  Get all activities from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all activities up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• businessId: (string)

  The id string to match a business

  Example:

  financials.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular activity type to create

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• recordType: (array of )

  specify support for one or more activity record types

  Example:

  [
    "type.Type%3AexampleActivityRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this activity

  Example:

  financials.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Activity",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this activity, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "organizationId": {
      "description": "The organization associated with this activity.",
      "type": "string",
      "format": "osid-id"
    },
    "supervisorId": {
      "description": "The resource supervising this activity account.",
      "type": "string",
      "format": "osid-id"
    },
    "code": {
      "description": "The code for this activity account.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Activity",
  "description": "The description of this Activity",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "organizationId": "resource.Resource:2714@base.url",
  "supervisorId": "resource.Resource:9489@base.url",
  "code": "This is the string for Code"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "organization", "supervisor", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchOrganizationIds": {
      "description": "List of Resource Ids for this query to match organization.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "organizationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "organizationQueries": {
      "description": "resource.ResourceQueries to match the Organization. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyOrganization": {
      "description": "Match organization with any value. true to match Activities with any organization, false to match Activities with no organization",
      "type": "boolean"
    },
    "matchSupervisorIds": {
      "description": "List of Resource Ids for this query to match supervisor.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "supervisorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "supervisorQueries": {
      "description": "resource.ResourceQueries to match the Supervisor. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnySupervisor": {
      "description": "Match supervisor with any value. true to match Activities with any supervisor, false to match Activities with no supervisor",
      "type": "boolean"
    },
    "matchCode": {
      "description": "List of Code strings to match. Boolean OR performed among multiple codes.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "codes": {
            "description": "codes to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCode": {
      "description": "Match codes with any value. true to match Activities with any code, false to match ProgramOfferings with no code",
      "type": "boolean"

    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular activity type to create

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• recordType: (array of )

  specify support for one or more activity record types

  Example:

  [
    "type.Type%3AexampleActivityRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this activity

  Example:

  financials.Business%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "financials.Activity:6597@base.url",
    "uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A6597%40base.url",
    "displayName": "Display Name of this Activity",
    "description": "The description of this Activity",
    "genusTypeId": "type.Type:defaultActivityType@base.url",
    "recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "organizationId": "resource.Resource:5187@base.url",
    "supervisorId": "resource.Resource:7075@base.url",
    "code": "This is the string for Code"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Activity",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this activity, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "organizationId": {
      "description": "The organization associated with this activity.",
      "type": "string",
      "format": "osid-id"
    },
    "supervisorId": {
      "description": "The resource supervising this activity account.",
      "type": "string",
      "format": "osid-id"
    },
    "code": {
      "description": "The code for this activity account.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Activity",
  "description": "The description of this Activity",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "organizationId": "resource.Resource:2714@base.url",
  "supervisorId": "resource.Resource:9489@base.url",
  "code": "This is the string for Code"
}

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)
• childId: required(string)

URI Parameters

• activityId: required(string)
• childId: required(string)

URI Parameters

• activityId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleFiscalPeriodType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleFiscalPeriodType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleFiscalPeriodType%40campusapi.org

• fiscalPeriodDate: (string)

  query string to match date-time within fiscalPeriod date range.

  Example:

  2020-10-03

• businessId: (string)

  The id string to match a business

  Example:

  financials.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular fiscalPeriod type to create

  Example:

  type.Type%3AexampleFiscalPeriodType%40dxtera.org

• recordType: (array of )

  specify support for one or more fiscalPeriod record types

  Example:

  [
    "type.Type%3AexampleFiscalPeriodRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this fiscalPeriod

  Example:

  financials.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FiscalPeriod",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this fiscal period, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this fiscal period, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this fiscal period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this fiscal period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "displayLabel": {
      "description": "A display label for this fiscal period which may be less formal than the display name.",
      "type": "string"
    },
    "fiscalYear": {
      "description": "Ges the fiscal year.",
      "type": "integer"
    },
    "startDate": {
      "description": "Get sthe start date of this period.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "Get sthe end date of this period.",
      "type": "string",
      "format": "date-time"
    },
    "budgetDeadline": {
      "description": "The budget deadline.",
      "type": "string",
      "format": "date-time"
    },
    "postingDeadline": {
      "description": "The last date transactions can be posted for this period.",
      "type": "string",
      "format": "date-time"
    },
    "closing": {
      "description": "The date of the closing for this period.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this FiscalPeriod",
  "description": "The description of this FiscalPeriod",
  "displayLabel": "This is the DisplayLabel",
  "fiscalYear": 19,
  "startDate": "2020-10-03T08:00:00.000Z",
  "endDate": "2020-12-18T17:00:00.000Z",
  "budgetDeadline": "2021-07-21T23:15:30.000Z",
  "postingDeadline": "2021-07-21T23:15:30.000Z",
  "closing": "2021-07-21T23:15:30.000Z"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FiscalPeriodQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayLabel": {
      "description": "List of DisplayLabel strings to match. Boolean OR performed among multiple displayLabels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayLabels": {
            "description": "displayLabels to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDisplayLabel": {
      "description": "Match displayLabels with any value. true to match FiscalPeriods with any display label, false to match ProgramOfferings with no display label",
      "type": "boolean"

    },
    "matchFiscalYear": {
      "description": "Match FiscalPeriods with fiscalYears between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFiscalYear": {
      "description": "Match fiscalYears with any value. true to match FiscalPeriods with any fiscal year, false to match ProgramOfferings with no fiscal year",
      "type": "boolean"

    },
    "matchStartDate": {
      "description": "Matches startDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyStartDate": {
      "description": "Match startDates with any value. true to match FiscalPeriods with any start date, false to match ProgramOfferings with no start date",
      "type": "boolean"

    },
    "matchEndDate": {
      "description": "Matches endDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyEndDate": {
      "description": "Match endDates with any value. true to match FiscalPeriods with any end date, false to match ProgramOfferings with no end date",
      "type": "boolean"

    },
    "matchBudgetDeadline": {
      "description": "Matches budgetDeadlines between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyBudgetDeadline": {
      "description": "Match budgetDeadlines with any value. true to match FiscalPeriods with any budget deadline, false to match ProgramOfferings with no budget deadline",
      "type": "boolean"

    },
    "matchPostingDeadline": {
      "description": "Matches postingDeadlines between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPostingDeadline": {
      "description": "Match postingDeadlines with any value. true to match FiscalPeriods with any posting deadline, false to match ProgramOfferings with no posting deadline",
      "type": "boolean"

    },
    "matchClosing": {
      "description": "Matches closings between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyClosing": {
      "description": "Match closings with any value. true to match FiscalPeriods with any closing, false to match ProgramOfferings with no closing",
      "type": "boolean"

    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular fiscalPeriod type to create

  Example:

  type.Type%3AexampleFiscalPeriodType%40dxtera.org

• recordType: (array of )

  specify support for one or more fiscalPeriod record types

  Example:

  [
    "type.Type%3AexampleFiscalPeriodRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this fiscalPeriod

  Example:

  financials.Business%3A8374%40base.url

URI Parameters

• fiscalPeriodId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• fiscalPeriodId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FiscalPeriod",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this fiscal period, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this fiscal period, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this fiscal period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this fiscal period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "displayLabel": {
      "description": "A display label for this fiscal period which may be less formal than the display name.",
      "type": "string"
    },
    "fiscalYear": {
      "description": "Ges the fiscal year.",
      "type": "integer"
    },
    "startDate": {
      "description": "Get sthe start date of this period.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "Get sthe end date of this period.",
      "type": "string",
      "format": "date-time"
    },
    "budgetDeadline": {
      "description": "The budget deadline.",
      "type": "string",
      "format": "date-time"
    },
    "postingDeadline": {
      "description": "The last date transactions can be posted for this period.",
      "type": "string",
      "format": "date-time"
    },
    "closing": {
      "description": "The date of the closing for this period.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this FiscalPeriod",
  "description": "The description of this FiscalPeriod",
  "displayLabel": "This is the DisplayLabel",
  "fiscalYear": 19,
  "startDate": "2020-10-03T08:00:00.000Z",
  "endDate": "2020-12-18T17:00:00.000Z",
  "budgetDeadline": "2021-07-21T23:15:30.000Z",
  "postingDeadline": "2021-07-21T23:15:30.000Z",
  "closing": "2021-07-21T23:15:30.000Z"
}

URI Parameters

• fiscalPeriodId: required(string)

URI Parameters

• fiscalPeriodId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleBusinessType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleBusinessType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleBusinessType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• accountId: (string)

  Get businesses mapped to this account.

  Example:

  financials.Account%3A560%40demo.dxtera.org

• activityId: (string)

  Get businesses mapped to this activity.

  Example:

  financials.Activity%3A640%40demo.dxtera.org

• fiscalPeriodId: (string)

  Get businesses mapped to this fiscal-period.

  Example:

  financials.FiscalPeriod%3A1040%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular business type to create

  Example:

  type.Type%3AexampleBusinessType%40dxtera.org

• recordType: (array of )

  specify support for one or more business record types

  Example:

  [
    "type.Type%3AexampleBusinessRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Business",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this business, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this business.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this business. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Business",
  "description": "The description of this Business",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Business@base.url",
  "license": "The license that applies to this Business"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BusinessQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Business with any provider, false to match Business with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Business with any branding, false to match Business with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Business",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this business, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this business",
      "linked": false
    },
    "description": {
      "description": "The description of this business.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this business",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this business",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this business. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Business.Business:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this business",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this business",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "financials.Business:2663@base.url",
    "uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2663%40base.url",
    "displayName": "Display Name of this Business",
    "description": "The description of this Business",
    "genusTypeId": "type.Type:defaultBusinessType@base.url",
    "recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Business@base.url",
    "license": "The license that applies to this Business"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Business",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this business, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this business.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this business. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Business",
  "description": "The description of this Business",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Business@base.url",
  "license": "The license that applies to this Business"
}

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)
• childId: required(string)

URI Parameters

• businessId: required(string)
• childId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAccountType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAccountType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAccountType%40campusapi.org

URI Parameters

• businessId: required(string)
• accountId: required(string)

URI Parameters

• businessId: required(string)
• accountId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "organization", "supervisor", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleActivityType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleActivityType%40campusapi.org

URI Parameters

• businessId: required(string)
• activityId: required(string)

URI Parameters

• businessId: required(string)
• activityId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleFiscalPeriodType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleFiscalPeriodType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleFiscalPeriodType%40campusapi.org

URI Parameters

• businessId: required(string)
• fiscalPeriodId: required(string)

URI Parameters

• businessId: required(string)
• fiscalPeriodId: required(string)