TAG LINE
TAG LINE
SMALL TITLE

Package / Frequency / Package Currency

(API Version v5)


Represents a linking between a Package frequency and currency in which a Package can be sold.


What can you do with PackageFrequencyPackageCurrency?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the PackageFrequencyPackageCurrency
isActive
"isActive": true
Type: Boolean
Whether or not this combination of Package Frequency and Currency is active.
packageFrequencyId
"packageFrequencyId": 13
Type: Number
Unique identifier for the associated PackageFrequency object.
packageFrequencyName
"packageFrequencyName": "Sample Name"
Type: String
The name of the object associated with the packageFrequencyId property.
packageCurrencyId
"packageCurrencyId": 16
Type: Number
Unique identifier for the associated PackageCurrency object.
packageCurrencyName
"packageCurrencyName": "Sample Name"
Type: String
The name of the object associated with the packageCurrencyId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.


End Points

GETapi/v5/Package/Frequency/Currency/
Retrieve all of the PackageFrequencyPackageCurrency objects.
Retrieve all of the PackageFrequencyPackageCurrency objects.
GET api/v5/Package/Frequency/Currency/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "isActive": true,
            "packageFrequencyId": 27,
            "packageFrequencyName": "Sample Text Data",
            "packageCurrencyId": 17,
            "packageCurrencyName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETapi/v5/Package/Frequency/Currency/Paged
Retrieve all of the PackageFrequencyPackageCurrency objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the PackageFrequencyPackageCurrency objects in a paged fashion.
GET api/v5/Package/Frequency/Currency/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "isActive": true,
                "packageFrequencyId": 25,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 3,
                "packageCurrencyName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETapi/v5/Package/Frequency/Currency/{id}
Retrieve an instance of the PackageFrequencyPackageCurrency object by its ID.
{id}Unique identifier for the PackageFrequencyPackageCurrency object.
Retrieve an instance of the PackageFrequencyPackageCurrency object by its ID.
GET api/v5/Package/Frequency/Currency/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "isActive": true,
        "packageFrequencyId": 11,
        "packageFrequencyName": "Sample Text Data",
        "packageCurrencyId": 26,
        "packageCurrencyName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}