eedm.meal-plan-assignments.v10.1.0.meal-plan-assignments.json Maven / Gradle / Ivy
{
"title" : "Meal Plan Assignments",
"description" : "Assignments of meal plans to a person.",
"version" : "10.1.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the meal plan assignment.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"person" : {
"title" : "Person",
"description" : "The person to whom a meal plan is assigned.",
"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" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"mealPlan" : {
"title" : "Meal Plan",
"description" : "The meal plan assigned to the person.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Meal Plan.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/meal-plans/{id}",
"targetSchema" : {
"$ref" : "meal-plans.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"academicPeriod" : {
"title" : "Academic Period",
"description" : "The academic period for the meal plan assignment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Period.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-periods/{id}",
"targetSchema" : {
"$ref" : "academic-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"startOn" : {
"title" : "Start On",
"description" : "The start date when the meal plan assignments become effective.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"endOn" : {
"title" : "End On",
"description" : "The end date of the meal plan assignment.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"status" : {
"title" : "Status",
"description" : "The status of the meal plan assignment.",
"enum" : [ "assigned", "cancelled", "terminated", "prorated" ],
"type" : "string"
},
"statusDate" : {
"title" : "Status Date",
"description" : "The date when the meal plan assignment status was set or modified.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"assignedRate" : {
"title" : "Assigned Rate",
"description" : "The effective regular rate for the meal plan assignment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Assigned Rate.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/meal-plan-rates/{id}",
"targetSchema" : {
"$ref" : "meal-plan-rates.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"rateOverride" : {
"title" : "Rate Override",
"description" : "The override rate for the meal plan assignment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"rate" : {
"title" : "Rate",
"description" : "The override rate for the meal plan assignment.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"ratePeriod" : {
"title" : "Rate Period",
"description" : "The period for which the rate is set.",
"enum" : [ "day", "week", "term", "meal", "month", "year" ],
"type" : "string"
},
"overrideReason" : {
"title" : "Override Reason",
"description" : "The reason for the rate override.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Override Reason.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/billing-override-reasons/{id}",
"targetSchema" : {
"$ref" : "billing-override-reasons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"accountingCode" : {
"title" : "Accounting Code",
"description" : "The accounting code associated with the override rate.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Accounting Code.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounting-codes/{id}",
"targetSchema" : {
"$ref" : "accounting-codes.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "rate", "ratePeriod" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"numberOfPeriods" : {
"title" : "Number Of Periods",
"description" : "The number of time periods in the meal plan assignment.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"mealCard" : {
"title" : "Meal Card",
"description" : "The meal card associated with the meal plan assignment.",
"type" : "string"
},
"consumption" : {
"title" : "Consumption",
"description" : "The number or percentage of units consumed by the person on the plan.",
"oneOf" : [ {
"title" : "units",
"description" : "The number of units consumed on the plan.",
"type" : "object",
"properties" : {
"units" : {
"title" : "Units",
"description" : "The number of units consumed on the plan.",
"minimum" : 0,
"type" : "number",
"format" : "positiveNumber"
}
},
"additionalProperties" : false,
"required" : [ "units" ]
}, {
"title" : "percent",
"description" : "The percent of units consumed on the meal plan.",
"type" : "object",
"properties" : {
"percent" : {
"title" : "Percent",
"description" : "The percent of units consumed on the meal plan.",
"type" : "number"
}
},
"additionalProperties" : false,
"required" : [ "percent" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"comment" : {
"title" : "Comment",
"description" : "Any comment that may have been generated for the meal plan.",
"type" : "string"
}
},
"required" : [ "id", "person", "mealPlan", "startOn", "status", "statusDate" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"person\": {\"id\": $id}}",
"title" : "Person",
"description" : "The person to whom a meal plan is assigned.",
"schema" : {
"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" : "meal-plan-assignments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"mealPlan\": {\"id\": $id}}",
"title" : "Meal Plan",
"description" : "The meal plan assigned to the person.",
"schema" : {
"type" : "object",
"properties" : {
"mealPlan" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "meal-plan-assignments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"academicPeriod\": {\"id\": $id}}",
"title" : "Academic Period",
"description" : "The academic period for the meal plan assignment.",
"schema" : {
"type" : "object",
"properties" : {
"academicPeriod" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "meal-plan-assignments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"startOn\": $startOn}",
"title" : "Start On",
"description" : "The start date when the meal plan assignments become effective.",
"schema" : {
"type" : "object",
"properties" : {
"startOn" : {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}
}
},
"targetSchema" : {
"$ref" : "meal-plan-assignments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"status\": $status}",
"title" : "Status",
"description" : "The status of the meal plan assignment.",
"schema" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "assigned", "cancelled", "terminated", "prorated" ]
}
}
},
"targetSchema" : {
"$ref" : "meal-plan-assignments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/meal-plan-assignments?criteria={\"endOn\": $endOn}",
"title" : "End On",
"description" : "The end date of the meal plan assignment.",
"schema" : {
"type" : "object",
"properties" : {
"endOn" : {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}
}
},
"targetSchema" : {
"$ref" : "meal-plan-assignments.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy