User Element: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
Line 121: | Line 121: | ||
* The MiddleName element is optional. | * The MiddleName element is optional. | ||
* The Login element is required and its value must not match an | * The Login element is required and its value must not match an exising login. | ||
* The Locale, City, State | * The Locale element is optional. If present, it may contain any of the following elements: | ||
City (City Name), State (State Name) and Country (Country Name). | |||
* The Email element is required. | * The Email element is required. | ||
* The DefaultEntity element is required | * The DefaultEntity element is required and must contain a valid entity | ||
* The CreatedDate element is required and | * The CreatedDate element is required. If the date entered is not valid the current date and time will be used. | ||
* The ExpirationDate element is optional and if present | * The ExpirationDate element is optional and, if present, must be a valid date. | ||
* The RevokeDate element is optional and if present | * The RevokeDate element is optional and, if present, must be a valid date. | ||
* The UserEntity element is optional if present | * The UserEntity element is optional and, if present, must contain a valid entity. | ||
* The | * The ReportingOrg element is optional and, if present, must contain a valid existing issue with an IssueTypeID equal to 56 (Reporting Organization). | ||
* The | * The ParentUser element is optional. If present, it must contain a Login element whose value matches an existing login. | ||
* The | * The Group element is optional. If present, the GroupName element value must match an existing user group name. | ||
* The Categories element is optional. If present the UserCategoryName element must match an existing user category. | * The Categories element is optional. If present, the UserCategoryName element must match an existing user category or one that was created by the user within the application. | ||
''Standard User Categories:'' | ''Standard User Categories:'' | ||
Line 162: | Line 163: | ||
13 Project Owner | 13 Project Owner | ||
* The UserPermissions element is optional. | * The UserPermissions element is optional. If present, the PermissionID element or the PermissionDescription element must match an existing permission. The PermissionID is checked first. | ||
* The RetiredDate is optional and, if present, must contain a valid date. |
Revision as of 18:30, 24 October 2013
XML Element
<User>
- <Credentials>
- <FirstName />
- <MiddleName />
- <LastName />
- <Login />
- <Credentials>
- <Locale>
- <City />
- <State />
- <Country />
- </Locale>
- <EmployeeID />
- <Email />
- <DefaultEntity>
- <EnityID />
- <EntityName />
- <DefaultEntity>
- <CreatedDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- <CreatedDate>
- <ExpirationDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- </ExpirationDate>
- <RevokeDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- </RevokeDate>
- <UserEntities>
- <UserEntity>
- <Entity>
- <EnityID />
- <EntityName />
- </Entity>
- <AccountExpirationDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- </AccountExpirationDate>
- <CreatedDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- </CreatedDate>
- <RetiredDate>
- <Year />
- <Month />
- <Day />
- <Hour />
- <Minute />
- <Second />
- <FormattedDate />
- </RetiredDate>
- <ReportingOrg>
- <Issue IssueTypeID= >
- <Description />
- </Issue>
- <Issue IssueTypeID= >
- </ReportingOrg>
- <ParentUser>
- <FirstName />
- <MiddleName />
- <LastName />
- <Login />
- </ParentUser>
- <Groups>
- <Group>
- <GroupName />
- <GroupDescription />
- </Group>
- <Group>
- </Groups>
- <Categories>
- <Category>
- <UserCategoryID />
- <UserCategoryName />
- </Category>
- </Categories>
- <UserPermissions>
- <UserPermission>
- <PermissionID />
- <PermissionDescription/>
- </UserPermission>
- </UserPermissions>
- <UserPermission>
- </UserEntity>
- <Entity>
- </UserEntities>
</User>
Description
- The Credential element is required.
- The FirstName and LastName elements are required.
- The MiddleName element is optional.
- The Login element is required and its value must not match an exising login.
- The Locale element is optional. If present, it may contain any of the following elements:
City (City Name), State (State Name) and Country (Country Name).
- The Email element is required.
- The DefaultEntity element is required and must contain a valid entity
- The CreatedDate element is required. If the date entered is not valid the current date and time will be used.
- The ExpirationDate element is optional and, if present, must be a valid date.
- The RevokeDate element is optional and, if present, must be a valid date.
- The UserEntity element is optional and, if present, must contain a valid entity.
- The ReportingOrg element is optional and, if present, must contain a valid existing issue with an IssueTypeID equal to 56 (Reporting Organization).
- The ParentUser element is optional. If present, it must contain a Login element whose value matches an existing login.
- The Group element is optional. If present, the GroupName element value must match an existing user group name.
- The Categories element is optional. If present, the UserCategoryName element must match an existing user category or one that was created by the user within the application.
Standard User Categories:
ID Category Name
2 FA Engineer
3 Default PRR Reviewer
4 Legal Expert
5 D2 Approver
6 D3 Approver
7 D4 Approver
8 D5 Approver
9 D6 Approver
10 D7 Approver
11 Problem Owner
12 D8 Approver
13 Project Owner
- The UserPermissions element is optional. If present, the PermissionID element or the PermissionDescription element must match an existing permission. The PermissionID is checked first.
- The RetiredDate is optional and, if present, must contain a valid date.