Skip to content
Snippets Groups Projects
Commit 9675dde8 authored by Jared Balkman's avatar Jared Balkman
Browse files

Update docs/tutorials/wiscalerts/rave-json.json

parent ca0bbece
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/tutorials/wiscalerts/rave-json.json
+ 780
− 318
View file @ 9675dde8
{ {
"$schema": "https://json-schema.org/draft-04/schema#", "schema": {
"definitions": { "element": [
"serviceError": { {
"type": "object", "_name": "ServiceError",
"required": ["errorMessage"], "_type": "serviceError",
"properties": { "__prefix": "xs"
"errorMessage": {"type": "string"} },
{
"_name": "listMembers",
"_type": "listMembers",
"__prefix": "xs"
},
{
"_name": "listMemberships",
"_type": "listMemberships",
"__prefix": "xs"
},
{
"_name": "mobileCarrier",
"_type": "mobileCarrier",
"__prefix": "xs"
},
{
"_name": "mobileCarriers",
"_type": "mobileCarriers",
"__prefix": "xs"
},
{
"_name": "raveGroup",
"_type": "raveGroup",
"__prefix": "xs"
},
{
"_name": "raveGroupMembership",
"_type": "raveGroupMembership",
"__prefix": "xs"
},
{
"_name": "raveGroupMemberships",
"_type": "raveGroupMemberships",
"__prefix": "xs"
},
{
"_name": "raveGroups",
"_type": "raveGroups",
"__prefix": "xs"
},
{
"_name": "raveUser",
"_type": "raveUser",
"__prefix": "xs"
},
{
"_name": "rejectedListMembers",
"_type": "rejectedListMembers",
"__prefix": "xs"
},
{
"_name": "userList",
"_type": "userList",
"__prefix": "xs"
},
{
"_name": "userLists",
"_type": "userLists",
"__prefix": "xs"
} }
}, ],
"mobileCarrier": { "complexType": [
"type": "object", {
"required": [ "sequence": {
"name", "element": {
"id" "_name": "listMember",
], "_type": "xs:string",
"properties": { "_nillable": "true",
"name": {"type": "string"}, "_minOccurs": "0",
"id": {"type": "integer"} "_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "listMembers",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "userList",
"_type": "userList",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "listMemberships",
"__prefix": "xs"
},
{
"sequence": {
"element": [
{
"_name": "name",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "memberList",
"_type": "listMembers",
"_minOccurs": "0",
"__prefix": "xs"
}
],
"__prefix": "xs"
},
"attribute": [
{
"_name": "id",
"_type": "xs:int",
"__prefix": "xs"
},
{
"_name": "userListDetailsURL",
"_type": "xs:string",
"__prefix": "xs"
}
],
"_name": "userList",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "name",
"_type": "xs:string",
"__prefix": "xs"
},
"__prefix": "xs"
},
"attribute": {
"_name": "id",
"_type": "xs:int",
"_use": "required",
"__prefix": "xs"
},
"_name": "mobileCarrier",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "mobileCarrier",
"_type": "mobileCarrier",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "mobileCarriers",
"__prefix": "xs"
},
{
"sequence": {
"element": [
{
"_name": "name",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "description",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "keyword",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "alertPhoneDefault",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "alertEmailDefault",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "officialCircle",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "isPublic",
"_type": "xs:boolean",
"_default": "true",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "anyoneCanPost",
"_type": "xs:boolean",
"_default": "true",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "numSubscriptions",
"_type": "xs:int",
"_minOccurs": "0",
"__prefix": "xs"
}
],
"__prefix": "xs"
},
"attribute": {
"_name": "id",
"_type": "xs:int",
"__prefix": "xs"
},
"_name": "raveGroup",
"__prefix": "xs"
},
{
"sequence": {
"element": [
{
"_name": "alertByPhone",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "alertByEmail",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "role",
"_type": "groupRoleType",
"_default": "MEMBER",
"_minOccurs": "0",
"__prefix": "xs"
}
],
"__prefix": "xs"
},
"attribute": [
{
"_name": "groupId",
"_type": "xs:int",
"_use": "required",
"__prefix": "xs"
},
{
"_name": "groupDetailsURL",
"_type": "xs:string",
"__prefix": "xs"
}
],
"_name": "raveGroupMembership",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "raveGroupMembership",
"_type": "raveGroupMembership",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "raveGroupMemberships",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "raveGroup",
"_type": "raveGroup",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "raveGroups",
"__prefix": "xs"
},
{
"sequence": {
"element": [
{
"_name": "firstName",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "lastName",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "email",
"_type": "xs:string",
"__prefix": "xs"
},
{
"_name": "alternateEmail1",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "alternateEmail2",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "sisId",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "gender",
"_type": "genderType",
"_default": "UNKNOWN",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "ssoId",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "languagePreference",
"_type": "languageType",
"_default": "en",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "administrationRole",
"_type": "userRoleType",
"_default": "USER",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "role",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileNumber1",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileCarrier1",
"_type": "xs:int",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobile1Confirmed",
"_type": "xs:boolean",
"_default": "false",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "useMobile1ForVoice",
"_type": "xs:boolean",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileNumber2",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "useMobile2ForVoice",
"_type": "xs:boolean",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileCarrier2",
"_type": "xs:int",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "useMobile3ForVoice",
"_type": "xs:boolean",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileNumber3",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "mobileCarrier3",
"_type": "xs:int",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneNumber1",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneExtension1",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneNumber2",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneExtension2",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneNumber3",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "voiceOnlyPhoneExtension3",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "institutionRole",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "userAttribute1",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "userAttribute2",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "userAttribute3",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
},
{
"_name": "userAttribute4",
"_type": "xs:string",
"_minOccurs": "0",
"__prefix": "xs"
}
],
"__prefix": "xs"
},
"_name": "raveUser",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "listMember",
"_type": "xs:string",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "rejectedListMembers",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "errorMessage",
"_type": "xs:string",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "serviceError",
"__prefix": "xs"
},
{
"sequence": {
"element": {
"_name": "userList",
"_type": "userList",
"_nillable": "true",
"_minOccurs": "0",
"_maxOccurs": "unbounded",
"__prefix": "xs"
},
"__prefix": "xs"
},
"_name": "userLists",
"__prefix": "xs"
} }
}, ],
"raveGroup": { "simpleType": [
"type": "object", {
"required": [ "restriction": {
"name", "enumeration": [
"description", {
"keyword" "_value": "MALE",
], "__prefix": "xs"
"properties": { },
"name": {"type": "string"}, {
"description": {"type": "string"}, "_value": "FEMALE",
"keyword": {"type": "string"}, "__prefix": "xs"
"alertPhoneDefault": {"type": "boolean"}, },
"alertEmailDefault": {"type": "boolean"}, {
"officialCircle": {"type": "boolean"}, "_value": "UNKNOWN",
"isPublic": {"type": "boolean"}, "__prefix": "xs"
"anyoneCanPost": {"type": "boolean"}, }
"numSubscriptions": {"type": "integer"}, ],
"id": {"type": "integer"} "_base": "xs:string",
"__prefix": "xs"
},
"_name": "genderType",
"__prefix": "xs"
},
{
"restriction": {
"enumeration": [
{
"_value": "ADMINISTRATOR",
"__prefix": "xs"
},
{
"_value": "CONTRIBUTOR",
"__prefix": "xs"
},
{
"_value": "MEMBER",
"__prefix": "xs"
}
],
"_base": "xs:string",
"__prefix": "xs"
},
"_name": "groupRoleType",
"__prefix": "xs"
},
{
"restriction": {
"enumeration": [
{
"_value": "en",
"__prefix": "xs"
},
{
"_value": "ar",
"__prefix": "xs"
},
{
"_value": "bg",
"__prefix": "xs"
},
{
"_value": "ca",
"__prefix": "xs"
},
{
"_value": "zh",
"__prefix": "xs"
},
{
"_value": "zh_tw",
"__prefix": "xs"
},
{
"_value": "hr",
"__prefix": "xs"
},
{
"_value": "cs",
"__prefix": "xs"
},
{
"_value": "da",
"__prefix": "xs"
},
{
"_value": "nl",
"__prefix": "xs"
},
{
"_value": "tl",
"__prefix": "xs"
},
{
"_value": "fi",
"__prefix": "xs"
},
{
"_value": "fr",
"__prefix": "xs"
},
{
"_value": "de",
"__prefix": "xs"
},
{
"_value": "el",
"__prefix": "xs"
},
{
"_value": "he",
"__prefix": "xs"
},
{
"_value": "hi",
"__prefix": "xs"
},
{
"_value": "id",
"__prefix": "xs"
},
{
"_value": "it",
"__prefix": "xs"
},
{
"_value": "ja",
"__prefix": "xs"
},
{
"_value": "ko",
"__prefix": "xs"
},
{
"_value": "lv",
"__prefix": "xs"
},
{
"_value": "lt",
"__prefix": "xs"
},
{
"_value": "no",
"__prefix": "xs"
},
{
"_value": "pl",
"__prefix": "xs"
},
{
"_value": "pt",
"__prefix": "xs"
},
{
"_value": "ro",
"__prefix": "xs"
},
{
"_value": "ru",
"__prefix": "xs"
},
{
"_value": "sr",
"__prefix": "xs"
},
{
"_value": "sk",
"__prefix": "xs"
},
{
"_value": "sl",
"__prefix": "xs"
},
{
"_value": "es",
"__prefix": "xs"
},
{
"_value": "sv",
"__prefix": "xs"
},
{
"_value": "uk",
"__prefix": "xs"
},
{
"_value": "vi",
"__prefix": "xs"
}
],
"_base": "xs:string",
"__prefix": "xs"
},
"_name": "languageType",
"__prefix": "xs"
},
{
"restriction": {
"enumeration": [
{
"_value": "USER",
"__prefix": "xs"
},
{
"_value": "BROADCAST_ADMIN",
"__prefix": "xs"
},
{
"_value": "SITE_ADMIN",
"__prefix": "xs"
},
{
"_value": "LIST_ADMIN",
"__prefix": "xs"
},
{
"_value": "FACULTY",
"__prefix": "xs"
}
],
"_base": "xs:string",
"__prefix": "xs"
},
"_name": "userRoleType",
"__prefix": "xs"
} }
}, ],
"listMembers": { "_xmlns:xs": "http://www.w3.org/2001/XMLSchema",
"type": "object", "_version": "1.0",
"properties": { "__prefix": "xs"
"listMember": { }
"type": "array", }
"items": {"type": "string"},
"minItems": 0
}
}
},
"userList": {
"type": "object",
"required": ["name"],
"properties": {
"name": {"type": "string"},
"memberList": {"$ref": "#/definitions/listMembers"},
"id": {"type": "integer"},
"userListDetailsURL": {"type": "string"}
}
},
"userLists": {
"type": "object",
"properties": {
"userList": {
"type": "array",
"items": {"$ref": "#/definitions/userList"},
"minItems": 0
}
}
},
"mobileCarriers": {
"type": "object",
"properties": {
"mobileCarrier": {
"type": "array",
"items": {"$ref": "#/definitions/mobileCarrier"},
"minItems": 0
}
}
},
"raveGroupMembership": {
"type": "object",
"required": ["groupId"],
"properties": {
"alertByPhone": {"type": "boolean"},
"alertByEmail": {"type": "boolean"},
"role": {"$ref": "#/definitions/groupRoleType"},
"groupId": {"type": "integer"},
"groupDetailsURL": {"type": "string"}
}
},
"rejectedListMembers": {
"type": "object",
"properties": {
"listMember": {
"type": "array",
"items": {"type": "string"},
"minItems": 0
}
}
},
"raveGroupMemberships": {
"type": "object",
"properties": {
"raveGroupMembership": {
"type": "array",
"items": {"$ref": "#/definitions/raveGroupMembership"},
"minItems": 0
}
}
},
"raveGroups": {
"type": "object",
"properties": {
"raveGroup": {
"type": "array",
"items": {"$ref": "#/definitions/raveGroup"},
"minItems": 0
}
}
},
"raveUser": {
"type": "object",
"required": [
"firstName",
"lastName",
"email"
],
"properties": {
"firstName": {"type": "string"},
"lastName": {"type": "string"},
"email": {"type": "string"},
"alternateEmail1": {"type": "string"},
"alternateEmail2": {"type": "string"},
"sisId": {"type": "string"},
"gender": {"$ref": "#/definitions/genderType"},
"ssoId": {"type": "string"},
"languagePreference": {"$ref": "#/definitions/languageType"},
"administrationRole": {"$ref": "#/definitions/userRoleType"},
"role": {"type": "string"},
"mobileNumber1": {"type": "string"},
"mobileCarrier1": {"type": "integer"},
"mobile1Confirmed": {"type": "boolean"},
"useMobile1ForVoice": {"type": "boolean"},
"mobileNumber2": {"type": "string"},
"useMobile2ForVoice": {"type": "boolean"},
"mobileCarrier2": {"type": "integer"},
"useMobile3ForVoice": {"type": "boolean"},
"mobileNumber3": {"type": "string"},
"mobileCarrier3": {"type": "integer"},
"voiceOnlyPhoneNumber1": {"type": "string"},
"voiceOnlyPhoneExtension1": {"type": "string"},
"voiceOnlyPhoneNumber2": {"type": "string"},
"voiceOnlyPhoneExtension2": {"type": "string"},
"voiceOnlyPhoneNumber3": {"type": "string"},
"voiceOnlyPhoneExtension3": {"type": "string"},
"institutionRole": {"type": "string"},
"userAttribute1": {"type": "string"},
"userAttribute2": {"type": "string"},
"userAttribute3": {"type": "string"},
"userAttribute4": {"type": "string"}
}
},
"listMemberships": {
"type": "object",
"properties": {
"userList": {
"type": "array",
"items": {"$ref": "#/definitions/userList"},
"minItems": 0
}
}
},
"groupRoleType": {
"type": "string",
"enum": [
"ADMINISTRATOR",
"CONTRIBUTOR",
"MEMBER"
]
},
"genderType": {
"type": "string",
"enum": [
"MALE",
"FEMALE",
"UNKNOWN"
]
},
"languageType": {
"type": "string",
"enum": [
"en",
"ar",
"bg",
"ca",
"zh",
"zh_tw",
"hr",
"cs",
"da",
"nl",
"tl",
"fi",
"fr",
"de",
"el",
"he",
"hi",
"id",
"it",
"ja",
"ko",
"lv",
"lt",
"no",
"pl",
"pt",
"ro",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"vi"
]
},
"userRoleType": {
"type": "string",
"enum": [
"USER",
"BROADCAST_ADMIN",
"SITE_ADMIN",
"LIST_ADMIN",
"FACULTY"
]
}
},
"anyOf": [
{
"type": "object",
"properties": {
"ServiceError": {"$ref": "#/definitions/serviceError"}
}
},
{
"type": "object",
"properties": {
"mobileCarrier": {"$ref": "#/definitions/mobileCarrier"}
}
},
{
"type": "object",
"properties": {
"raveGroup": {"$ref": "#/definitions/raveGroup"}
}
},
{
"type": "object",
"properties": {
"userLists": {"$ref": "#/definitions/userLists"}
}
},
{
"type": "object",
"properties": {
"mobileCarriers": {"$ref": "#/definitions/mobileCarriers"}
}
},
{
"type": "object",
"properties": {
"raveGroupMembership": {"$ref": "#/definitions/raveGroupMembership"}
}
},
{
"type": "object",
"properties": {
"rejectedListMembers": {"$ref": "#/definitions/rejectedListMembers"}
}
},
{
"type": "object",
"properties": {
"listMembers": {"$ref": "#/definitions/listMembers"}
}
},
{
"type": "object",
"properties": {
"raveGroupMemberships": {"$ref": "#/definitions/raveGroupMemberships"}
}
},
{
"type": "object",
"properties": {
"userList": {"$ref": "#/definitions/userList"}
}
},
{
"type": "object",
"properties": {
"raveGroups": {"$ref": "#/definitions/raveGroups"}
}
},
{
"type": "object",
"properties": {
"raveUser": {"$ref": "#/definitions/raveUser"}
}
},
{
"type": "object",
"properties": {
"listMemberships": {"$ref": "#/definitions/listMemberships"}
}
}
]
}
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment