Jump to

• Request
• Response

Get a program partner (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/ProgramPartners/{ProgramPartnersUniqID}

Request

Path Parameters

• LoyProgramId(required): integer(int64)
  The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.
• ProgramPartnersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LoyProgOrgId and PartyId ---for the (Deprecated) Program Partners resource and used to uniquely identify an instance of (Deprecated) Program Partners. The client should not generate the hash key value. Instead, the client should query on the (Deprecated) Program Partners collection resource with a filter on the primary key values in order to navigate to a specific instance of (Deprecated) Program Partners.
  
  For example: ProgramPartners?q=LoyProgOrgId=<value1>;PartyId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : loyaltyPrograms-ProgramPartners-item-response

Type: object

Show Source

• AcrlValidPdLen: number
  Read Only: true

  The Accrual Validity Length specifies the period the accrual is valid, if precalculated accruals are enabled for a program. For example, if the period is six months, the length is 6. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.
• AcrlValidUOMCode: string
  Read Only: true

  Maximum Length: 30

  The program partner accrual valid unit of measure (UOM) code. If Precalculated Accruals are enabled for a program then Accrual Validity Length specifies the period the accrual is valid. For example, if the period is six months, the UOM is Month. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.
• AllwNegativeFlg: string
  Read Only: true

  Maximum Length: 1

  The Allow Negative Flag boolean attribute, if enabled, allows transactions that result in the partner having a negative point balance. The default value is N. There is no dependency or limitation associated with this attribute.
• BillingTypeCode: string
  Read Only: true

  Maximum Length: 30

  The program partner billing type code identifier specifies the type of billing for the member. The list of accepted values are Pre-paid (the partners buy point blocks before members earn the points where a point block representing the amount of points purchased is created and activated) and Post Paid (the partner pays for points only after the points have been given to members where the host company bills the partner after the points are used). There is no default value, dependency, or limitation associated with this attribute.
• ConflictId: integer (int64)
  Read Only: true

  The program partner conflict identifier that Oracle Loyalty Cloud generates during the creation of a new program partner. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that creates the promotion attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the program partners record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new program partners. There is no default value, dependency, or limitation associated with this attribute.
• CreditLimit: number
  Read Only: true

  The program partner credit limit attribute specifies the maximum points allowed in the case of negative point balance. There is no dependency or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the program partner is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the program partner. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the program partner. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the program partners. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to program partners. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyProgOrgId: integer (int64)
  Read Only: true

  The organization identifier of program partner. There is no default value, dependency, or limitation associated with this attribute.
• MinimumOrderQuantity: number
  Read Only: true

  The program partner minimum order quantity attribute specifies the minimum number of points in the automatically created point block. The default value is N. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The program partner object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• OrgExtensionId: integer (int64)
  Read Only: true

  The program partner organization expansion identifier, which is used to uniquely identify a partner. There is no default value, dependency, or limitation associated with this attribute.
• PartnerType: string
  The program partners partner type identifier specifies partner type, that is a prepaid partner or a post paid partner. There is no default value, dependency, or limitation associated with this attribute.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The primary key of loyalty partners. There is no default value, dependency, or limitation associated with this attribute.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The program partner party name specifies the partner name. There is no default value, dependency, or limitation associated with this attribute.
• PrecalcAcrlFlg: string
  Read Only: true

  Maximum Length: 1

  The program partner precalculated accrual attribute is a boolean attribute that specifies whether partners can precalculate the points to be credited to members and send them together with the accrual activity details. The default value is N. There is no dependency or limitation associated with this attribute.
• PricingRuleId: integer (int64)
  Read Only: true

  The program partner pricing rule identifier specifies the pricing rule that is used to price the point block. There is no default value, dependency, or limitation associated with this attribute.
• ReorderLimit: number
  Read Only: true

  The program partner reorder limit identifier specifies the number of points that triggers reordering. For example, if you enter 10,000, a new block is automatically created when the existing block for this partner has less than or equal to 10,000 points remaining. There is no default value, dependency, or limitation associated with this attribute.
• RetBeforeDays: number
  Read Only: true

  The specification of the amount of time after point expiration that the points can be reactivated. There is no default value, dependency, or limitation associated with this attribute.
• SkipAcrlValFlg: string
  Read Only: true

  Maximum Length: 1

  The skip accrual value boolean attribute, if enabled, skips any validations pertaining to accruals. For example, Precalculated Accrual allows a limit on the points that a partner can send in a single transaction in a defined time period to be set up. If this flag is enabled then points can be credited directly to the member???s account, without further validation by the host organization. The default value is N. There is no dependency or limitation associated with this attribute.
• ValdtDisputeUsr: string
  Read Only: true

  Maximum Length: 30

  The accrual dispute transactions (Missing or Incorrect Accrual Dispute) that are created that are submitted to the partner user for validation. Whether or not all accrual disputes are sent to the partner for validation depends on the loyalty terms set up for that partner. There is no default value, dependency, or limitation associated with this attribute.
• ValidDisputeFlg: string
  Read Only: true

  Maximum Length: 1

  The valid dispute boolean attribute, if enabled, validates the disputed transactions. The default value is N. There is no dependency or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "PartnerType":{
            "type":"string",
            "description":"The program partners partner type identifier specifies partner type, that is a prepaid partner or a post paid partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the program partners record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new program partners. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgExtensionId":{
            "type":"integer",
            "description":"The program partner organization expansion identifier, which is used to uniquely identify a partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcrlValidUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The program partner accrual valid unit of measure (UOM) code. If Precalculated Accruals are enabled for a program then Accrual Validity Length specifies the period the accrual is valid. For example, if the period is six months, the UOM is Month. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReorderLimit":{
            "type":"number",
            "description":"The program partner reorder limit identifier specifies the number of points that triggers reordering. For example, if you enter 10,000, a new block is automatically created when the existing block for this partner has less than or equal to 10,000 points remaining. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The program partner party name specifies the partner name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The program partner conflict identifier that Oracle Loyalty Cloud generates during the creation of a new program partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The program partner object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AcrlValidPdLen":{
            "type":"number",
            "description":"The Accrual Validity Length specifies the period the accrual is valid, if precalculated accruals are enabled for a program. For example, if the period is six months, the length is 6. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValdtDisputeUsr":{
            "maxLength":30,
            "type":"string",
            "description":"The accrual dispute transactions (Missing or Incorrect Accrual Dispute) that are created that are submitted to the partner user for validation. Whether or not all accrual disputes are sent to the partner for validation depends on the loyalty terms set up for that partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValidDisputeFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The valid dispute boolean attribute, if enabled, validates the disputed transactions. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipAcrlValFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The skip accrual value boolean attribute, if enabled, skips any validations pertaining to accruals. For example, Precalculated Accrual allows a limit on the points that a partner can send in a single transaction in a defined time period to be set up. If this flag is enabled then points can be credited directly to the member???s account, without further validation by the host organization. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the program partner. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the program partners. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that creates the promotion attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyProgOrgId":{
            "type":"integer",
            "description":"The organization identifier of program partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllwNegativeFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The Allow Negative Flag boolean attribute, if enabled, allows transactions that result in the partner having a negative point balance. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditLimit":{
            "type":"number",
            "description":"The program partner credit limit attribute specifies the maximum points allowed in the case of negative point balance. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The program partner billing type code identifier specifies the type of billing for the member. The list of accepted values are Pre-paid (the partners buy point blocks before members earn the points where a point block representing the amount of points purchased is created and activated) and Post Paid (the partner pays for points only after the points have been given to members where the host company bills the partner after the points are used). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The primary key of loyalty partners. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RetBeforeDays":{
            "type":"number",
            "description":"The specification of the amount of time after point expiration that the points can be reactivated. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumOrderQuantity":{
            "type":"number",
            "description":"The program partner minimum order quantity attribute specifies the minimum number of points in the automatically created point block. The default value is N. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingRuleId":{
            "type":"integer",
            "description":"The program partner pricing rule identifier specifies the pricing rule that is used to price the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrecalcAcrlFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The program partner precalculated accrual attribute is a boolean attribute that specifies whether partners can precalculate the points to be credited to members and send them together with the\naccrual activity details. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to program partners. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the program partner is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the program partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top