Elements and Sections in the Access Profile XML Output File

The following table describes the elements and sections in the access profile XML output file.

Table Elements and Sections in the Access Profile XML File

Description Element or Section

<Name> contains the system name of the access profile. This is the same name that is used to retrieve a single access profile.

This name never changes during any updates. When a new access profile is inserted, this name is used as the display name if a display name is not provided in the <AccessProfileTranslation> element of the XML file.

<data:Name>Administrator</data:Name>

<NameTranslation> contains the name of the access profile in the language of the user who extracts the access profile information. This element is read-only and is ignored for Upsert requests.

<data:NameTranslation></data:NameTranslation>

<AccessProfileID> contains the access profile ID. This element is read-only and is ignored for Upsert requests.

<data:AccessProfileId></data:AccessProfileId>

<Description> contains the description of the access profile that is used if one is not provided in the <AccessProfileTranslation> element of the XML file.

<data:Description></data:Description>

<AvailableForTeam> specifies whether the access profile can be granted to team members (true) or cannot be granted to team members (false). This element corresponds to the Grantable to Team Members check box in Step 1 of the Access Profile Wizard.

<data:AvailableForTeam>false
</data:AvailableForTeam>

<AvailableForBook> specifies whether the access profile can be assigned to a user’s association with a book (true) or cannot be assigned to a user’s association with a book (false). This element corresponds to the Grantable to Book Users check box in Step 1 of the Access Profile Wizard.

<data:AvailableForBook>false
</data:AvailableForBook>

<Disabled> indicates if the access profile is disabled (true) or is not disabled (false). This element corresponds to the Disabled check box in Step 1 of the Access Profile Wizard.

<data:Disabled>false</data:Disabled> 

The <ListOfAccessProfileTranslation> section contains the translation values for the access profile.

<data:ListOfAccessProfileTranslation>
. . .
</data:ListOfAccessProfileTranslation> 

The <AccessProfileTranslation> section contains the translation values for one language:

  • <LanguageCode> contains the three-letter code for a language. For the list of language codes, see Language Codes and Their Corresponding Language and Country.

  • <Title> contains the title for the access profile in the language identified by the language code.

  • <Description> contains the description for the access profile in the language identified by the language code.

In this example, when the user's language is set to German (DEU), the following values are displayed in the access profile:

  • The title of the access profile is Administrator Standardzugriffsprofil

  • The description is Vom System erzeugt

<data:ListOfAccessProfileTranslation>
  <data:AccessProfileTranslation>
    <data:LanguageCode>DEU</data:LanguageCode>
    <data:Title>Administrator
     Standardzugriffsprofil
    </data:Title>
    <data:Description>Vom System erzeugt
    </data:Description>
  </data:AccessProfileTranslation>
. . .
</data:ListOfAccessProfileTranslation> 

The <ListOfAccessProfileEntry> section describes the access rights defined on the access profile.

<data:ListOfAccessProfileEntry>
. . .
</data:ListOfAccessProfileEntry>

The <AccessProfileEntry> section describes one access object (that is, a record type or related record type for which a permission can be granted) and the permissions granted for the access object:

<data:ListOfAccessProfileEntry>
  <data:AccessProfileEntry>
    <data:AccessObjectName>CustomObject10
    </data:AccessObjectName>
    <data:PermissionCode>R</data:PermissionCode>
  </data:AccessProfileEntry>
. . .
</data:ListOfAccessProfileEntry>