1. REST API for Oracle CX Sales and B2B ServiceREST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Reference
  3. Lists of Values
  4. Contacts: Lists of Values

Contacts: Lists of Values

The lookup resource of a lookup determines where the lookup value is stored. However, these lookup resources contain all the lookup values. You must use a finder specifying a lookup type to get the lookup values that you require. The finder is a query statement that selects a specific list of values from the table.

For example, the lookup resource fndStaticLookups contains the list of values specifying the Contact types. You can use the finder LookupTypeIsActiveEnabledFinder, the finder variable BindLookupType, and the lookup type ZCA_CONTACT_TYPE, to get all the values in ZCA_CONTACT_TYPE.

The following is the format of the resource URL.

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeIsActiveEnabledFinder;BindLookupType=ZCA_CONTACT_TYPE

The following is an example of the response body in JSON format.

{
    "items": [
        {
            "LookupType": "ZCA_CONTACT_TYPE",
            "LookupCode": "ZCA_CONTACT",
            "Meaning": "Contact",
            "Description": null,
            "EnabledFlag": "Y",
            "StartDateActive": null,
            "EndDateActive": null,
            "DisplaySequence": 1,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2013-10-24T23:05:27.127+00:00",
            "LastUpdateDate": "2018-05-16T02:26:14.623+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "Tag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000B5A43415F434F4E54414354",
                    "name": "fndStaticLookups",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000B5A43415F434F4E54414354",
                    "name": "fndStaticLookups",
                    "kind": "item"
                }
            ]
        },
        {
            "LookupType": "ZCA_CONTACT_TYPE",
            "LookupCode": "ZCA_CUSTOMER",
            "Meaning": "Customer",
            "Description": null,
            "EnabledFlag": "Y",
            "StartDateActive": null,
            "EndDateActive": null,
            "DisplaySequence": 2,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2013-10-24T23:05:27.134+00:00",
            "LastUpdateDate": "2018-05-16T02:26:14.623+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "Tag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000C5A43415F435553544F4D4552",
                    "name": "fndStaticLookups",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000C5A43415F435553544F4D4552",
                    "name": "fndStaticLookups",
                    "kind": "item"
                }
            ]
        },
        {
            "LookupType": "ZCA_CONTACT_TYPE",
            "LookupCode": "ZCA_PROSPECT",
            "Meaning": "Prospect",
            "Description": null,
            "EnabledFlag": "Y",
            "StartDateActive": null,
            "EndDateActive": null,
            "DisplaySequence": 3,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2013-10-24T23:05:27.140+00:00",
            "LastUpdateDate": "2018-05-16T02:26:14.623+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "Tag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000C5A43415F50524F5350454354",
                    "name": "fndStaticLookups",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups/0002000000105A43415F434F4E544143545F545950450000000C5A43415F50524F5350454354",
                    "name": "fndStaticLookups",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "name": "fndStaticLookups",
            "kind": "collection"
        }
    ]
}

Contacts LOVs

The table lists the LOVs included in the Contacts resource.

Lookup Type LOV Name and Path Sample Lookup Codes and Values
ZCA_CONTACT_TYPE SalesProfileTypeLookupLOV

/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeIsActiveEnabledFinder;BindLookupType=ZCA_CONTACT_TYPE
  • ZCA_CONTACT - Contact
  • ZCA_CUSTOMER - Customer
  • ZCA_PROSPECT - Prospect
NA FiscalYearendMonthLookupLOV

crmRestApi/resources/11.13.18.05/fndCurrencies
  • PKR - Pakistan Rupee
  • PTE - Portuguese Escudo
  • SEK - Swedish Krona
HZ_PARTY_CERT_LEVEL CertificationLevelLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_PARTY_CERT_LEVEL
  • !00 - Highest
  • 200 - Minimum
  • 300 - Not met
HZ_PARTY_CERT_REASON CertificationReasonCodeLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_PARTY_CERT_REASON
  • MANUAL - Manual
  • THIRD_PARTY - Third party content
OWN_RENT_IND RentOwnIndLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= OWN_RENT_IND
  • O - Owns
  • R - Rents
  • E - Co-owns
NA TerritoriesLOV

/crmRestApi/resources/11.13.18.05/fndTerritories
  • AE - United Arab Emirates
  • AF - Afghanistan
  • BH - Bahrain
NA RatedCurrenciesLOV

/crmRestApi/resources/11.13.18.05/ratedCurrencies
  • BRL - Brazilian Real
  • NO_MATCH - Unable to enrich because there no matches
  • MULTIPLE_MATCHES - Unable to enrich because there are multiple matches
DATA_CLOUD_STATUS DataCloudStatusLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= DATA_CLOUD_STATUS
  • MATCHED - Matched
  • NO_MATCH - Unable to enrich because there no matches
  • MULTIPLE_MATCHES - Unable to enrich because there are multiple matches
HZ_STATUS StatusLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_STATUS
  • A - Active
  • I - Inactive
HZ_PREFERRED_CONTACT_METHOD PreferredContactMethodLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_PREFERRED_CONTACT_METHOD
  • PHONE - Phone
  • EMAIL - E-mail
  • MAIL - Mail
NA PhoneCountryCodeLOV

/crmRestApi/resources/11.13.18.05/countryCodes
  • 93 - Afghanistan
  • 358 - Aland Islands
  • 1 - American Samoa
NA FaxCountryCodeLOV

/crmRestApi/resources/11.13.18.05/countryCodes
  • 93 - Afghanistan
  • 358 - Aland Islands
  • 1 - American Samoa
HZ_HOUSE_TYPE HouseTypeLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_HOUSE_TYPE
  • TRAILER - Trailer
  • HOUSE BOAT - House boat
ZCA_RESOURCE_FUNCTION MemberFunctionLOV

/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeIsActiveEnabledFinder;BindLookupType=ZCA_RESOURCE_FUNCTION
  • ACCOUNT MANAGER - Account manager
  • CHANNEL_MGR - Channel manager
  • ENGINEERING_OWNER - Engineering owner
ZCA_ACCESS_LEVEL AccessLevelLOV

/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeIsActiveEnabledFinder;BindLookupType= ZCA_ACCESS_LEVEL
  • 200 - Edit
  • 300 - Full
  • 100 - View only access
HZ_RELATIONSHIP_TYPE RelationshipTypeLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType= HZ_RELATIONSHIP_TYPE
  • AFFILIATE - Affiliation
  • ASSOCIATE - Association
PARTY_RELATIONS_TYPE RelationshipCodeLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType=PARTY_RELATIONS_TYPE
  • ORA_ADVISOR - Advisers Role
  • AFFILIATE_TO - Affiliate of another organization
HZ_SLS_CNTCT_INFLUENCE_LVL_CD InfluenceLevelLookupLOV

/crmRestApi/resources/11.13.18.05/hzLookups?finder=ActiveLookupForTypeFinder;BindLookupType=HZ_SLS_CNTCT_INFLUENCE_LVL_CD
  • INNER_CIRCLE - Inner circle
  • POLITICAL_STRUCTURE - Political structure