Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
rapidModel ImportedModel
dataModel ImportedDataModel
/**The list of workers. A worker is someone who performs duties and has responsibilities for an organization*/
structure WorkersRoot
workers: reference Workers*
/**A worker is someone who performs duties and has responsibilities for an organization*/
structure Workers
/**A unique identifier of an associate*/
associateOID: string
/**An identifier for a worker, e.g. an Employee ID*/
workerID: reference WorkerID
/**An associate is a person with a relationship to an organization*/
person: reference Person
/**These dates are related to the highest level legal relationship that a person has with the organization. If a given worker has multiple relationships with the organization, these are the dates associated with the primary relationship.*/
workerDates: reference WorkerDates
/**The status of the worker in the organization at the highest level. If a given worker has multiple relationships with the organization, this is the status that arches over all those relationships*/
workerStatus: reference WorkerStatus
/**A list of photos*/
photos: reference Photos*
/**A container of communication mechanisms.*/
businessCommunication: reference BusinessCommunication
workAssignments: reference WorkAssignments*
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
customFieldGroup: reference CustomFieldGroup
links: reference Links*
/**An identifier for a worker, e.g. an Employee ID*/
structure WorkerID
/**An actual ID value*/
idValue: string
/**The scheme code*/
schemeCode: reference SchemeCode
/**The scheme code*/
structure SchemeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An associate is a person with a relationship to an organization*/
structure Person
/**A list of government identifiers*/
governmentIDs: reference GovernmentIDs*
/**The current legal name of the person in the associated context. For example, if the context is set to Germany, this equates to the legal name of the person in Germany.*/
legalName: reference LegalName
/**This is the primary residential address that is used by an organization for payroll, taxation, and benefit program eligibility*/
legalAddress: reference LegalAddress
/**A container of communication mechanisms*/
communication: reference Communication
/**The birth date of the person. Follows the ISO-8601:2000 format*/
birthDate: string
/**Indicates that the person is deceased*/
deceasedIndicator: boolean
/**The date a person died. Follows the ISO-8601:2000 format*/
deathDate: string
/**The gender of a person, e.g. Male, Female*/
genderCode: reference GenderCode
/**The religion code of the person*/
religionCode: reference ReligionCode
/**Person marital status, e.g. Married, Divorced, etc.*/
maritalStatusCode: reference MaritalStatusCode
/**Social insurance is a government operated social security scheme that provides income loss, maternity, sickness benefits, and retirement pensions to the working population. It is funded by regular contributions based on wage or salary by both employees and employers, and by government through taxation. Examples in the USA are Medicare and Medicaid*/
socialInsurancePrograms: reference SocialInsurancePrograms*
/**Indicates that the person is a tobacco user.*/
tobaccoUserIndicator: boolean
/**Indicates that the person is disabled*/
disabledIndicator: boolean
/**Person disabilites, e.g. Amputee, Hearing Impairment, etc.*/
disabilityTypeCodes: reference DisabilityTypeCodes*
/**The percentage of disability*/
disabilityPercentage: float
/**Indicates that the person is student*/
studentIndicator: boolean
/**Student status of a person*/
studentStatusCode: reference StudentStatusCode
/**A list of identity documents, that serve as to confirm the identification of the holder , e.g. a birth certificate, an ID Card*/
identityDocuments: reference IdentityDocuments*
/**A list of immigration documents for a person who is not a citizen of the country in which he or see resides , e.g. a passport, visa, alien registration card, aka, green card, residence permit, etc.*/
immigrationDocuments: reference ImmigrationDocuments*
/**A list of passport documents, issued by a national govenment which certifies the identiy and nationality of its holder*/
passports: reference Passports*
/**A list of documents that authorize work, e.g. visas, a work permit, a labor card, etc.*/
workAuthorizationDocuments: reference WorkAuthorizationDocuments*
/**The preferred name of the person in the associated context. A preferred name is often a variation on the current name that that the person has indicated as preferred. It is the full name by which the person wishes to be known within the context of the organization.*/
preferredName: reference PreferredName
/**Former names of the person in the associated context*/
formerNames: reference FormerNames*
/**The birth name of the person in the associated context*/
birthName: reference BirthName
/**The place a person was born. This can have taxation impacts*/
birthPlace: reference BirthPlace
/**A list of addresses related to the associated entity*/
otherPersonalAddresses: reference OtherPersonalAddresses*
/**An ethnic group is a group that regards itself or is regarded by others as a distinct community by virtue of certain characteristics that will help to distinguish the group from the surrounding community. Ethnicity is considered to be shared characteristics such as culture, language, religion, and traditions, which contribute to the identify of a person or group*/
ethnicityCode: reference EthnicityCode
/**Race is a classification system used to categorize humans into large and distinct populations or groups by heritable phenotypic characteristics, geographic ancestry, culture, history, language, physical appearance, ethnicity, and social status*/
raceCode: reference RaceCode
/**Person countries of citizenship, in which the Address is in. ISO_3166-1-alpha-2 code list*/
citizenshipCountryCodes: reference CitizenshipCountryCodes*
/**Person countries of residence.*/
residencyCountryCodes: reference ResidencyCountryCodes*
/**The highest level of education acheived by a given person.*/
highestEducationLevelCode: reference HighestEducationLevelCode
/**Person military status, e.g. Active, Active Reserve, etc*/
militaryStatusCode: reference MilitaryStatusCode
/**The effective date of the related entity. Follows the ISO-8601:2000 format.*/
militaryDischargeDate: string
/**Person military classification, e.g. Armed Forces Medal Veteran, Disabled Veteran, etc.*/
militaryClassificationCodes: reference MilitaryClassificationCodes*
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
customFieldGroup: reference Person_customFieldGroup_CustomFieldGroup
links: reference Person_links_Links*
/**A government identifier, e.g. a national identity number or a social insurance number*/
structure GovernmentIDs
/**An actual ID*/
idValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference NameCode
/**Country in which the Address is in. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**The status of the associated government ID*/
"statusCode": reference StatusCode
/**The date of the related entity. Follows the ISO-8601:2000 format*/
expirationDate: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The status of the associated government ID*/
structure StatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
effectiveDate: string
/**The current legal name of the person in the associated context. For example, if the context is set to Germany, this equates to the legal name of the person in Germany.*/
structure LegalName
/**The first name of the person*/
givenName: string
/**Person middle name or initial*/
middleName: string
/**Person family name 1*/
familyName1: string
/**Person family name 2*/
familyName2: string
/**A formatted version of the person name*/
formattedName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference LegalName_nameCode_NameCode
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference ScriptCode
/**A list of preferred salutations*/
preferredSalutations: reference PreferredSalutations*
/**A preferred name, e.g. a nickname*/
nickName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
generationAffixCode: reference GenerationAffixCode
/**The qualification affix of the person name*/
qualificationAffixCode: reference QualificationAffixCode
/**Person titles*/
titleAffixCodes: reference TitleAffixCodes*
/**Person family name pre-fix*/
familyName1Prefix: string
/**Person family name pre-fix*/
familyName2Prefix: string
/**Person initials*/
initials: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure LegalName_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
structure ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A preferred salutation, e.g. Mr., Dr., etc.*/
structure PreferredSalutations
/**The saluation code*/
salutationCode: reference SalutationCode
/**The type of salutation, e.g. Professional, Social*/
typeCode: reference TypeCode
/**The sequence or order of the salutation*/
sequenceNumber: integer
/**The saluation code*/
structure SalutationCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of salutation, e.g. Professional, Social*/
structure TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
structure GenerationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The qualification affix of the person name*/
structure QualificationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person titles*/
structure TitleAffixCodes
/**The title affix of the person name*/
affixCode: reference AffixCode
/**The sequence or order of the title*/
sequenceNumber: integer
/**The title affix of the person name*/
structure AffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**This is the primary residential address that is used by an organization for payroll, taxation, and benefit program eligibility*/
structure LegalAddress
/**A descriptive coded name of the address*/
nameCode: reference LegalAddress_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference LegalAddress_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference GeoCoordinate
/**This indicator is used to support the ability to say that one address is the same as another. For example, the address of a dependent is the same as that of a worker. If a given system supports this functionality, this field should be present and set to true. The meta component associated to an event that allows for the adding or changing of an address, should use the links array associated to the indicator to define the list of addresses from which the user can select to set the address in context to be the same as.*/
sameAsAddressIndicator: boolean
/**This link is used in conjunction with the sameAsAddressIndicator. If a given system support same as address functionality, this link will point to the address that a user has selected as being the same as the one in context. For example, if the address in context is a dependent address, and the user has indicated that the dependent address is the same as the legal address of the worker, this link would point to worker/id/person/legalAddress.*/
sameAsAddressLink: reference SameAsAddressLink
/**A descriptive coded name of the address*/
structure LegalAddress_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure LegalAddress_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
/**This link is used in conjunction with the sameAsAddressIndicator. If a given system support same as address functionality, this link will point to the address that a user has selected as being the same as the one in context. For example, if the address in context is a dependent address, and the user has indicated that the dependent address is the same as the legal address of the worker, this link would point to worker/id/person/legalAddress.*/
structure SameAsAddressLink
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A container of communication mechanisms*/
structure Communication
/**A list of land-line telephone numbers*/
landlines: reference Landlines*
/**A list of mobile telephone numbers*/
mobiles: reference Mobiles*
/**A list of fax telephone numbers*/
faxes: reference Faxes*
/**A list of pager telephone numbers*/
pagers: reference Pagers*
/**A list of email addresses*/
emails: reference Emails*
/**A list of internet URIs*/
internetAddresses: reference InternetAddresses*
/**A list of instant messages URIs*/
instantMessages: reference InstantMessages*
/**A list of social networks addresses*/
socialNetworks: reference SocialNetworks*
structure Landlines
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Landlines_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Landlines_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure Mobiles
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Mobiles_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Mobiles_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure Faxes
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Faxes_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Faxes_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure Pagers
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Pagers_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Pagers_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure Emails
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Emails_nameCode_NameCode
/**The URI of the associated email address*/
emailUri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Emails_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure InternetAddresses
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference InternetAddresses_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure InternetAddresses_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure InstantMessages
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference InstantMessages_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure InstantMessages_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure SocialNetworks
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference SocialNetworks_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure SocialNetworks_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The gender of a person, e.g. Male, Female*/
structure GenderCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The religion code of the person*/
structure ReligionCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person marital status, e.g. Married, Divorced, etc.*/
structure MaritalStatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
effectiveDate: string
/**Social insurance is a government operated social security scheme that provides income loss, maternity, sickness benefits, and retirement pensions to the working population. It is funded by regular contributions based on wage or salary by both employees and employers, and by government through taxation. Examples in the USA are Medicare and Medicaid*/
structure SocialInsurancePrograms
/**Person social insurance type, e.g. Medicare*/
nameCode: reference SocialInsurancePrograms_nameCode_NameCode
/**The country associated to the related entity. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**Indicates that the person is covered by the associated insurance*/
coveredIndicator: boolean
/**A unique identifier of a social insurance program*/
itemID: string
/**Person social insurance type, e.g. Medicare*/
structure SocialInsurancePrograms_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure DisabilityTypeCodes
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Student status of a person*/
structure StudentStatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
effectiveDate: string
structure IdentityDocuments
/**A identifier of the document*/
documentID: string
/**Country with which the associated document is associated. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**The type of document.*/
typeCode: reference IdentityDocuments_typeCode_TypeCode
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
issuingParty: reference IssuingParty
/**The issue date of the related identity document. Follows the ISO-8601:2000 format.*/
issueDate: string
/**The expiration date of the identity document. Follows the ISO-8601:2000 format.*/
expirationDate: string
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of document.*/
structure IdentityDocuments_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
structure IssuingParty
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference IssuingParty_nameCode_NameCode
/**The address of the party*/
address: reference Address
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure IssuingParty_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The address of the party*/
structure Address
/**A descriptive coded name of the address*/
nameCode: reference Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
structure ImmigrationDocuments
/**The length of time the holder of the visa is permitted to stay in the issuing country. Follows the ISO-8601:2000 format*/
authorizedStayDuration: string
/**The length of time the holder of the visa must wait before re-entering the issuing country, following the expiration of the visa. Follows the ISO-8601:2000 format*/
reentryRequirementDuration: string
/**A identifier of the document*/
documentID: string
/**Country with which the associated document is associated. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**The type of document.*/
typeCode: reference ImmigrationDocuments_typeCode_TypeCode
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
issuingParty: reference ImmigrationDocuments_issuingParty_IssuingParty
/**The issue date of the related identity document. Follows the ISO-8601:2000 format.*/
issueDate: string
/**The expiration date of the identity document. Follows the ISO-8601:2000 format.*/
expirationDate: string
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of document.*/
structure ImmigrationDocuments_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
structure ImmigrationDocuments_issuingParty_IssuingParty
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference ImmigrationDocuments_issuingParty_IssuingParty_nameCode_NameCode
/**The address of the party*/
address: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure ImmigrationDocuments_issuingParty_IssuingParty_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The address of the party*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address
/**A descriptive coded name of the address*/
nameCode: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference ImmigrationDocuments_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure ImmigrationDocuments_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
structure Passports
/**A identifier of the document*/
documentID: string
/**Country with which the associated document is associated. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**The type of document.*/
typeCode: reference Passports_typeCode_TypeCode
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
issuingParty: reference Passports_issuingParty_IssuingParty
/**The issue date of the related identity document. Follows the ISO-8601:2000 format.*/
issueDate: string
/**The expiration date of the identity document. Follows the ISO-8601:2000 format.*/
expirationDate: string
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of document.*/
structure Passports_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
structure Passports_issuingParty_IssuingParty
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference Passports_issuingParty_IssuingParty_nameCode_NameCode
/**The address of the party*/
address: reference Passports_issuingParty_IssuingParty_address_Address
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure Passports_issuingParty_IssuingParty_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The address of the party*/
structure Passports_issuingParty_IssuingParty_address_Address
/**A descriptive coded name of the address*/
nameCode: reference Passports_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference Passports_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference Passports_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference Passports_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference Passports_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference Passports_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure Passports_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure Passports_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure Passports_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure Passports_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure Passports_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure Passports_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
structure WorkAuthorizationDocuments
/**A identifier of the document*/
documentID: string
/**Country with which the associated document is associated. ISO_3166-1-alpha-2 code list*/
countryCode: string
/**The type of document.*/
typeCode: reference WorkAuthorizationDocuments_typeCode_TypeCode
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
issuingParty: reference WorkAuthorizationDocuments_issuingParty_IssuingParty
/**The issue date of the related identity document. Follows the ISO-8601:2000 format.*/
issueDate: string
/**The expiration date of the identity document. Follows the ISO-8601:2000 format.*/
expirationDate: string
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of document.*/
structure WorkAuthorizationDocuments_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An agency, bureau, or other organization issuing an associated identifier, license, or certificate; the body or persons exercising power or command. An issuing authority often is a government agency or official authority, but sometimes might be a private organization*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_nameCode_NameCode
/**The address of the party*/
address: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The address of the party*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address
/**A descriptive coded name of the address*/
nameCode: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure WorkAuthorizationDocuments_issuingParty_IssuingParty_address_Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
/**The preferred name of the person in the associated context. A preferred name is often a variation on the current name that that the person has indicated as preferred. It is the full name by which the person wishes to be known within the context of the organization.*/
structure PreferredName
/**The first name of the person*/
givenName: string
/**Person middle name or initial*/
middleName: string
/**Person family name 1*/
familyName1: string
/**Person family name 2*/
familyName2: string
/**A formatted version of the person name*/
formattedName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference PreferredName_nameCode_NameCode
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference PreferredName_scriptCode_ScriptCode
/**A list of preferred salutations*/
preferredSalutations: reference PreferredName_preferredSalutations_PreferredSalutations*
/**A preferred name, e.g. a nickname*/
nickName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
generationAffixCode: reference PreferredName_generationAffixCode_GenerationAffixCode
/**The qualification affix of the person name*/
qualificationAffixCode: reference PreferredName_qualificationAffixCode_QualificationAffixCode
/**Person titles*/
titleAffixCodes: reference PreferredName_titleAffixCodes_TitleAffixCodes*
/**Person family name pre-fix*/
familyName1Prefix: string
/**Person family name pre-fix*/
familyName2Prefix: string
/**Person initials*/
initials: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure PreferredName_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
structure PreferredName_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A preferred salutation, e.g. Mr., Dr., etc.*/
structure PreferredName_preferredSalutations_PreferredSalutations
/**The saluation code*/
salutationCode: reference PreferredName_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The type of salutation, e.g. Professional, Social*/
typeCode: reference PreferredName_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The sequence or order of the salutation*/
sequenceNumber: integer
/**The saluation code*/
structure PreferredName_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of salutation, e.g. Professional, Social*/
structure PreferredName_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
structure PreferredName_generationAffixCode_GenerationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The qualification affix of the person name*/
structure PreferredName_qualificationAffixCode_QualificationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person titles*/
structure PreferredName_titleAffixCodes_TitleAffixCodes
/**The title affix of the person name*/
affixCode: reference PreferredName_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The sequence or order of the title*/
sequenceNumber: integer
/**The title affix of the person name*/
structure PreferredName_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure FormerNames
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference FormerNames_nameCode_NameCode
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference FormerNames_scriptCode_ScriptCode
/**A list of preferred salutations*/
preferredSalutations: reference FormerNames_preferredSalutations_PreferredSalutations*
/**A preferred name, e.g. a nickname*/
nickName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
generationAffixCode: reference FormerNames_generationAffixCode_GenerationAffixCode
/**The qualification affix of the person name*/
qualificationAffixCode: reference FormerNames_qualificationAffixCode_QualificationAffixCode
/**Person titles*/
titleAffixCodes: reference FormerNames_titleAffixCodes_TitleAffixCodes*
/**Person family name pre-fix*/
familyName1Prefix: string
/**Person family name pre-fix*/
familyName2Prefix: string
/**Person initials*/
initials: string
/**The first name of the person*/
givenName: string
/**Person middle name or initial*/
middleName: string
/**Person family name 1*/
familyName1: string
/**Person family name 2*/
familyName2: string
/**A formatted version of the person name*/
formattedName: string
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of former name, e.g. pre-union or legal*/
typeCode: reference FormerNames_typeCode_TypeCode
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure FormerNames_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
structure FormerNames_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A preferred salutation, e.g. Mr., Dr., etc.*/
structure FormerNames_preferredSalutations_PreferredSalutations
/**The saluation code*/
salutationCode: reference FormerNames_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The type of salutation, e.g. Professional, Social*/
typeCode: reference FormerNames_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The sequence or order of the salutation*/
sequenceNumber: integer
/**The saluation code*/
structure FormerNames_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of salutation, e.g. Professional, Social*/
structure FormerNames_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
structure FormerNames_generationAffixCode_GenerationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The qualification affix of the person name*/
structure FormerNames_qualificationAffixCode_QualificationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person titles*/
structure FormerNames_titleAffixCodes_TitleAffixCodes
/**The title affix of the person name*/
affixCode: reference FormerNames_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The sequence or order of the title*/
sequenceNumber: integer
/**The title affix of the person name*/
structure FormerNames_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of former name, e.g. pre-union or legal*/
structure FormerNames_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The birth name of the person in the associated context*/
structure BirthName
/**The first name of the person*/
givenName: string
/**Person middle name or initial*/
middleName: string
/**Person family name 1*/
familyName1: string
/**Person family name 2*/
familyName2: string
/**A formatted version of the person name*/
formattedName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference BirthName_nameCode_NameCode
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference BirthName_scriptCode_ScriptCode
/**A list of preferred salutations*/
preferredSalutations: reference BirthName_preferredSalutations_PreferredSalutations*
/**A preferred name, e.g. a nickname*/
nickName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
generationAffixCode: reference BirthName_generationAffixCode_GenerationAffixCode
/**The qualification affix of the person name*/
qualificationAffixCode: reference BirthName_qualificationAffixCode_QualificationAffixCode
/**Person titles*/
titleAffixCodes: reference BirthName_titleAffixCodes_TitleAffixCodes*
/**Person family name pre-fix*/
familyName1Prefix: string
/**Person family name pre-fix*/
familyName2Prefix: string
/**Person initials*/
initials: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure BirthName_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the name is in. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with inital letter capitalized. For example, Cyrillic is Cyrl*/
structure BirthName_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A preferred salutation, e.g. Mr., Dr., etc.*/
structure BirthName_preferredSalutations_PreferredSalutations
/**The saluation code*/
salutationCode: reference BirthName_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The type of salutation, e.g. Professional, Social*/
typeCode: reference BirthName_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The sequence or order of the salutation*/
sequenceNumber: integer
/**The saluation code*/
structure BirthName_preferredSalutations_PreferredSalutations_salutationCode_SalutationCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of salutation, e.g. Professional, Social*/
structure BirthName_preferredSalutations_PreferredSalutations_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The generational affix of the person name, e.g. Jr, Sr*/
structure BirthName_generationAffixCode_GenerationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The qualification affix of the person name*/
structure BirthName_qualificationAffixCode_QualificationAffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person titles*/
structure BirthName_titleAffixCodes_TitleAffixCodes
/**The title affix of the person name*/
affixCode: reference BirthName_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The sequence or order of the title*/
sequenceNumber: integer
/**The title affix of the person name*/
structure BirthName_titleAffixCodes_TitleAffixCodes_affixCode_AffixCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The place a person was born. This can have taxation impacts*/
structure BirthPlace
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference BirthPlace_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference BirthPlace_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**TODO - The string of characters used to identify the postal code*/
postalCode: reference PostalCode
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**A formatted version of the place where a person is born.*/
formattedBirthPlace: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure BirthPlace_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure BirthPlace_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**TODO - The string of characters used to identify the postal code*/
structure PostalCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure OtherPersonalAddresses
/**This indicator is used to support the ability to say that one address is the same as another. For example, the address of a dependent is the same as that of a worker. If a given system supports this functionality, this field should be present and set to true. The meta component associated to an event that allows for the adding or changing of an address, should use the links array associated to the indicator to define the list of addresses from which the user can select to set the address in context to be the same as.*/
sameAsAddressIndicator: boolean
/**This link is used in conjunction with the sameAsAddressIndicator. If a given system support same as address functionality, this link will point to the address that a user has selected as being the same as the one in context. For example, if the address in context is a dependent address, and the user has indicated that the dependent address is the same as the legal address of the worker, this link would point to worker/id/person/legalAddress.*/
sameAsAddressLink: reference OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink
/**A descriptive coded name of the address*/
nameCode: reference OtherPersonalAddresses_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference OtherPersonalAddresses_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference OtherPersonalAddresses_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference OtherPersonalAddresses_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference OtherPersonalAddresses_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference OtherPersonalAddresses_geoCoordinate_GeoCoordinate
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of the related address entity*/
typeCode: reference OtherPersonalAddresses_typeCode_TypeCode
/**This link is used in conjunction with the sameAsAddressIndicator. If a given system support same as address functionality, this link will point to the address that a user has selected as being the same as the one in context. For example, if the address in context is a dependent address, and the user has indicated that the dependent address is the same as the legal address of the worker, this link would point to worker/id/person/legalAddress.*/
structure OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string OtherPersonalAddresses_sameAsAddressLink_SameAsAddressLink_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A descriptive coded name of the address*/
structure OtherPersonalAddresses_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure OtherPersonalAddresses_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure OtherPersonalAddresses_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure OtherPersonalAddresses_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure OtherPersonalAddresses_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure OtherPersonalAddresses_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
/**The type of the related address entity*/
structure OtherPersonalAddresses_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An ethnic group is a group that regards itself or is regarded by others as a distinct community by virtue of certain characteristics that will help to distinguish the group from the surrounding community. Ethnicity is considered to be shared characteristics such as culture, language, religion, and traditions, which contribute to the identify of a person or group*/
structure EthnicityCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Race is a classification system used to categorize humans into large and distinct populations or groups by heritable phenotypic characteristics, geographic ancestry, culture, history, language, physical appearance, ethnicity, and social status*/
structure RaceCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The method by which the associated data is collected or associated with the given person. Generally the values are self-identification or self-reporting,and observer-reporting*/
identificationMethodCode: reference IdentificationMethodCode
/**The method by which the associated data is collected or associated with the given person. Generally the values are self-identification or self-reporting,and observer-reporting*/
structure IdentificationMethodCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure CitizenshipCountryCodes
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure ResidencyCountryCodes
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The highest level of education acheived by a given person.*/
structure HighestEducationLevelCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Person military status, e.g. Active, Active Reserve, etc*/
structure MilitaryStatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
effectiveDate: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure MilitaryClassificationCodes
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
structure Person_customFieldGroup_CustomFieldGroup
/**A list of custom amounts*/
amountFields: reference AmountFields*
/**A list of custom codes*/
codeFields: reference CodeFields*
/**A list of custom dates*/
dateFields: reference DateFields*
/**A list of custom datetimes*/
dateTimeFields: reference DateTimeFields*
/**A list of custom indicators*/
indicatorFields: reference IndicatorFields*
/**A list of custom numbers*/
numberFields: reference NumberFields*
/**A list of custom percentages*/
percentFields: reference PercentFields*
/**A list of custom strings*/
stringFields: reference StringFields*
/**A list of custom telephone numbers*/
telephoneFields: reference TelephoneFields*
links: reference Person_customFieldGroup_CustomFieldGroup_links_Links*
structure AmountFields
/**The monetary value of the object in which the amount is associated*/
amountValue: float
/**List of standard currency codes ISO 4212*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AmountFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AmountFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CodeFields
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CodeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CodeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CodeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CodeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure DateFields
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
dateValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference DateFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference DateFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure DateFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure DateFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure DateTimeFields
/**The string reprersentation of the date-time value. Follows the ISO-8601:2000 format.*/
dateTimeValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference DateTimeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference DateTimeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure DateTimeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure DateTimeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure IndicatorFields
/**Boolean expression*/
indicatorValue: boolean
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference IndicatorFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference IndicatorFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure IndicatorFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure IndicatorFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure NumberFields
/**A custom number*/
numberValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference NumberFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference NumberFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure NumberFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure NumberFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure PercentFields
/**The percentage value*/
percentValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference PercentFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference PercentFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure PercentFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure PercentFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure StringFields
/**A custom string*/
stringValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference StringFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference StringFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure StringFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure StringFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure TelephoneFields
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference TelephoneFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference TelephoneFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure TelephoneFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure TelephoneFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure Person_customFieldGroup_CustomFieldGroup_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: Person_customFieldGroup_CustomFieldGroup_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": Person_customFieldGroup_CustomFieldGroup_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": Person_customFieldGroup_CustomFieldGroup_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: Person_customFieldGroup_CustomFieldGroup_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string Person_customFieldGroup_CustomFieldGroup_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string Person_customFieldGroup_CustomFieldGroup_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string Person_customFieldGroup_CustomFieldGroup_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string Person_customFieldGroup_CustomFieldGroup_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure Person_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: Person_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": Person_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": Person_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: Person_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string Person_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string Person_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string Person_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string Person_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**These dates are related to the highest level legal relationship that a person has with the organization. If a given worker has multiple relationships with the organization, these are the dates associated with the primary relationship.*/
structure WorkerDates
/**The date the worker is first hired into an organization. Follows the ISO-8601:2000 format*/
originalHireDate: string
/**The date the worker is rehired into an organization. If there are multiple dates of rehire, this is the most current. Follows the ISO-8601:2000 format*/
rehireDate: string
/**A date related to the length of time a worker works in a given work assignment which usually factors into eligibility for various types of benefits. It is generally adjusted for workers that leave the organization and are later rehired. Follows the ISO-8601:2000 format*/
adjustedServiceDate: string
/**The date the worker was aquired via a merger or acquisition. Follows the ISO-8601:2000 format*/
acquisitionDate: string
/**The date an employee is terminated. Follows the ISO-8601:2000 format*/
retirementDate: string
/**The date an employee is terminated. Follows the ISO-8601:2000 format*/
terminationDate: string
/**The status of the worker in the organization at the highest level. If a given worker has multiple relationships with the organization, this is the status that arches over all those relationships*/
structure WorkerStatus
/**The status of the work assignment, e.g. active, inactive*/
"statusCode": reference WorkerStatus_statusCode_StatusCode
/**The reason associated to the correlating status, e.g. new hire, rehire, termination, etc.*/
reasonCode: reference ReasonCode
/**The effective date of the related entity. Follows the ISO-8601:2000 format*/
effectiveDate: string
/**The status of the work assignment, e.g. active, inactive*/
structure WorkerStatus_statusCode_StatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The reason associated to the correlating status, e.g. new hire, rehire, termination, etc.*/
structure ReasonCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure Photos
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference Photos_nameCode_NameCode
links: reference Photos_links_Links*
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure Photos_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure Photos_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: Photos_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": Photos_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": Photos_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: Photos_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string Photos_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string Photos_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string Photos_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string Photos_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A container of communication mechanisms.*/
structure BusinessCommunication
/**A list of land-line telephone numbers*/
landlines: reference BusinessCommunication_landlines_Landlines*
/**A list of mobile telephone numbers*/
mobiles: reference BusinessCommunication_mobiles_Mobiles*
/**A list of fax telephone numbers*/
faxes: reference BusinessCommunication_faxes_Faxes*
/**A list of pager telephone numbers*/
pagers: reference BusinessCommunication_pagers_Pagers*
/**A list of email addresses*/
emails: reference BusinessCommunication_emails_Emails*
/**A list of internet URIs*/
internetAddresses: reference BusinessCommunication_internetAddresses_InternetAddresses*
/**A list of instant messages URIs*/
instantMessages: reference BusinessCommunication_instantMessages_InstantMessages*
/**A list of social networks addresses*/
socialNetworks: reference BusinessCommunication_socialNetworks_SocialNetworks*
structure BusinessCommunication_landlines_Landlines
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_landlines_Landlines_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_landlines_Landlines_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_mobiles_Mobiles
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_mobiles_Mobiles_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_mobiles_Mobiles_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_faxes_Faxes
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_faxes_Faxes_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_faxes_Faxes_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_pagers_Pagers
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_pagers_Pagers_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_pagers_Pagers_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_emails_Emails
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_emails_Emails_nameCode_NameCode
/**The URI of the associated email address*/
emailUri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_emails_Emails_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_internetAddresses_InternetAddresses
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_instantMessages_InstantMessages
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_instantMessages_InstantMessages_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_instantMessages_InstantMessages_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure BusinessCommunication_socialNetworks_SocialNetworks
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference BusinessCommunication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure BusinessCommunication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An object describing the details of a work assignment. A work assignment pertains to the duties and responsibilities that should be performed by the worker*/
structure WorkAssignments
/**Indicates the primary work assignment*/
primaryIndicator: boolean
/**The date a worker is extended an offer for a work assignment. Follows the ISO-8601:2000 format*/
offerExtensionDate: string
/**The date a worker accepts an offer for a work assignment. Follows the ISO-8601:2000 format*/
offerAcceptanceDate: string
/**The date the worker is hired into a work assignment. Follows the ISO-8601:2000 format*/
hireDate: string
/**A date related to the length of time a worker works in a given work assignment or job. This is sometimes tracked at the work assignment level in support of union contracts. Follows the ISO-8601:2000 format*/
seniorityDate: string
/**The date the worker is expected to show up for work. Follows the ISO-8601:2000 format*/
expectedStartDate: string
/**The date the worker actually shows up for work. Follows the ISO-8601:2000 format*/
actualStartDate: string
/**The date the worker stops working in a given work assignment. Follows the ISO-8601:2000 format*/
terminationDate: string
/**The status of the work assignment*/
assignmentStatus: reference AssignmentStatus
/**This describes the type of the worker in a given work assignment, e.g. permanent employee, fixed term employee, apprentice, vendor employee, volunteer, apprentice, independent contractor, etc.*/
workerTypeCode: reference WorkerTypeCode
/**This describes whether a work assignment has a known end date. If the assignment does not have a scheduled or known end date, it is considerd a regular or permanent assignment. If an assignment has a known or scheduled end date, it is considered a temporary or fixed term assignment*/
assignmentTermCode: reference AssignmentTermCode
/**The work level code, e.g. Fulltime, Parttime*/
workLevelCode: reference WorkLevelCode
/**A code classifying the status of an employee or other resource as one of the following - Domestic - A person who resides in the same country in which the employer is based. Inpatriate - An employee of a multinational company who is from a foreign country but transferred from a foreign subdivision to the home country of the corporation. Expatriate - An employee or resource involved in the foreign-based operations of an employer who is a national or who regularly resides within the base country of the employer. Third-Party National - An employee involved in the foreign-based operations of an employer who is not a national of the country where the operations nor the base country of the employer. Local National - An employee involved in the foreign-based operations of an employer who is a national or who regularly resides in the country where those operations are based. Detached - Employees working in another country who do not have the status of expatriate (In France, for example, when the length of the expatriation is less than 2 years)*/
nationalityContextCode: reference NationalityContextCode
/**Indicates whether a worker has status as a VIP within a particular context. This may be used to determine benefit plan participation or to afford VIPs expedited services or special handling*/
vipIndicator: boolean
/**The type of VIP*/
vipTypeCode: reference VipTypeCode
/**Indicates whether the worker is classified as an executive. This may be used to identify applicable benefits and compensation programs*/
executiveIndicator: boolean
/**The type of executive*/
executiveTypeCode: reference ExecutiveTypeCode
/**Indicates whether the worker is classified as an officer. This may be used to track regulatory compliance*/
officerIndicator: boolean
/**The type of officer.*/
officerTypeCode: reference OfficerTypeCode
/**Indicates whether the worker is classifier as highly compensated. This may be used by regulatory bodies to determine appropriate tax program assignments*/
highlyCompensatedIndicator: boolean
/**The type of highly compensated worker.*/
highlyCompensatedTypeCode: reference HighlyCompensatedTypeCode
/**Indicates whether the worker is a stock owner. This may be used by regulatory bodies for tax purposes or for statutory reporting*/
stockOwnerIndicator: boolean
/**The percentage of stock ownership*/
stockOwnerPercentage: float
/**A list of worker groups*/
workerGroups: reference WorkerGroups*
/**The job code*/
jobCode: reference JobCode
/**The job title*/
jobTitle: string
/**A reference to a system used to classify workers into occupational categories for the purpose of collecting, calculating, or disseminating data. In the US, an example of this is the EEOC system; in the UK, an example of this is the SOC system. This is the at the assignment level in France*/
occupationalClassifications: reference OccupationalClassifications*
/**A code indicating whether the work assignment is covered under applicable wage and labor laws relating to working hours, overtime, and similar protections, e.g. FLSA in the US*/
wageLawCoverage: reference WageLawCoverage
/**The position identifier*/
positionID: string
/**The position title*/
positionTitle: string
/**The associated labor union*/
laborUnion: reference LaborUnion
/**The associated bargaining unit (local labor union)*/
bargainingUnit: reference BargainingUnit
/**A work shift*/
workShiftCode: reference WorkShiftCode
/**A work arrangement describes the time and place that work gets done on a regular basis. For example, a work assignment can be fully office based, fully field based, fully home based, or some combination thereof*/
workArrangementCode: reference WorkArrangementCode
/**The standard number of hours of work associated to a position, typically used to drive the definition of a full time assignment, e.g. 40 in the US, 37.5 in the UK, 35 in FR. This number is usually expressed based on a week. The unitCode is used to convey that measurement*/
standardHours: reference StandardHours
/**Full-time equivalent (FTE) is a unit that indicates the workload of an employed person (or student) in a way that makes workloads comparable across various contexts. FTE is often used to measure the involvement of a worker in a project, or to track cost reductions in an organization. An FTE of 1.0 means that the person is equivalent to a full-time worker, while an FTE of 0.5 signals that the worker is only half-time*/
fullTimeEquivalenceRatio: float
/**A list of the various types of home organizational units*/
homeOrganizationalUnits: reference HomeOrganizationalUnits*
/**A list of organizational units*/
assignedOrganizationalUnits: reference AssignedOrganizationalUnits*
/**The home work location is the location out of which the work assignment is based. It does not necessarily mean that the worker is physically located in that location. This data becomes relevant for affirmative action reasons. In the US for example, if a worker works from home or a location where there is not an EEO-1 form/location, then the worker is accounted for based on the location of the reports to manager or work unit. Additionally, other things like market salaries, taxes, etc. would be aligned to home office location*/
homeWorkLocation: reference HomeWorkLocation
/**A list of work locations*/
assignedWorkLocations: reference AssignedWorkLocations*
/**The remuneration basis code is a way of classifying a work assignment as salaried, salaried plus commission, commission only, hourly or daily*/
remunerationBasisCode: reference RemunerationBasisCode
/**Describes how often the payee is paid*/
payCycleCode: reference PayCycleCode
/**The standard number of hours per pay period*/
standardPayPeriodHours: reference StandardPayPeriodHours
/**The base or primary pay (i.e. salary, wage) associated to a work assignment. The structure allows for the explicit communication of pre-defined equivalents for the base remuneration*/
baseRemuneration: reference BaseRemuneration
/**A list of pay compensations associated to a given work assignment. Additional remuneration includes all other forms of compensation beyond the base pay associated to a given work assignment. The typeCode is used to further refine the type of compensation, e.g. bonus, commission, etc.*/
additionalRemunerations: reference AdditionalRemunerations*
/**A reference list of workers to whom a given worker reports*/
reportsTo: reference ReportsTo*
/**The status of the worker in the payroll system*/
payrollProcessingStatusCode: reference PayrollProcessingStatusCode
/**The payroll group relevant to payroll processing for this work assignment*/
payrollGroupCode: string
/**The payroll file number*/
payrollFileNumber: string
/**The region in which the payroll is processed*/
payrollRegionCode: string
/**A pay scale is a graded compensation system that determines how much a worker is to be paid as a wage or salary, e.g. the General Schedule used to pay US civil servants, the U.S. uniformed services pay grades and the salary grades by which United States military personnel are paid are paid*/
payScaleCode: reference PayScaleCode
/**A pay grade is a breakdown of a pay scale that is used to manage the compensation of a worker by providing a a fixed framework of salary or wage ranges, as opposed to a free negotiation*/
payGradeCode: reference PayGradeCode
/**The pay range of the pay grade*/
payGradePayRange: reference PayGradePayRange
/**Compa-ratio is the mathematical relationship between the average actual salaries within a pay grade range and the midpoint of that range. It is used to understand how a worker is paid relative to the market-rate for comparable jobs*/
compaRatio: float
/**The pay step code*/
payGradeStepCode: reference PayGradeStepCode
/**The rate associated with the pay step*/
payGradeStepPayRate: reference PayGradeStepPayRate
/**The date of the related entity. Data Representation Standard: Temporal Data Specification which follows the ISO-8601:2000 format*/
nextPayGradeStepDate: string
/**Indicates the minimum amount of time a worker must remain in a given pay step before*/
minimumPayGradeStepDuration: string
/**A geographic pay differential is additional compensation paid to a worker to account for variations in cost of labor or cost of living based on location and is expected to be communicated as an additional remuneration. This is a coded field that is associated to a percent that drives the calculation of that additional compensation. It is also used to modify the pay range associated to the pay grade in order to apply the appropriate adjustments to the compa ratio*/
geographicPayDifferentialCode: reference GeographicPayDifferentialCode
/**A geographic pay differential is additional compensation paid to a worker to account for variations in cost of labor or cost of living based on location and is expected to be communicated as an additional remuneration. This is a percent value that drives the calculation of that additional compensation. It is also used to modify the pay range associated to the pay grade in order to apply the appropriate adjustments to the compa ratio*/
geographicPayDifferentialPercentage: float
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
customFieldGroup: reference WorkAssignments_customFieldGroup_CustomFieldGroup
links: reference WorkAssignments_links_Links*
/**A unique identifier of a work assignment*/
itemID: string
/**The status of the work assignment*/
structure AssignmentStatus
/**The status of the work assignment, e.g. active, inactive*/
"statusCode": reference AssignmentStatus_statusCode_StatusCode
/**The reason associated to the correlating status, e.g. new hire, rehire, termination, etc.*/
reasonCode: reference AssignmentStatus_reasonCode_ReasonCode
/**The effective date of the related entity. Follows the ISO-8601:2000 format*/
effectiveDate: string
/**The status of the work assignment, e.g. active, inactive*/
structure AssignmentStatus_statusCode_StatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The reason associated to the correlating status, e.g. new hire, rehire, termination, etc.*/
structure AssignmentStatus_reasonCode_ReasonCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**This describes the type of the worker in a given work assignment, e.g. permanent employee, fixed term employee, apprentice, vendor employee, volunteer, apprentice, independent contractor, etc.*/
structure WorkerTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**This describes whether a work assignment has a known end date. If the assignment does not have a scheduled or known end date, it is considerd a regular or permanent assignment. If an assignment has a known or scheduled end date, it is considered a temporary or fixed term assignment*/
structure AssignmentTermCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The work level code, e.g. Fulltime, Parttime*/
structure WorkLevelCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A code classifying the status of an employee or other resource as one of the following - Domestic - A person who resides in the same country in which the employer is based. Inpatriate - An employee of a multinational company who is from a foreign country but transferred from a foreign subdivision to the home country of the corporation. Expatriate - An employee or resource involved in the foreign-based operations of an employer who is a national or who regularly resides within the base country of the employer. Third-Party National - An employee involved in the foreign-based operations of an employer who is not a national of the country where the operations nor the base country of the employer. Local National - An employee involved in the foreign-based operations of an employer who is a national or who regularly resides in the country where those operations are based. Detached - Employees working in another country who do not have the status of expatriate (In France, for example, when the length of the expatriation is less than 2 years)*/
structure NationalityContextCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of VIP*/
structure VipTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of executive*/
structure ExecutiveTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of officer.*/
structure OfficerTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of highly compensated worker.*/
structure HighlyCompensatedTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkerGroups
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference WorkerGroups_nameCode_NameCode
/**The value of the group code*/
groupCode: reference GroupCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure WorkerGroups_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The value of the group code*/
structure GroupCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The job code*/
structure JobCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure OccupationalClassifications
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference OccupationalClassifications_nameCode_NameCode
/**The classification code of the associated entity.*/
classificationCode: reference ClassificationCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure OccupationalClassifications_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The classification code of the associated entity.*/
structure ClassificationCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A code indicating whether the work assignment is covered under applicable wage and labor laws relating to working hours, overtime, and similar protections, e.g. FLSA in the US*/
structure WageLawCoverage
/**A coded name or descriptive label of the associated wage law entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
wageLawNameCode: reference WageLawNameCode
/**The wage hour coverage code, e.g. exempt, non-exempt*/
coverageCode: reference CoverageCode
/**A coded name or descriptive label of the associated wage law entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure WageLawNameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The wage hour coverage code, e.g. exempt, non-exempt*/
structure CoverageCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The associated labor union*/
structure LaborUnion
/**The code of the associated labor union*/
laborUnionCode: reference LaborUnionCode
/**The seniority date of the worker in the labor union. Follows the ISO-8601:2000 format*/
seniorityDate: string
/**The code of the associated labor union*/
structure LaborUnionCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The associated bargaining unit (local labor union)*/
structure BargainingUnit
/**A bargaining unit is a group of employees who are so grouped for the purpose of collective bargaining. A bargaining unit is also known as a local labor union.*/
bargainingUnitCode: reference BargainingUnitCode
/**The seniority date of the worker in the bargaining unit. Follows the ISO-8601:2000 format*/
seniorityDate: string
/**A bargaining unit is a group of employees who are so grouped for the purpose of collective bargaining. A bargaining unit is also known as a local labor union.*/
structure BargainingUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A work shift*/
structure WorkShiftCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A work arrangement describes the time and place that work gets done on a regular basis. For example, a work assignment can be fully office based, fully field based, fully home based, or some combination thereof*/
structure WorkArrangementCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The standard number of hours of work associated to a position, typically used to drive the definition of a full time assignment, e.g. 40 in the US, 37.5 in the UK, 35 in FR. This number is usually expressed based on a week. The unitCode is used to convey that measurement*/
structure StandardHours
/**The number of hours*/
hoursQuantity: float
/**The unit associated to the number of hours, e.g. week.*/
unitCode: reference UnitCode
/**The unit associated to the number of hours, e.g. week.*/
structure UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The HOME organizational unit defines the work assignment and perhaps funds it. The should only be one home organizational unit for a given type, e.g. only one home department.*/
structure HomeOrganizationalUnits
/**A coded name or descriptive label of the associated organizational unit entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference HomeOrganizationalUnits_nameCode_NameCode
/**The organizational unit code and description, e.g. department code.*/
typeCode: reference HomeOrganizationalUnits_typeCode_TypeCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated organizational unit entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure HomeOrganizationalUnits_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The organizational unit code and description, e.g. department code.*/
structure HomeOrganizationalUnits_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The ASSIGNED organizational unit is one for which the work assignment is doing work*/
structure AssignedOrganizationalUnits
/**A coded name or descriptive label of the associated organizational unit entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference AssignedOrganizationalUnits_nameCode_NameCode
/**The organizational unit code and description, e.g. department code.*/
typeCode: reference AssignedOrganizationalUnits_typeCode_TypeCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated organizational unit entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure AssignedOrganizationalUnits_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The organizational unit code and description, e.g. department code.*/
structure AssignedOrganizationalUnits_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The home work location is the location out of which the work assignment is based. It does not necessarily mean that the worker is physically located in that location. This data becomes relevant for affirmative action reasons. In the US for example, if a worker works from home or a location where there is not an EEO-1 form/location, then the worker is accounted for based on the location of the reports to manager or work unit. Additionally, other things like market salaries, taxes, etc. would be aligned to home office location*/
structure HomeWorkLocation
/**The location type code and description, e.g. HDQ, headquarters*/
nameCode: reference HomeWorkLocation_nameCode_NameCode
/**Communication objects to include various communication mechanisms, e,g, phone, email, etc.*/
communication: reference HomeWorkLocation_communication_Communication
/**The list of other names, by which a location is known*/
aliasNames: reference AliasNames*
/**An address related to the associated entity*/
address: reference HomeWorkLocation_address_Address
/**The location type code and description, e.g. HDQ, headquarters*/
structure HomeWorkLocation_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Communication objects to include various communication mechanisms, e,g, phone, email, etc.*/
structure HomeWorkLocation_communication_Communication
/**A list of land-line telephone numbers*/
landlines: reference HomeWorkLocation_communication_Communication_landlines_Landlines*
/**A list of mobile telephone numbers*/
mobiles: reference HomeWorkLocation_communication_Communication_mobiles_Mobiles*
/**A list of fax telephone numbers*/
faxes: reference HomeWorkLocation_communication_Communication_faxes_Faxes*
/**A list of pager telephone numbers*/
pagers: reference HomeWorkLocation_communication_Communication_pagers_Pagers*
/**A list of email addresses*/
emails: reference HomeWorkLocation_communication_Communication_emails_Emails*
/**A list of internet URIs*/
internetAddresses: reference HomeWorkLocation_communication_Communication_internetAddresses_InternetAddresses*
/**A list of instant messages URIs*/
instantMessages: reference HomeWorkLocation_communication_Communication_instantMessages_InstantMessages*
/**A list of social networks addresses*/
socialNetworks: reference HomeWorkLocation_communication_Communication_socialNetworks_SocialNetworks*
structure HomeWorkLocation_communication_Communication_landlines_Landlines
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_landlines_Landlines_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_landlines_Landlines_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_mobiles_Mobiles
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_mobiles_Mobiles_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_mobiles_Mobiles_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_faxes_Faxes
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_faxes_Faxes_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_faxes_Faxes_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_pagers_Pagers
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_pagers_Pagers_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_pagers_Pagers_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_emails_Emails
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_emails_Emails_nameCode_NameCode
/**The URI of the associated email address*/
emailUri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_emails_Emails_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_internetAddresses_InternetAddresses
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_instantMessages_InstantMessages
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_instantMessages_InstantMessages_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_instantMessages_InstantMessages_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure HomeWorkLocation_communication_Communication_socialNetworks_SocialNetworks
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference HomeWorkLocation_communication_Communication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure HomeWorkLocation_communication_Communication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure AliasNames
/**The code for the related entity, e.g. division, region, district*/
typeCode: reference AliasNames_typeCode_TypeCode
/**The name for the related location*/
nameValue: string
/**The code for the related entity, e.g. division, region, district*/
structure AliasNames_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An address related to the associated entity*/
structure HomeWorkLocation_address_Address
/**A descriptive coded name of the address*/
nameCode: reference HomeWorkLocation_address_Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference HomeWorkLocation_address_Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference HomeWorkLocation_address_Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference HomeWorkLocation_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference HomeWorkLocation_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference HomeWorkLocation_address_Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure HomeWorkLocation_address_Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure HomeWorkLocation_address_Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure HomeWorkLocation_address_Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure HomeWorkLocation_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure HomeWorkLocation_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure HomeWorkLocation_address_Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
/**The assigned work location is the location (or locations) where the worker is physically located.*/
structure AssignedWorkLocations
/**The list of other names, by which a location is known*/
aliasNames: reference AssignedWorkLocations_aliasNames_AliasNames*
/**An address related to the associated entity*/
address: reference AssignedWorkLocations_address_Address
/**The location type code and description, e.g. HDQ, headquarters*/
nameCode: reference AssignedWorkLocations_nameCode_NameCode
/**Communication objects to include various communication mechanisms, e,g, phone, email, etc.*/
communication: reference AssignedWorkLocations_communication_Communication
/**The unique identifier of the object in a collection*/
itemID: string
/**The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure AssignedWorkLocations_aliasNames_AliasNames
/**The code for the related entity, e.g. division, region, district*/
typeCode: reference AssignedWorkLocations_aliasNames_AliasNames_typeCode_TypeCode
/**The name for the related location*/
nameValue: string
/**The code for the related entity, e.g. division, region, district*/
structure AssignedWorkLocations_aliasNames_AliasNames_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**An address related to the associated entity*/
structure AssignedWorkLocations_address_Address
/**A descriptive coded name of the address*/
nameCode: reference AssignedWorkLocations_address_Address_nameCode_NameCode
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
scriptCode: reference AssignedWorkLocations_address_Address_scriptCode_ScriptCode
/**Attention of Name*/
attentionOfName: string
/**Care Of Name*/
careOfName: string
/**Line One of Street Address Information*/
lineOne: string
/**Line Two of Street Address Information*/
lineTwo: string
/**Line Three of Street Address Information*/
lineThree: string
/**Line Four of Street Address Information*/
lineFour: string
/**Line Five of Street Address Information*/
lineFive: string
/**The number of a building in the context of a physical address, e.g. House Number*/
buildingNumber: string
/**The name of a building in the context of a physical address, e.g. Rockefeller Center*/
buildingName: string
/**The name the block*/
blockName: string
/**The name of the street*/
streetName: string
/**The type of street, e.g. Lane, Passage, Way*/
streetTypeCode: reference AssignedWorkLocations_address_Address_streetTypeCode_StreetTypeCode
/**A unit in the context of an address, e.g. an Apartment Number or an Office*/
unit: string
/**A floor in the context of an address*/
floor: string
/**A reference to a particular staircase in the context of an address*/
stairCase: string
/**A reference to a particular door in the context of an address. e.g. Apartment Number*/
door: string
/**A post office box*/
postOfficeBox: string
/**A way to identify a specific delivery location, e.g. a mail-stop*/
deliveryPoint: string
/**A way to identify a building plot, e.g. a specific building construction site*/
plotID: string
/**A city in the context of an address*/
cityName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
countrySubdivisionLevel1: reference AssignedWorkLocations_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
countrySubdivisionLevel2: reference AssignedWorkLocations_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The 2 character country code. As per ISO 3166-1 Alpha 2*/
countryCode: string
/**The string of characters used to identify the postal code*/
postalCode: string
/**The coordinates of the location of the address*/
geoCoordinate: reference AssignedWorkLocations_address_Address_geoCoordinate_GeoCoordinate
/**A descriptive coded name of the address*/
structure AssignedWorkLocations_address_Address_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of script the in which the associated entity is represented. Associated codelist is ISO15924-A. Use the alpha-4 representation versus the single digit numeric representation. Format is lowercase with initial letter capitalized. For example, Cyrillic is Cyrl*/
structure AssignedWorkLocations_address_Address_scriptCode_ScriptCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of street, e.g. Lane, Passage, Way*/
structure AssignedWorkLocations_address_Address_streetTypeCode_StreetTypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A country subdivision correlating to a administrative level one level below country. For example, in the United States, this would be a state*/
structure AssignedWorkLocations_address_Address_countrySubdivisionLevel1_CountrySubdivisionLevel1
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**A country subdivision correlating to a administrative level two levels below country. For example, in the United States, this might be a county*/
structure AssignedWorkLocations_address_Address_countrySubdivisionLevel2_CountrySubdivisionLevel2
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of city sub division, e.g. borough, neighborhood*/
subdivisionType: string
/**The coordinates of the location of the address*/
structure AssignedWorkLocations_address_Address_geoCoordinate_GeoCoordinate
/**The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees*/
latitude: float
/**The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees*/
longitude: float
/**The location type code and description, e.g. HDQ, headquarters*/
structure AssignedWorkLocations_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Communication objects to include various communication mechanisms, e,g, phone, email, etc.*/
structure AssignedWorkLocations_communication_Communication
/**A list of land-line telephone numbers*/
landlines: reference AssignedWorkLocations_communication_Communication_landlines_Landlines*
/**A list of mobile telephone numbers*/
mobiles: reference AssignedWorkLocations_communication_Communication_mobiles_Mobiles*
/**A list of fax telephone numbers*/
faxes: reference AssignedWorkLocations_communication_Communication_faxes_Faxes*
/**A list of pager telephone numbers*/
pagers: reference AssignedWorkLocations_communication_Communication_pagers_Pagers*
/**A list of email addresses*/
emails: reference AssignedWorkLocations_communication_Communication_emails_Emails*
/**A list of internet URIs*/
internetAddresses: reference AssignedWorkLocations_communication_Communication_internetAddresses_InternetAddresses*
/**A list of instant messages URIs*/
instantMessages: reference AssignedWorkLocations_communication_Communication_instantMessages_InstantMessages*
/**A list of social networks addresses*/
socialNetworks: reference AssignedWorkLocations_communication_Communication_socialNetworks_SocialNetworks*
structure AssignedWorkLocations_communication_Communication_landlines_Landlines
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_landlines_Landlines_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_landlines_Landlines_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_mobiles_Mobiles
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_mobiles_Mobiles_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_mobiles_Mobiles_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_faxes_Faxes
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_faxes_Faxes_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_faxes_Faxes_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_pagers_Pagers
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_pagers_Pagers_nameCode_NameCode
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_pagers_Pagers_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_emails_Emails
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_emails_Emails_nameCode_NameCode
/**The URI of the associated email address*/
emailUri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_emails_Emails_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_internetAddresses_InternetAddresses
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_internetAddresses_InternetAddresses_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_instantMessages_InstantMessages
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_instantMessages_InstantMessages_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_instantMessages_InstantMessages_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AssignedWorkLocations_communication_Communication_socialNetworks_SocialNetworks
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference AssignedWorkLocations_communication_Communication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The URI of the associated email address*/
uri: string
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure AssignedWorkLocations_communication_Communication_socialNetworks_SocialNetworks_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The remuneration basis code is a way of classifying a work assignment as salaried, salaried plus commission, commission only, hourly or daily*/
structure RemunerationBasisCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Describes how often the payee is paid*/
structure PayCycleCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The standard number of hours per pay period*/
structure StandardPayPeriodHours
/**The number of hours*/
hoursQuantity: float
/**The unit associated to the number of hours, e.g. week.*/
unitCode: reference StandardPayPeriodHours_unitCode_UnitCode
/**The unit associated to the number of hours, e.g. week.*/
structure StandardPayPeriodHours_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The base or primary pay (i.e. salary, wage) associated to a work assignment. The structure allows for the explicit communication of pre-defined equivalents for the base remuneration*/
structure BaseRemuneration
/**The hourly rate amount*/
hourlyRateAmount: reference HourlyRateAmount
/**The daily rate amount*/
dailyRateAmount: reference DailyRateAmount
/**The weekly rate amount*/
weeklyRateAmount: reference WeeklyRateAmount
/**The monthly rate amount*/
monthlyRateAmount: reference MonthlyRateAmount
/**The annual rate amount*/
annualRateAmount: reference AnnualRateAmount
/**The pay period rate amount*/
payPeriodRateAmount: reference PayPeriodRateAmount
/**A percentage rate*/
commissionRatePercentage: reference CommissionRatePercentage
/**The hourly rate amount*/
structure HourlyRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference HourlyRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure HourlyRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The daily rate amount*/
structure DailyRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference DailyRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure DailyRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The weekly rate amount*/
structure WeeklyRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference WeeklyRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure WeeklyRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The monthly rate amount*/
structure MonthlyRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference MonthlyRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure MonthlyRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The annual rate amount*/
structure AnnualRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference AnnualRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure AnnualRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The pay period rate amount*/
structure PayPeriodRateAmount
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference PayPeriodRateAmount_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/** ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure PayPeriodRateAmount_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A percentage rate*/
structure CommissionRatePercentage
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference CommissionRatePercentage_nameCode_NameCode
/**The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the percentageValue would be 20*/
percentageValue: float
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference BaseUnitCode
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure CommissionRatePercentage_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure AdditionalRemunerations
/**The type of additional remuneration, e.g. bonus, commission, etc.*/
typeCode: reference AdditionalRemunerations_typeCode_TypeCode
/**The interval describing how often the remuneration is paid*/
intervalCode: reference IntervalCode
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
nameCode: reference AdditionalRemunerations_nameCode_NameCode
/**Pay rate*/
rate: reference Rate
/**The unique identifier of the object in a collection*/
itemID: string
/**The type of additional remuneration, e.g. bonus, commission, etc.*/
structure AdditionalRemunerations_typeCode_TypeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The interval describing how often the remuneration is paid*/
structure IntervalCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary*/
structure AdditionalRemunerations_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Pay rate*/
structure Rate
/**TThe numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/**List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
unitCode: reference Rate_unitCode_UnitCode
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference Rate_baseUnitCode_BaseUnitCode
/**For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3*/
baseMultiplierValue: float
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
structure Rate_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure Rate_baseUnitCode_BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The work assignment to whom a given worker reports*/
structure ReportsTo
/**A unique identifier of an associate*/
associateOID: string
/**An identifier for a worker, e.g. an Employee ID, a Contractor ID or an Associate ID.*/
workerID: reference ReportsTo_workerID_WorkerID
/**Reports to person name (if reporting to a person)*/
reportsToWorkerName: reference ReportsToWorkerName
/**Reports to relationship*/
reportsToRelationshipCode: reference ReportsToRelationshipCode
/**The unique identifier of the associated position*/
positionID: string
/**The position title*/
positionTitle: string
/**The unique identifier of the object in a collection*/
itemID: string
/**An identifier for a worker, e.g. an Employee ID, a Contractor ID or an Associate ID.*/
structure ReportsTo_workerID_WorkerID
/**An actual ID value*/
idValue: string
/**The scheme code*/
schemeCode: reference ReportsTo_workerID_WorkerID_schemeCode_SchemeCode
/**The scheme code*/
structure ReportsTo_workerID_WorkerID_schemeCode_SchemeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**Reports to person name (if reporting to a person)*/
structure ReportsToWorkerName
/**The first name of the person*/
givenName: string
/**Person middle name or initial*/
middleName: string
/**Person family name 1*/
familyName1: string
/**Person family name 2*/
familyName2: string
/**A formatted version of the person name*/
formattedName: string
/**Reports to relationship*/
structure ReportsToRelationshipCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The status of the worker in the payroll system*/
structure PayrollProcessingStatusCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
effectiveDate: string
/**A pay scale is a graded compensation system that determines how much a worker is to be paid as a wage or salary, e.g. the General Schedule used to pay US civil servants, the U.S. uniformed services pay grades and the salary grades by which United States military personnel are paid are paid*/
structure PayScaleCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A pay grade is a breakdown of a pay scale that is used to manage the compensation of a worker by providing a a fixed framework of salary or wage ranges, as opposed to a free negotiation*/
structure PayGradeCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The pay range of the pay grade*/
structure PayGradePayRange
/**The minimum rate of pay of the associated entity*/
minimumRate: reference MinimumRate
/**The pay range control point*/
medianRate: reference MedianRate
/**The maximim rate of pay the associated entity*/
maximumRate: reference MaximumRate
/**The minimum rate of pay of the associated entity*/
structure MinimumRate
/**TThe numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/**List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
unitCode: reference MinimumRate_unitCode_UnitCode
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference MinimumRate_baseUnitCode_BaseUnitCode
/**For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3*/
baseMultiplierValue: float
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
structure MinimumRate_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure MinimumRate_baseUnitCode_BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The pay range control point*/
structure MedianRate
/**TThe numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/**List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
unitCode: reference MedianRate_unitCode_UnitCode
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference MedianRate_baseUnitCode_BaseUnitCode
/**For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3*/
baseMultiplierValue: float
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
structure MedianRate_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure MedianRate_baseUnitCode_BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The maximim rate of pay the associated entity*/
structure MaximumRate
/**TThe numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/**List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
unitCode: reference MaximumRate_unitCode_UnitCode
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference MaximumRate_baseUnitCode_BaseUnitCode
/**For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3*/
baseMultiplierValue: float
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
structure MaximumRate_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure MaximumRate_baseUnitCode_BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The pay step code*/
structure PayGradeStepCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The rate associated with the pay step*/
structure PayGradeStepPayRate
/**TThe numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20*/
amountValue: float
/**List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD*/
currencyCode: string
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
unitCode: reference PayGradeStepPayRate_unitCode_UnitCode
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
baseUnitCode: reference PayGradeStepPayRate_baseUnitCode_BaseUnitCode
/**For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3*/
baseMultiplierValue: float
/**For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent*/
structure PayGradeStepPayRate_unitCode_UnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales*/
structure PayGradeStepPayRate_baseUnitCode_BaseUnitCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A geographic pay differential is additional compensation paid to a worker to account for variations in cost of labor or cost of living based on location and is expected to be communicated as an additional remuneration. This is a coded field that is associated to a percent that drives the calculation of that additional compensation. It is also used to modify the pay range associated to the pay grade in order to apply the appropriate adjustments to the compa ratio*/
structure GeographicPayDifferentialCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
structure WorkAssignments_customFieldGroup_CustomFieldGroup
/**A list of custom amounts*/
amountFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields*
/**A list of custom codes*/
codeFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields*
/**A list of custom dates*/
dateFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields*
/**A list of custom datetimes*/
dateTimeFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields*
/**A list of custom indicators*/
indicatorFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields*
/**A list of custom numbers*/
numberFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields*
/**A list of custom percentages*/
percentFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields*
/**A list of custom strings*/
stringFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields*
/**A list of custom telephone numbers*/
telephoneFields: reference WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields*
links: reference WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links*
structure WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields
/**The monetary value of the object in which the amount is associated*/
amountValue: float
/**List of standard currency codes ISO 4212*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_amountFields_AmountFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_codeFields_CodeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
dateValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateFields_DateFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields
/**The string reprersentation of the date-time value. Follows the ISO-8601:2000 format.*/
dateTimeValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_dateTimeFields_DateTimeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields
/**Boolean expression*/
indicatorValue: boolean
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_indicatorFields_IndicatorFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields
/**A custom number*/
numberValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_numberFields_NumberFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields
/**The percentage value*/
percentValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_percentFields_PercentFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields
/**A custom string*/
stringValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_stringFields_StringFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure WorkAssignments_customFieldGroup_CustomFieldGroup_telephoneFields_TelephoneFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string WorkAssignments_customFieldGroup_CustomFieldGroup_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure WorkAssignments_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: WorkAssignments_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": WorkAssignments_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": WorkAssignments_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: WorkAssignments_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string WorkAssignments_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string WorkAssignments_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string WorkAssignments_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string WorkAssignments_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A container of custom fields. The category within each custom object allows for the categorizing or grouping of the associated custom field for the purpose of data mining. For example, the typeCode on a custom string object might be valued as SIZE and the correlating name codes might be t-shirt, pants, jacket, etc.*/
structure CustomFieldGroup
/**A list of custom amounts*/
amountFields: reference CustomFieldGroup_amountFields_AmountFields*
/**A list of custom codes*/
codeFields: reference CustomFieldGroup_codeFields_CodeFields*
/**A list of custom dates*/
dateFields: reference CustomFieldGroup_dateFields_DateFields*
/**A list of custom datetimes*/
dateTimeFields: reference CustomFieldGroup_dateTimeFields_DateTimeFields*
/**A list of custom indicators*/
indicatorFields: reference CustomFieldGroup_indicatorFields_IndicatorFields*
/**A list of custom numbers*/
numberFields: reference CustomFieldGroup_numberFields_NumberFields*
/**A list of custom percentages*/
percentFields: reference CustomFieldGroup_percentFields_PercentFields*
/**A list of custom strings*/
stringFields: reference CustomFieldGroup_stringFields_StringFields*
/**A list of custom telephone numbers*/
telephoneFields: reference CustomFieldGroup_telephoneFields_TelephoneFields*
links: reference CustomFieldGroup_links_Links*
structure CustomFieldGroup_amountFields_AmountFields
/**The monetary value of the object in which the amount is associated*/
amountValue: float
/**List of standard currency codes ISO 4212*/
currencyCode: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_amountFields_AmountFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_amountFields_AmountFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_amountFields_AmountFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_amountFields_AmountFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_codeFields_CodeFields
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_codeFields_CodeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_codeFields_CodeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_codeFields_CodeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_codeFields_CodeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_dateFields_DateFields
/**The string representation of the date value. Follows the ISO-8601:2000 format.*/
dateValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_dateFields_DateFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_dateFields_DateFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_dateFields_DateFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_dateFields_DateFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_dateTimeFields_DateTimeFields
/**The string reprersentation of the date-time value. Follows the ISO-8601:2000 format.*/
dateTimeValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_dateTimeFields_DateTimeFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_dateTimeFields_DateTimeFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_dateTimeFields_DateTimeFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_dateTimeFields_DateTimeFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_indicatorFields_IndicatorFields
/**Boolean expression*/
indicatorValue: boolean
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_indicatorFields_IndicatorFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_indicatorFields_IndicatorFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_indicatorFields_IndicatorFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_indicatorFields_IndicatorFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_numberFields_NumberFields
/**A custom number*/
numberValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_numberFields_NumberFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_numberFields_NumberFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_numberFields_NumberFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_numberFields_NumberFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_percentFields_PercentFields
/**The percentage value*/
percentValue: float
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_percentFields_PercentFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_percentFields_PercentFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_percentFields_PercentFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_percentFields_PercentFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_stringFields_StringFields
/**A custom string*/
stringValue: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_stringFields_StringFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_stringFields_StringFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_stringFields_StringFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_stringFields_StringFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
structure CustomFieldGroup_telephoneFields_TelephoneFields
/**The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country. */
countryDialing: string
/**The local area dialing code for a telephone number.*/
areaDialing: string
/**The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.*/
dialNumber: string
/**The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.*/
extension: string
/**National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.*/
access: string
/**The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that \ is used as an escape character in regex, but a double \ is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention*/
formattedNumber: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
nameCode: reference CustomFieldGroup_telephoneFields_TelephoneFields_nameCode_NameCode
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
categoryCode: reference CustomFieldGroup_telephoneFields_TelephoneFields_categoryCode_CategoryCode
/**The unique identifier of the object in a collection*/
itemID: string
/**A coded name or descriptive label of the associated entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_telephoneFields_TelephoneFields_nameCode_NameCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**The type of the associated field. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary */
structure CustomFieldGroup_telephoneFields_TelephoneFields_categoryCode_CategoryCode
/**The code for the related entity.*/
codeValue: string
/**Short description of the related code not to exceed 25 characters*/
shortName: string
/**Long description of the related code*/
longName: string
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure CustomFieldGroup_links_Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: CustomFieldGroup_links_Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": CustomFieldGroup_links_Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": CustomFieldGroup_links_Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: CustomFieldGroup_links_Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string CustomFieldGroup_links_Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string CustomFieldGroup_links_Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string CustomFieldGroup_links_Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string CustomFieldGroup_links_Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
/**A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links*/
structure Links
/**The URI of the related entity*/
href: string
/**Indicates the nature of the relationship of the related resource to the resource that generated this representation*/
rel: Links_rel_Rel
/**This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.*/
title: string
/**This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.*/
targetSchema: string
/**The media type that the linked resource will return (Response)*/
"mediaType": Links_mediaType_MediaType
/**The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)*/
"method": Links_method_Method
/**If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)*/
encType: Links_encType_EncType
/**This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.*/
schema: string
enum string Links_rel_Rel
alternate: "alternate"
create: "create"
canonical: "canonical"
describedby: "describedby"
enclosure: "enclosure"
full: "full"
related: "related"
root: "root"
self: "self"
"up": "up"
search: "search"
_adp_invoke: "/adp/invoke"
_adp_image: "/adp/image"
_adp_confirm_message: "/adp/confirm-message"
_adp_status_monitor: "/adp/status-monitor"
_adp_codelist: "/adp/codelist"
_adp_template: "/adp/template"
_adp_externalLink: "/adp/externalLink"
enum string Links_mediaType_MediaType
application_json: "application/json"
text_html: "text/html"
application_pdf: "application/pdf"
image_jpeg: "image/jpeg"
image_gif: "image/gif"
image_png: "image/png"
application_msword: "application/msword"
application_vnd_openxmlformats_officedocument_wordprocessingml_document: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
enum string Links_method_Method
"GET": "GET"
"POST": "POST"
"DELETE": "DELETE"
"PUT": "PUT"
enum string Links_encType_EncType
application_json: "application/json"
application_x_www_form_urlencoded: "application/x-www-form-urlencoded"
