Get the list of code details for a specific code name

get

/PASService/rest/services/v1/codes

Gets a list of code details based on the specific code name or code value.

Request

Query Parameters
  • This parameter defines the where clause i.e., to get all the records from ascode table where the code name equals the provided value ? codeValue = 33 or ?q= codeValue eq 33. The value should be string.
  • This parameter defines the where clause i.e., to get all the records from ascode table where the code value equals the provided value. For example: ?codeName= AsCodeRole or ?q= codeName eq AsCodeRole. The value should be a string.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY.

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches list of code details for a specific code successfully.
Back to Top

Examples

This example describes how to get a list of code details based on the specific code name.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl \
  -X GET \
  -H "Content-Type: application/json" \
  -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
  -L "http://server:port/PASService/rest/services/v1/codes?q=codeName eq "AsCodeClientType""

Example Response Body

The following shows an example of the response body in JSON format:

{
    "count": 1714,
    "offset": 0,
    "limit": 100,
    "codes": [
        {
            "codeName": "AsCodeADDInjuries",
            "codeValue": "01",
            "longDescription": "Death or any two of Hand, Foot, Eye",
            "shortDescription": "Level 1"
        },
        {
            "codeName": "AsCodeADDInjuries",
            "codeValue": "02",
            "longDescription": "(One Hand, Foot or Eye) and Speech and Hearing",
            "shortDescription": "Level 2"
        },
        {
            "codeName": "AsCodeADDInjuries",
            "codeValue": "03",
            "longDescription": "(One Hand, Foot or Eye) or (Speech and Hearing)",
            "shortDescription": "Level 3"
        },
        {
            "codeName": "AsCodeADDInjuries",
            "codeValue": "04",
            "longDescription": "Thumb and Index Finger on either hand",
            "shortDescription": "Level 4"
        },
        {
            "codeName": "AsCodeADDInjuries",
            "codeValue": "05",
            "longDescription": "Death of family member",
            "shortDescription": "Level 5"
        },
        {
            "codeName": "AsCodeAccessType",
            "codeValue": "REST",
            "longDescription": "Access via REST",
            "shortDescription": "REST service"
        },
        {
            "codeName": "AsCodeAccessType",
            "codeValue": "SOAP",
            "longDescription": "Access via SOAP service",
            "shortDescription": "SOAP service"
        },
        {
            "codeName": "AsCodeAccessType",
            "codeValue": "WEB",
            "longDescription": "Access via OIPA",
            "shortDescription": "OIPA Web App"
        },
        {
            "codeName": "AsCodeAccountingDetailStatus",
            "codeValue": "01",
            "longDescription": "Active Entry",
            "shortDescription": "Active"
        },
        {
            "codeName": "AsCodeAccountingDetailStatus",
            "codeValue": "02",
            "longDescription": "Pending Entry",
            "shortDescription": "Pending"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "01",
            "longDescription": "Total Amount Assigned To Funds",
            "shortDescription": "Total Of Funds"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "02",
            "longDescription": "Account Record For Each Fund Assigned",
            "shortDescription": "By Fund"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "03",
            "longDescription": "Value Of MathVariable",
            "shortDescription": "MathVariable"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "04",
            "longDescription": "Suspense Amount",
            "shortDescription": "Suspense Amount"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "05",
            "longDescription": "Account Record For Each Disbursement",
            "shortDescription": "Disbursement"
        },
        {
            "codeName": "AsCodeAccountingType",
            "codeValue": "06",
            "longDescription": "A dynamic field on the SuspenseScreen rule",
            "shortDescription": "Suspense Field Amount"
        },
        {
            "codeName": "AsCodeActivityMathSourceType",
            "codeValue": "01",
            "longDescription": "TransactionMath",
            "shortDescription": "TransactionMath"
        },
        {
            "codeName": "AsCodeActivityMathSourceType",
            "codeValue": "02",
            "longDescription": "PostAssignmentTransactionMath",
            "shortDescription": "PostAssignmentTransactionMath"
        },
        {
            "codeName": "AsCodeActivityMathSourceType",
            "codeValue": "03",
            "longDescription": "SystemMath",
            "shortDescription": "SystemMath"
        },
        {
            "codeName": "AsCodeActivityType",
            "codeValue": "01",
            "longDescription": "Natural",
            "shortDescription": "Natural"
        },
        {
            "codeName": "AsCodeActivityType",
            "codeValue": "02",
            "longDescription": "Reversal",
            "shortDescription": "Reversal"
        },
        {
            "codeName": "AsCodeActivityType",
            "codeValue": "03",
            "longDescription": "System generated reversal",
            "shortDescription": "Undo"
        },
        {
            "codeName": "AsCodeActivityType",
            "codeValue": "04",
            "longDescription": "System generated activity",
            "shortDescription": "Redo"
        },
        {
            "codeName": "AsCodeActivityType",
            "codeValue": "05",
            "longDescription": "Activity Sequence Reversal",
            "shortDescription": "Activity Sequence Reversal"
        },
        {
            "codeName": "AsCodeAdditiveRate",
            "codeValue": "01",
            "longDescription": "Bonus Interest",
            "shortDescription": "Bonus Interest"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "01",
            "longDescription": "Electronic Funds Transfer",
            "shortDescription": "EFT"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "02",
            "longDescription": "Home",
            "shortDescription": "Home"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "03",
            "longDescription": "Residence",
            "shortDescription": "Residence"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "04",
            "longDescription": "Billing",
            "shortDescription": "Billing"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "05",
            "longDescription": "Mailing",
            "shortDescription": "Mailing"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "06",
            "longDescription": "Internal Account",
            "shortDescription": "Internal Account"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "07",
            "longDescription": "Insurance Company",
            "shortDescription": "Insurance Company"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "08",
            "longDescription": "List Bill",
            "shortDescription": "List Bill"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "09",
            "longDescription": "Home Postal",
            "shortDescription": "Home Postal"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "10",
            "longDescription": "Overnight Delivery",
            "shortDescription": "Overnight Delivery"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "11",
            "longDescription": "Head Office",
            "shortDescription": "Head Office"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "12",
            "longDescription": "Branch Office",
            "shortDescription": "Branch Office"
        },
        {
            "codeName": "AsCodeAddressRole",
            "codeValue": "13",
            "longDescription": "Trustee",
            "shortDescription": "Trustee"
        },
        {
            "codeName": "AsCodeAddressStatus",
            "codeValue": "01",
            "longDescription": "Active",
            "shortDescription": "Active"
        },
        {
            "codeName": "AsCodeAddressStatus",
            "codeValue": "02",
            "longDescription": "Expired",
            "shortDescription": "Expired"
        },
        {
            "codeName": "AsCodeAdministrativeArea",
            "codeValue": "01",
            "longDescription": "New Business",
            "shortDescription": "New Business"
        },
        {
            "codeName": "AsCodeAdministrativeArea",
            "codeValue": "02",
            "longDescription": "Customer Service",
            "shortDescription": "Customer Service"
        },
        {
            "codeName": "AsCodeAge",
            "codeValue": "01",
            "longDescription": "Age Last Birthday",
            "shortDescription": "Age Last"
        },
        {
            "codeName": "AsCodeAge",
            "codeValue": "02",
            "longDescription": "Age Nearest Birthday",
            "shortDescription": "Age Nearest"
        },
        {
            "codeName": "AsCodeAge",
            "codeValue": "03",
            "longDescription": "Age Next Birthday",
            "shortDescription": "Age Next"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "BL",
            "longDescription": "Bank Letter",
            "shortDescription": "Bank Letter"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "CNTR",
            "longDescription": "Contract",
            "shortDescription": "Contract"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "DI",
            "longDescription": "Data Intake",
            "shortDescription": "Data Intake"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "ENROLL",
            "longDescription": "Enrollment",
            "shortDescription": "Enrollment"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "FUNDING",
            "longDescription": "Funding",
            "shortDescription": "Funding"
        },
        {
            "codeName": "AsCodeAgreementCategory",
            "codeValue": "PERF",
            "longDescription": "Performance Guarantee",
            "shortDescription": "Performance Guarantee"
        },
        {
            "codeName": "AsCodeAgreementDefinitionStatus",
            "codeValue": "ACTIVE",
            "longDescription": "Active",
            "shortDescription": "Active"
        },
        {
            "codeName": "AsCodeAgreementDefinitionStatus",
            "codeValue": "PEND",
            "longDescription": "Pending",
            "shortDescription": "Pending"
        },
        {
            "codeName": "AsCodeAgreementRoleStatus",
            "codeValue": "01",
            "longDescription": "Active",
            "shortDescription": "Active"
        },
        {
            "codeName": "AsCodeAgreementRoleStatus",
            "codeValue": "98",
            "longDescription": "Inactive",
            "shortDescription": "Inactive"
        },
        {
            "codeName": "AsCodeAgreementRoleStatus",
            "codeValue": "99",
            "longDescription": "Deleted",
            "shortDescription": "Deleted"
        },
        {
            "codeName": "AsCodeAgreementRoleType",
            "codeValue": "01",
            "longDescription": "Agreement Role Type 1",
            "shortDescription": "Agreement Role Type 1"
        },
        {
            "codeName": "AsCodeAgreementRoleType",
            "codeValue": "02",
            "longDescription": "Agreement Role Type 2",
            "shortDescription": "Agreement Role Type 2"
        },
        {
            "codeName": "AsCodeAgreementRoleType",
            "codeValue": "03",
            "longDescription": "Authorized Signatory",
            "shortDescription": "Authorized Signatory"
        },
        {
            "codeName": "AsCodeAgreementRoleType",
            "codeValue": "04",
            "longDescription": "Primary Contact",
            "shortDescription": "Primary Contact"
        },
        {
            "codeName": "AsCodeAgreementStatus",
            "codeValue": "ACTIVE",
            "longDescription": "Active Status",
            "shortDescription": "Active"
        },
        {
            "codeName": "AsCodeAgreementStatus",
            "codeValue": "PENDING",
            "longDescription": "Pending Status",
            "shortDescription": "Pending"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "BANK",
            "longDescription": "Bank",
            "shortDescription": "Bank"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "DI",
            "longDescription": "Data Intake",
            "shortDescription": "Data Intake"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "ENROLLEVNT",
            "longDescription": "Enrollment Event",
            "shortDescription": "Enrollment Event"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "FUNDACCT",
            "longDescription": "Funding Account",
            "shortDescription": "Funding Account"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "FUNDING",
            "longDescription": "Funding",
            "shortDescription": "Funding"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "MSTR-ASA",
            "longDescription": "Master Agreeemtn ASA",
            "shortDescription": "Master Agreement ASA"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "MSTR-INS",
            "longDescription": "Master Agreeemtn Insured",
            "shortDescription": "Master Agreement Insured"
        },
        {
            "codeName": "AsCodeAgreementType",
            "codeValue": "PG-CNT",
            "longDescription": "Performance Guarantee - Contract",
            "shortDescription": "Performance Guarantee - Contract"
        },
        {
            "codeName": "AsCodeAllocationMethod",
            "codeValue": "01",
            "longDescription": "Percent",
            "shortDescription": "Percent"
        },
        {
            "codeName": "AsCodeAllocationMethod",
            "codeValue": "02",
            "longDescription": "Amount",
            "shortDescription": "Amount"
        },
        {
            "codeName": "AsCodeAllocationMethod",
            "codeValue": "03",
            "longDescription": "Units",
            "shortDescription": "Units"
        },
        {
            "codeName": "AsCodeAllocationMethod",
            "codeValue": "04",
            "longDescription": "Pro Rata ",
            "shortDescription": "Pro Rata"
        },
        {
            "codeName": "AsCodeAllocationMethod",
            "codeValue": "05",
            "longDescription": "Percent Of Fund",
            "shortDescription": "PercentOfFund"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "01",
            "longDescription": "Plan Default",
            "shortDescription": "Plan Default"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "02",
            "longDescription": "Future Allocations",
            "shortDescription": "Future Allocations"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "03",
            "longDescription": "Activity Allocation",
            "shortDescription": "Activity"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "04",
            "longDescription": "Plan Default - Issue",
            "shortDescription": "Plan Default - Issue"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "05",
            "longDescription": "Segment Default",
            "shortDescription": "Segment Default"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "06",
            "longDescription": "Issue-Retail",
            "shortDescription": "Issue-Retail"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "07",
            "longDescription": "Issue-Insurance",
            "shortDescription": "Issue-Insurance"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "08",
            "longDescription": "Issue-Consults",
            "shortDescription": "Issue-Consults"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "09",
            "longDescription": "Rebalancing Program",
            "shortDescription": "Rebalancing Program"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "10",
            "longDescription": "Automatic Payment Program",
            "shortDescription": "Automatic Payment Program"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "100",
            "longDescription": "Conversion Premium (01 - Premium) ",
            "shortDescription": "Conversion Premium"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "101",
            "longDescription": "Conversion Premium Tax (02 - Premium Tax) ",
            "shortDescription": "Conversion Premium Tax"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "102",
            "longDescription": "Conversion Interest (06 - Interest) ",
            "shortDescription": "Conversion Interest"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "103",
            "longDescription": "Conversion Interest Expense - Gain (07 - Interest Expense - Gain) ",
            "shortDescription": "Conversion Interest Expense - Gain"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "104",
            "longDescription": "Conversion Interest Expense - Loss (08 - Interest Expense - Loss) ",
            "shortDescription": "Conversion Interest Expense - Loss"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "105",
            "longDescription": "Conversion Optional Death Benefit Fee (22 - Optional Death Benefit Fee) ",
            "shortDescription": "Conversion Optional Death Benefit Fee"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "106",
            "longDescription": "Conversion Withdrawal (32 - Withdrawal) ",
            "shortDescription": "Conversion Withdrawal"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "107",
            "longDescription": "Conversion Redemption Fee (33 - Redemption Fee) ",
            "shortDescription": "Conversion Redemption Fee"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "108",
            "longDescription": "Conversion Annual Contract Fee (43 - Annual Contract Fee) ",
            "shortDescription": "Conversion Annual Contract Fee"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "109",
            "longDescription": "Conversion Split Deposit Removal (50 - Split Deposit Removal) ",
            "shortDescription": "Conversion Split Deposit Removal"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "11",
            "longDescription": "Systematic Withdrawal Program",
            "shortDescription": "Systematic Withdrawal Program"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "110",
            "longDescription": "Conversion Split Deposit Apply (51 - Split Deposit Apply) ",
            "shortDescription": "Conversion Split Deposit Apply"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "12",
            "longDescription": "Future Program",
            "shortDescription": "Future Program"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "13",
            "longDescription": "Automatic Investment Plan From Fund",
            "shortDescription": "AIP From Fund"
        },
        {
            "codeName": "AsCodeAllocationType",
            "codeValue": "14",
            "longDescription": "Dollar Cost Averaging Program",
            "shortDescription": "Dollar Cost Averaging Program"
        }
    ]
}

Back to Top