eedm.constituent-involvements.v12.1.0.constituent-involvements.json Maven / Gradle / Ivy
{
"title" : "Constituent Involvements",
"description" : "A constituent's involvement in an activity.",
"version" : "12.1.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "A global identifier of a constituent involvement.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"constituent" : {
"title" : "Constituent",
"description" : "The constituent involved in an activity.",
"oneOf" : [ {
"title" : "Person",
"description" : "A person who is involved in an activity.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "A person or other independent agent.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-persons/{id}",
"targetSchema" : {
"$ref" : "constituent-persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "person" ]
}, {
"title" : "Organization",
"description" : "An organization that is involved in an activity.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "An organized community or other social, commercial, or political structure for the purposes of education. The group shares a common purpose beyond its membership, and can act as an agent. Organizations can decompose into hierarchical structures. In the higher education context, it represents an institution, school, college, center, division, or any other organizational unit that can act as an agent.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Organization.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-organizations/{id}",
"targetSchema" : {
"$ref" : "constituent-organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "organization" ]
} ]
},
"activity" : {
"title" : "Activity",
"description" : "The activity in which a constituent is involved.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Activity.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-activities/{id}",
"targetSchema" : {
"$ref" : "constituent-activities.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"participationType" : {
"title" : "Participation Type",
"description" : "The type of participation the constituent had in the activity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Participation Type.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-participation-types/{id}",
"targetSchema" : {
"$ref" : "constituent-participation-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"startOn" : {
"title" : "Start Date",
"description" : "The date when a constituent's involvement in an activity starts.",
"type" : "object",
"properties" : {
"year" : {
"title" : "Year",
"description" : "The year portion of the date.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"month" : {
"title" : "Month",
"description" : "The month portion of the date",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"day" : {
"title" : "Day",
"description" : "The day portion of a date.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"endOn" : {
"title" : "End Date",
"description" : "The date when a constituent's involvement in an activity ends.",
"type" : "object",
"properties" : {
"year" : {
"title" : "Year",
"description" : "The year portion of the date.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"month" : {
"title" : "Month",
"description" : "The month portion of the date.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"day" : {
"title" : "Day",
"description" : "The day portion of the date.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"status" : {
"title" : "Status",
"description" : "The status of the constituent's involvement in the activity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Status.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-statuses/{id}",
"targetSchema" : {
"$ref" : "advancement-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"source" : {
"title" : "Source",
"description" : "The source of the constituent activity information.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Source.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-sources/{id}",
"targetSchema" : {
"$ref" : "advancement-sources.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"classYear" : {
"title" : "Class Year",
"description" : "A class year associated with the constituent's involvement in the activity.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"responsiblePerson" : {
"title" : "Responsible Person",
"description" : "The person who oversees the constituent's involvement with the activity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Responsible Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-persons/{id}",
"targetSchema" : {
"$ref" : "constituent-persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"comment" : {
"title" : "Comment",
"description" : "A comment on the constituent's involvement in the activity.",
"type" : "string"
}
},
"required" : [ "id", "constituent", "activity" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"constituent\":{\"person\": {\"id\": $id}}}",
"title" : "Constituent Person",
"description" : "A person or other independent agent.",
"schema" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"person" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"constituent\":{\"organization\": {\"id\": $id}}}",
"title" : "Constituent Organization",
"description" : "An organized community or other social, commercial, or political structure for the purposes of education. The group shares a common purpose beyond its membership, and can act as an agent. Organizations can decompose into hierarchical structures. In the higher education context, it represents an institution, school, college, center, division, or any other organizational unit that can act as an agent.",
"schema" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"organization" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"activity\": {\"id\": $id}}",
"title" : "Activity",
"description" : "The activity in which a constituent is involved.",
"schema" : {
"type" : "object",
"properties" : {
"activity" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"startOn\":{\"year\":$year,\"month\":$month}}",
"title" : "Start On Year and Month",
"description" : "Filter based on year and month in startOn",
"schema" : {
"type" : "object",
"properties" : {
"startOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
},
"month" : {
"type" : "number"
}
},
"required" : [ "year", "month" ]
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"startOn\":{\"year\":$year,\"month\":$month,\"day\":$day}}",
"title" : "Start On Year, Month, and Day",
"description" : "Filter based on year, month, and day in startOn",
"schema" : {
"type" : "object",
"properties" : {
"startOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
},
"month" : {
"type" : "number"
},
"day" : {
"type" : "number"
}
},
"required" : [ "year", "month", "day" ]
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"startOn\":{\"year\":year}}",
"title" : "Start On Year",
"description" : "The year portion of the date.",
"schema" : {
"type" : "object",
"properties" : {
"startOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"endOn\":{\"year\":$year,\"month\":$month}}",
"title" : "End On Year and Month",
"description" : "Filter based on year and month in endOn",
"schema" : {
"type" : "object",
"properties" : {
"endOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
},
"month" : {
"type" : "number"
}
},
"required" : [ "year", "month" ]
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"endOn\":{\"year\":$year,\"month\":$month,\"day\":$day}}",
"title" : "End On Year, Month, and Day",
"description" : "Filter based on year, month, and day in endOn",
"schema" : {
"type" : "object",
"properties" : {
"endOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
},
"month" : {
"type" : "number"
},
"day" : {
"type" : "number"
}
},
"required" : [ "year", "month", "day" ]
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-involvements?criteria={\"endOn\":{\"year\":year}}",
"title" : "End On Year",
"description" : "The year portion of the date.",
"schema" : {
"type" : "object",
"properties" : {
"endOn" : {
"type" : "object",
"properties" : {
"year" : {
"type" : "number"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-involvements.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy