eedm.organizations.v6.0.organizations.json Maven / Gradle / Ivy
{
"title" : "Organizations",
"description" : "An organized body of people with a particular purpose, especially a business, society, association, etc.",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the organization",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"title" : {
"title" : "Title",
"description" : "The full name of the organization",
"type" : "string",
"minLength" : 1
},
"description" : {
"title" : "Description",
"description" : "The description of the organization",
"type" : "string"
},
"roles" : {
"title" : "Roles",
"description" : "The roles the organization plays with respect to the home educational institution",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"role" : {
"title" : "Role",
"description" : "The role of the organization",
"javaType" : "com.ellucian.generated.eedm.organizations.v6_0.RoleEnum",
"enum" : [ "vendor", "partner", "affiliate", "constituent" ],
"type" : "string"
},
"startOn" : {
"title" : "Start On",
"description" : "The start date of the relationship in this role",
"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
} ]
},
"endOn" : {
"title" : "End On",
"description" : "The end date of the relationship in this role",
"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
} ]
}
},
"additionalProperties" : false,
"required" : [ "role" ]
}
},
"credentials" : {
"title" : "Credentials",
"description" : "Information that identifies a user to a system such as a network or computer",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of credential, such as \"Person ID\", \"Organization ID\", \"System ID\", etc.",
"enum" : [ "ssn", "sin", "bannerId", "colleaguePersonId", "elevateId", "bannerSourcedId", "bannerUserName", "bannerUdcId" ],
"type" : "string"
},
"value" : {
"title" : "Value",
"description" : "The current value of the credential",
"type" : "string"
},
"startOn" : {
"title" : "Start Date",
"description" : "The date when the credential becomes valid",
"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
} ]
},
"endOn" : {
"title" : "End Date",
"description" : "The date when the credential becomes invalid",
"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
} ]
}
},
"additionalProperties" : false,
"required" : [ "type", "value" ]
}
},
"addresses" : {
"title" : "Addresses",
"description" : "The physical locations where the organization resides or may be contacted by mail.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"address" : {
"title" : "Address",
"description" : "The address associated with the location.",
"oneOf" : [ {
"title" : "Address",
"description" : "",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Address.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/addresses/{id}",
"targetSchema" : {
"$ref" : "addresses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"title" : "Address Detail",
"description" : "",
"type" : "object",
"properties" : {
"addressLines" : {
"title" : "Address",
"description" : "The address lines of the organization's location, such as a street address, post office box number, or city, region, and postal code",
"type" : "array",
"items" : {
"type" : "string"
}
},
"place" : {
"title" : "Place",
"description" : "A country specific postal region. Postal regions are expressed as a hierarchy of country, region, and sub-region, and as a locality with postal automation codes",
"oneOf" : [ {
"type" : "object",
"properties" : {
"country" : {
"title" : "Country",
"description" : "The country where the mailing address is located.",
"oneOf" : [ {
"title" : "Australia",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "AUS" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "AUSTRALIA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "AU-NSW", "AU-ACT", "AU-VIC", "AU-QLD", "AU-SA", "AU-WA", "AU-TAS", "AU-NT" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(0[289][0-9]{2})|([1345689][0-9]{3})|(2[0-8][0-9]{2})|(290[0-9])|(291[0-4])|(7[0-4][0-9]{2})|(7[8-9][0-9]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Brazil",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "BRA" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "BRAZIL" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "BR-AC", "BR-AL", "BR-AM", "BR-AP", "BR-BA", "BR-CE", "BR-DF", "BR-ES", "BR-GO", "BR-MA", "BR-MG", "BR-MS", "BR-MT", "BR-PA", "BR-PB", "BR-PE", "BR-PI", "BR-PR", "BR-RJ", "BR-RN", "BR-RO", "BR-RR", "BR-RS", "BR-SC", "BR-SE", "BR-SP", "BR-TO" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^\\d{5}\\-\\d{3}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Canada",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "CAN" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "CANADA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "CA-AB", "CA-BC", "CA-MB", "CA-NB", "CA-NL", "CA-NS", "CA-NT", "CA-NU", "CA-ON", "CA-PE", "CA-QC", "CA-SK", "CA-YT" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^[ABCEGHJKLMNPRSTVXYabceghjklmnprstvxy]{1}\\d{1}[A-Za-z]{1}\\d{1}[A-Za-z]{1}\\d{1}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Mexico",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "MEX" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "MEXICO" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "MX-AGU", "MX-BCN", "MX-BCS", "MX-CAM", "MX-COA", "MX-COL", "MX-CHP", "MX-CHH", "MX-DIF", "MX-DUR", "MX-GUA", "MX-GRO", "MX-HID", "MX-JAL", "MX-MEX", "MX-MIC", "MX-MOR", "MX-NAY", "MX-NLE", "MX-OAX", "MX-PUE", "MX-QUE", "MX-ROO", "MX-SLP", "MX-SIN", "MX-SON", "MX-TAB", "MX-TAM", "MX-TLA", "MX-VER", "MX-YUC", "MX-ZAC" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^\\A\\d{5,5}\\Z$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Netherlands",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "NLD" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "NETHERLANDS" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "NL-DR", "NL-FL", "NL-FR", "NL-GE", "NL-GR", "NL-LI", "NL-NB", "NL-NH", "NL-OV", "NL-UT", "NL-ZE", "NL-ZH" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(NL-)?(\\d{4})\\s*([A-Z]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "United Kingdom of Great Britain and Northern Ireland",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "GBR" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"enum" : [ "GB-ENG", "GB-NIR", "GB-SCT", "GB-WLS" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "GB-BAS", "GB-BBD", "GB-BDF", "GB-BDG", "GB-BEN", "GB-BEX", "GB-BIR", "GB-BKM", "GB-BMH", "GB-BNE", "GB-BNH", "GB-BNS", "GB-BOL", "GB-BPL", "GB-BRC", "GB-BRD", "GB-BRY", "GB-BST", "GB-BUR", "GB-CAM", "GB-CBF", "GB-CHE", "GB-CHW", "GB-CLD", "GB-CMA", "GB-CMD", "GB-CON", "GB-COV", "GB-CRY", "GB-DAL", "GB-DBY", "GB-DER", "GB-DEV", "GB-DNC", "GB-DOR", "GB-DUD", "GB-DUR", "GB-EAL", "GB-ENF", "GB-ERY", "GB-ESS", "GB-ESX", "GB-GAT", "GB-GLS", "GB-GRE", "GB-HAL", "GB-HAM", "GB-HAV", "GB-HCK", "GB-HEF", "GB-HIL", "GB-HMF", "GB-HNS", "GB-HPL", "GB-HRT", "GB-HRW", "GB-HRY", "GB-IOS", "GB-IOW", "GB-ISL", "GB-KEC", "GB-KEN", "GB-KHL", "GB-KIR", "GB-KTT", "GB-KWL", "GB-LAN", "GB-LBH", "GB-LCE", "GB-LDS", "GB-LEC", "GB-LEW", "GB-LIN", "GB-LIV", "GB-LND", "GB-LUT", "GB-MAN", "GB-MDB", "GB-MDW", "GB-MIK", "GB-MRT", "GB-NBL", "GB-NEL", "GB-NET", "GB-NFK", "GB-NGM", "GB-NLN", "GB-NSM", "GB-NTH", "GB-NTT", "GB-NTY", "GB-NWM", "GB-NYK", "GB-OLD", "GB-OXF", "GB-PLY", "GB-POL", "GB-POR", "GB-PTE", "GB-RCC", "GB-RCH", "GB-RDB", "GB-RDG", "GB-RIC", "GB-ROT", "GB-RUT", "GB-SAW", "GB-SFK", "GB-SFT", "GB-SGC", "GB-SHF", "GB-SHN", "GB-SHR", "GB-SKP", "GB-SLF", "GB-SLG", "GB-SND", "GB-SOL", "GB-SOM", "GB-SOS", "GB-SRY", "GB-STE", "GB-STH", "GB-STN", "GB-STS", "GB-STT", "GB-STY", "GB-SWD", "GB-SWK", "GB-TAM", "GB-TFW", "GB-THR", "GB-TOB", "GB-TRF", "GB-TWH", "GB-WAR", "GB-WBK", "GB-WFT", "GB-WGN", "GB-WIL", "GB-WKF", "GB-WLL", "GB-WLV", "GB-WND", "GB-WNM", "GB-WOK", "GB-WOR", "GB-WRL", "GB-WRT", "GB-WSM", "GB-WSX", "GB-YOR", "GB-ABC", "GB-AND", "GB-ANN", "GB-BFS", "GB-CCG", "GB-DRS", "GB-FMO", "GB-LBC", "GB-MEA", "GB-MUL", "GB-NMD", "GB-ABD", "GB-ABE", "GB-AGB", "GB-ANS", "GB-CLK", "GB-DGY", "GB-DND", "GB-EAY", "GB-EDH", "GB-EDU", "GB-ELN", "GB-ELS", "GB-ERW", "GB-FAL", "GB-FIF", "GB-GLG", "GB-HLD", "GB-IVC", "GB-MLN", "GB-MRY", "GB-NAY", "GB-NLK", "GB-ORK", "GB-PKN", "GB-RFW", "GB-SAY", "GB-SCB", "GB-SLK", "GB-STG", "GB-WDU", "GB-WLN", "GB-ZET", "GB-AGY", "GB-BGE", "GB-BGW", "GB-CAY", "GB-CGN", "GB-CMN", "GB-CRF", "GB-CWY", "GB-DEN", "GB-FLN", "GB-GWN", "GB-MON", "GB-MTY", "GB-NTL", "GB-NWP", "GB-PEM", "GB-POW", "GB-RCT", "GB-SWA", "GB-TOF", "GB-VGL", "GB-WRX" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(GIR 0AA)|((([A-Z-[QVX]][0-9][0-9]?)|(([A-Z-[QVX]][A-Z-[IJZ]][0-9][0-9]?)|(([A-Z-[QVX]][0-9][A-HJKPSTUW])|([A-Z-[QVX]][A-Z-[IJZ]][0-9][ABEHMNPRVWXY])))) [0-9][A-Z-[CIKMOV]]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "United States of America",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "USA" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "UNITED STATES OF AMERICA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"oneOf" : [ {
"type" : "string",
"enum" : [ "US-AL", "US-AK", "US-AZ", "US-AR", "US-CA", "US-CO", "US-CT", "US-DE", "US-DC", "US-FL", "US-GA", "US-HI", "US-ID", "US-IL", "US-IN", "US-IA", "US-KS", "US-KY", "US-LA", "US-ME", "US-MD", "US-MA", "US-MI", "US-MN", "US-MS", "US-MO", "US-MT", "US-NE", "US-NV", "US-NH", "US-NJ", "US-NM", "US-NY", "US-NC", "US-ND", "US-OH", "US-OK", "US-OR", "US-PA", "US-RI", "US-SC", "US-SD", "US-TN", "US-TX", "US-UT", "US-VT", "US-VA", "US-WA", "US-WV", "US-WI", "US-WY", "US-AS", "US-GU", "US-MP", "US-PR", "US-UM", "US-VI" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(\\d{5}(-\\d{4})?|[A-Z]\\d[A-Z] *\\d[A-Z]\\d)$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"deliveryPoint" : {
"title" : "Delivery Point",
"description" : "A specific set of digits between 00 and 99 assigned to every address. When combined with the ZIP + 4 code, the delivery point provides a unique identifier for every deliverable address served by the US Postal Service.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^[0-9][0-9]$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"carrierRoute" : {
"title" : "Carrier Route",
"description" : "A subdivision of a US zipcode.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(C|R|P)[0-9]{3}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"correctionDigit" : {
"title" : "Correction Digit",
"description" : "A number used to check for errors in a US ZIP code, delivery point, or carrier route.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^[0-9]$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Generic",
"description" : "",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"type" : "string"
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code of a region within the country",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The code of a sub-region. This should be based on ISO 3166-2, if applicable.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
} ]
}
},
"additionalProperties" : false,
"required" : [ "country" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"latitude" : {
"title" : "Latitude",
"description" : "The latitude of the location",
"oneOf" : [ {
"type" : "number",
"minimum" : -90,
"maximum" : 90
}, {
"type" : "null"
} ]
},
"longitude" : {
"title" : "Longitude",
"description" : "The longitude of the location",
"oneOf" : [ {
"type" : "number",
"minimum" : -180,
"maximum" : 180
}, {
"type" : "null"
} ]
},
"geographicAreas" : {
"title" : "Geographic Areas",
"description" : "The geographic areas assigned to this location.",
"type" : "array",
"items" : {
"title" : "Geographic Areas",
"description" : "The geographic areas assigned to this location.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Geographic Areas.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/geographic-areas/{id}",
"targetSchema" : {
"$ref" : "geographic-areas.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
}
},
"additionalProperties" : false,
"required" : [ "addressLines" ]
} ]
},
"type" : {
"title" : "Type",
"description" : "A type of location for the organization. Includes a standard type (e.g. 'main', 'support') and an optional, custom type to further identify the type of location.",
"type" : "object",
"properties" : {
"addressType" : {
"title" : "Address Type",
"description" : "A mapping to a standard type for the address",
"enum" : [ "home", "school", "vacation", "billing", "shipping", "mailing", "business", "parent", "family", "pobox", "main", "branch", "region", "support", "matchingGifts", "other" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "An optional, custom address type.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/address-types/{id}",
"targetSchema" : {
"$ref" : "address-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "addressType" ]
},
"startOn" : {
"title" : "Start On",
"description" : "The earliest date that this location was valid for the organization",
"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
} ]
},
"endOn" : {
"title" : "End On",
"description" : "The latest date when this location was valid for the organization",
"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
} ]
},
"preference" : {
"title" : "Preferred Location",
"description" : "Specifies if the location is preferred over others of the same type.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "address", "type" ]
}
},
"phones" : {
"title" : "Phone",
"description" : "The phones and phone-connected devices at which the organization can be contacted",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "A type of phone for the organization. Includes a standard type (e.g., 'main', 'support') and an optional, custom type to further identify the type of phone.",
"type" : "object",
"properties" : {
"phoneType" : {
"title" : "Type",
"description" : "A type of phone contact for the organization",
"enum" : [ "mobile", "home", "school", "vacation", "business", "fax", "pager", "tdd", "parent", "family", "main", "branch", "region", "support", "billing", "matchingGifts", "other" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "An optional, custom phone type.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/phone-types/{id}",
"targetSchema" : {
"$ref" : "phone-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "phoneType" ]
},
"preference" : {
"title" : "Preferred Phone",
"description" : "Specifies if the phone is preferred over others of the same type.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"countryCallingCode" : {
"title" : "Country Calling Code",
"description" : "The country calling code of telephone and/or mobile device when dialing internationally.",
"oneOf" : [ {
"type" : "string",
"format" : "countryCallingCode",
"pattern" : "^\\+?[1-9][0-9]{0,3}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"number" : {
"title" : "Number",
"description" : "The number assigned to the phone.",
"type" : "string"
},
"extension" : {
"title" : "Extension",
"description" : "The extension used to connect to the phone when multiple phones share the same primary number.",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "type", "number" ]
}
},
"emails" : {
"title" : "Email",
"description" : "The email addresses at which the organization can be contacted",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "A type of email for the organization. Includes a standard type (e.g. 'general', 'hr') and an optional, custom type to further identify the type of email.",
"type" : "object",
"properties" : {
"emailType" : {
"title" : "Type",
"description" : "A mapping to a standard type for the email type",
"enum" : [ "personal", "business", "school", "parent", "family", "sales", "support", "general", "billing", "legal", "hr", "media", "matchingGifts", "other" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "An optional, custom email type.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/email-types/{id}",
"targetSchema" : {
"$ref" : "email-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "emailType" ]
},
"preference" : {
"title" : "Preferred Email",
"description" : "Specifies if the email is preferred over others of the same type or overall",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"address" : {
"title" : "Email Address",
"description" : "An email address for the organization",
"type" : "string",
"format" : "email",
"pattern" : "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"
}
},
"additionalProperties" : false,
"required" : [ "type", "address" ]
}
},
"socialMedia" : {
"title" : "Social Media",
"description" : "The social media account at which the organization can be contacted.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Social Media",
"description" : "A type of social media account for the organization. Includes a standard type (e.g. 'skype', 'facebook') and an optional, custom type to further identify the type of social media account.",
"type" : "object",
"properties" : {
"socialMediaType" : {
"title" : "Type",
"description" : "A type of social media account (e.g. 'skype', 'facebook').",
"enum" : [ "windowsLive", "yahoo", "skype", "qq", "hangouts", "icq", "jabber", "facebook", "twitter", "instagram", "tumblr", "pinterest", "linkedin", "foursquare", "youtube", "blog", "website", "other" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "An optional, custom social media type.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/social-media-types/{id}",
"targetSchema" : {
"$ref" : "social-media-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "socialMediaType" ]
},
"preference" : {
"title" : "Preferred Social Media",
"description" : "Specifies if the social media account is preferred over others of the same type.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"address" : {
"title" : "Address",
"description" : "The username, handle or other address of the social media account.",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "type", "address" ]
}
}
},
"required" : [ "id", "title" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/organizations/",
"schema" : {
"type" : "object",
"properties" : {
"role" : {
"type" : "string",
"enum" : [ "vendor", "partner", "affiliate", "constituent" ]
},
"credential" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "ssn", "sin", "bannerId", "colleaguePersonId", "elevateId", "bannerSourceId", "bannerUserName", "bannerUdcId" ]
},
"value" : {
"type" : "string"
}
}
}
}
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy