Participant.xsd

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.iepmodel.net"
	xmlns="http://www.iepmodel.net" elementFormDefault="qualified">
	<xs:annotation>
		<xs:documentation>Schema defines project participants. It is intended to cover all types of participants, including consumers, service providers, etc.
		</xs:documentation>
	</xs:annotation>
	<xs:include schemaLocation="Common.xsd"/>
	<xs:element name="participant" type="participant"/>
	<xs:complexType name="participant">
		<xs:annotation>
			<xs:documentation>This is intended to cover all participants including Consumers, Service Providers, etc.

Why mailing address is outside the Contact?

mailing addresses are closely associated with the role of the participant, not the individual contacts within a participant.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="participantType" type="xs:string" minOccurs="0" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>The class (or type) of participant. Legal values should include Individual, Business, and Government. The tax status element provides more detailed information about the type of business (corporation, LLC, tax-exempt, etc).</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="taxStatus" type="xs:string" minOccurs="0" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>The participant's tax entity status.  For example, the Cal Solar Initiative program defines the following legal values: Corporation, Individual, LLC (Corporation), LLC (Non-Corporation), Partnership, Sole Proprietor, Tax Exempt.  This may hold other values depending on the needs of the user.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="organization" type="xs:string" minOccurs="0" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>If the Participant is an organization. Use this for the name of the organization</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="contacts">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="contact" type="contact" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element minOccurs="0" name="addresses">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="address" type="address" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="roles">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="role" type="participantRoleEnum" minOccurs="1"
							maxOccurs="unbounded">
							<xs:annotation>
								<xs:documentation>A participant may have one or more roles with respect to a project.</xs:documentation>
							</xs:annotation>
						</xs:element>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="taxPayerId" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element minOccurs="0" name="credentials">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="credential" type="credential" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element minOccurs="0" name="manufacturerAffiliations">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="manufacturerAffiliation" type="manufacturerAffiliation"
							minOccurs="1" maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element minOccurs="0" name="liabilityPolicies">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="liabilityPolicy" type="liabilityPolicy" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element minOccurs="0" name="services">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="service" type="service" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="id" use="optional" type="xs:ID"/>
	</xs:complexType>
	<xs:complexType name="contact">
		<xs:annotation>
			<xs:documentation>This schema has been extended from one of the components in the Clean Power Research schema included in their PowerClerk schema. It's intended use is to define the contacts in a particular project for customers, contractors, service providers, etc.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="firstName" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="middleName" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="lastName" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="title" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element minOccurs="0" name="phoneNumbers">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="phoneNumber" type="phoneNumber" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element minOccurs="0" name="emailAddresses">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="emailAddress" type="emailAddress" minOccurs="1"
							maxOccurs="unbounded"/>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="skypeAccount" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="website" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="preferredContactMethod" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="bestTimeOfDayToReach" type="xs:string" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="participantRoleEnum">
		<xs:annotation>
			<xs:documentation>Host Customer - "utility account holder"</xs:documentation>
			<xs:documentation>Customer - "The customer of the scope of work offered."</xs:documentation>
			<xs:documentation>Occupant - "The organization or persons occupying a building specified in the project."</xs:documentation>
			<xs:documentation>PV System Owner - "The owner of the PV system may not necessarily the owber of the facility. As in the case of leasing the system."</xs:documentation>
			<xs:documentation>Incentive Payee - "Agency or business providing the incentive."</xs:documentation>
			<xs:documentation>Seller - "The party providing the defined system / scope of work"</xs:documentation>
			<xs:documentation>Financer - "The party providing the financing for the work"</xs:documentation>
			<xs:documentation>General Contractor - "The general contractor overssing the work done."</xs:documentation>
			<xs:documentation>Installer - "The party installing the system. Typically this is a contractor."</xs:documentation>
			<xs:documentation>Referrer - "A party who referred the customer to the seller."</xs:documentation>
			<xs:documentation>Auditor - "A party who provides the site audit."</xs:documentation>
			<xs:documentation>Inspector - "A inspector for any of the work done."</xs:documentation>
			<xs:documentation>Engineer - "An engineer providing designs documents and specifications"</xs:documentation>
			<xs:documentation>Program Administrator - "A party who oversees any incentive or regulatory work."</xs:documentation>
			<xs:documentation>Authority Having Jurisdiction - "Also known as AHJ. This is the city, county, or other authority with jurisdiction over building permits and inspections."</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:enumeration value="HOST_CUSTOMER"/>
			<xs:enumeration value="CUSTOMER"/>
			<xs:enumeration value="OCCUPANT"/>
			<xs:enumeration value="PV_SYSTEM_OWNER"/>
			<xs:enumeration value="PROPERTY_OWNER"/>
			<xs:enumeration value="INCENTIVE_PAYEE"/>
			<xs:enumeration value="SELLER"/>
			<xs:enumeration value="FINANCER"/>
			<xs:enumeration value="REFERRER"/>
			<xs:enumeration value="INSTALLER"/>
			<xs:enumeration value="ELECTRICIAN"/>
			<xs:enumeration value="ROOFER"/>
			<xs:enumeration value="GENERAL_CONTRACTOR"/>
			<xs:enumeration value="AUDITOR"/>
			<xs:enumeration value="INSPECTOR"/>
			<xs:enumeration value="ENGINEER"/>
			<xs:enumeration value="PROGRAM_ADMINISTRATOR"/>
			<xs:enumeration value="AUTHORITY_HAVING_JURISDICTION"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:complexType name="credential">
		<xs:annotation>
			<xs:documentation>Credential Validation describes a way for software and service developers using the IEP model to verify that a particular individual (typically a contractor, home energy rater, or similar professional) has a credential issued by a certifying authority (“CA”, such  as a contractor licensing board, HERS provider, or similar authority). It also specifies a way to describe credential metadata, such as status and dates.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="caInternalId" type="xs:string" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Unique internal identifier from Certifying Authority
</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="caId" type="xs:int" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Reference to Certifying  Authority
</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="name" type="xs:string" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Credential short name</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="description" type="xs:string" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Credential long name
</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="dateConferred" type="xs:date" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Date credential first conferred </xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="dateExpires" type="xs:date" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Date credential expires (may be past)
</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="status" type="xs:string" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Status (valid, expired, etc,); varies by CA</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="liabilityPolicy">
		<xs:annotation>
			<xs:documentation>
This is only used for Service Providers(i.e. Seller, Installer, Referrer, etc.)</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="issuer" type="xs:string" minOccurs="1" maxOccurs="1"/>
			<xs:element name="number" type="xs:int" minOccurs="1" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="service">
		<xs:annotation>
			<xs:documentation>A Description of the types of services provided. For instance: Heating, cooling, (installation/repair), duct sealing, asbestos removal, etc.

This is only used for Service Providers(i.e. Seller, Installer, Referrer, etc.)</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="name" type="xs:string" minOccurs="1" maxOccurs="1"/>
			<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="manufacturerAffiliation">
		<xs:annotation>
			<xs:documentation>This is for recording formal Manufacturer affiliations

This is only used for Service Providers(i.e. Seller, Installer, Referrer, etc.)</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="name" type="xs:string" minOccurs="1" maxOccurs="1"/>
			<xs:element name="description" type="xs:string" minOccurs="1" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="phoneNumber">
		<xs:sequence>
			<xs:element name="number" type="xs:string" minOccurs="1" maxOccurs="1"/>
			<xs:element name="extension" type="xs:int" minOccurs="0" maxOccurs="1" nillable="true"/>
			<xs:element name="primary" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
			<xs:element name="phoneNumberUse" type="phoneNumberEnum" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>

	<xs:simpleType name="phoneNumberEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="BUSINESS"/>
			<xs:enumeration value="BUSINESS_FAX"/>
			<xs:enumeration value="HOME"/>
			<xs:enumeration value="HOME_FAX"/>
			<xs:enumeration value="MOBILE"/>
			<xs:enumeration value="PAGER"/>
			<xs:enumeration value="SKYPE"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:complexType name="emailAddress">
		<xs:sequence>
			<xs:element name="address" type="xs:string" minOccurs="0" maxOccurs="1"/>
			<xs:element name="primary" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
			<xs:element name="emailAddressUse" type="emailAddressEnum" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="emailAddressEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="WORK"/>
			<xs:enumeration value="HOME"/>
			<xs:enumeration value="ALTERNATE"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:complexType name="certifyingAuthority">
		<xs:sequence>
			<xs:element name="caId" type="xs:int" minOccurs="1" maxOccurs="1"/>
			<xs:element name="caName" type="xs:string" minOccurs="1" maxOccurs="1"/>
			<xs:element name="mailingAddress" type="address" minOccurs="1" maxOccurs="1"/>
			<xs:element name="contact" type="contact" minOccurs="1" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
</xs:schema>