GetCodeFours

Below are the request restrictions available when retrieving the code four details returned by the EmpowerStandardExtract web service via ‘GetCodeFours’.


Request Element

Options

Default
Restriction/CodeTypes/TypeInclude
exclude
 
Restriction/DeletedCodesInclude
exclude
exclude

To include deleted codes set the ‘Restriction/DeletedCodes’ element to ‘include. By default, deleted codes are excluded in the extract.

Four codes retrieved can be restricted via their code types. The restriction can either be to include or exclude codes based on their code types.

Below is an example where only codes with code types of ‘actr’ or ‘addc’ would be retrieved:

 

Below is an example where codes with code types of ‘agcy’ or ‘anl2’ would not be retrieved:

 

 Below are the code four fields returned by the EmpowerStandardExtract web service via ‘GetCodeFours’.

Element



Default Screen Title

Code/TypeCode Type
Code/CodeCode
Code/DescriptionDescription
Code/AbbreviationAbbreviation
Code/SortCode1Sort Code 1
Code/SortCode2Sort Code 2
Code/SortCode3Sort Code 3
Code/SortCode4Sort Code 4
Code/SortCode5Sort Code 5
Code/SortCode6Sort Code 6
Code/DeleteFlagDelete Flag
Code/GeneralUseFlagGeneral Use Flag
Code/PositionNumberManagerPosition Number of Manager
Code/PositionNumberAdministratorPosition Number of Administrator
Code/OrgUnitAddress1Address of Org Unit Line 1
Code/OrgUnitAddress2Address of Org Unit Line 2
Code/OrgUnitAddress3Address of Org Unit Line 3
Code/OrgUnitStateState Abbr of Org Unit
Code/OrgUnitPCodePost Code of Org Unit
Code/OrgUnitCountryCountry of Org Unit
Code/OrgUnitPostAddress1Postal Address L1 of Org Unit
Code/OrgUnitPostAddress2Postal Address L2 of Org Unit
Code/OrgUnitPostAddress3Postal Address L3 of Org Unit
Code/OrgUnitPostStatePostal State of Org Unit
Code/OrgUnitPostPCodePostal Post Code of Org Unit
Code/OrgUnitPostCountryPostal Country of Org Unit
Code/OrgUnitPhonePhone Number of Org Unit
Code/OrgUnitFaxFax Number of Org Unit
Code/OrgUnitEmailEmail of Org Unit
Code/AdditionalInformationAdditional Information
Code/OrgChartForegroundColorOrgChart Foreground Colour
Code/OrgChartBackgroundColorOrgChart Background Colour
Code/CodeSequence1Code Sequence 1
Code/CodeSequence2Code Sequence 2
Code/GeneralUseFlag2General Use Flag2
Code/SsrvHideSsrvHide




Next topic

GetConditionCodes











© 2023 Fusion5. All rights reserved.