プログラム登録: 必須属性およびパス・パラメータ
この項では、プログラム登録リソースとその子リソースのリクエスト・ペイロードの必須属性およびパス・パラメータを示します。
次の表に、親リソースとその子リソースの関係を示します。
親レベル |
プログラム登録 |
子リソース |
PartnerProgram |
ProgramBenefitDetails |
|
ノート |
次の表に、プログラム登録リソースのPOSTメソッドに必要な属性を示します。
リソース | 属性 | 属性の説明 |
---|---|---|
プログラム登録 |
PartnerProgramId |
パートナ・プログラムの一意の識別子。 |
PartnerPartyId |
パートナの一意の識別子。 |
次の表に、プログラム登録子リソースのPOSTメソッドに必要な属性を示します。
リソース | 属性 | 属性の説明 |
---|---|---|
「プログラム登録」>「パートナ・プログラム」 |
パートナ・プログラム子リソースはポストおよびパッチをサポートしていません。 |
パートナ・プログラム子リソースはポストおよびパッチをサポートしていません。 |
「プログラム登録」>「プログラム特典詳細」 |
パートナ・プログラム子リソースはポストおよびパッチをサポートしていません。 |
パートナ・プログラム子リソースはポストおよびパッチをサポートしていません。 |
「プログラム登録」>「ノート」 |
NoteTxt |
実際のノートのテキスト。 |
NoteTypeCode |
このコードは、ノート・タイプの分類用です。 ノート・タイプ・コードの値リストは、NoteSourceTypeVAにあります。 |
次の表に、プログラム登録リソースのPATCHメソッドに必要なパス・パラメータを示します。
リソース | パス | パス・パラメータ |
---|---|---|
プログラム登録 |
/crmRestApi/resources/11.13.18.10/programEnrollments/ {EnrollmentNumber} |
EnrollmentNumber |
次の表に、プログラム登録子リソースのPATCHメソッドに必要なパス・パラメータを示します。
リソース | パス | パス・パラメータ |
---|---|---|
「プログラム登録」>「パートナ・プログラム」 |
パートナ・プログラム子リソースは、GETアクションのみをサポートしています。 |
パートナ・プログラム子リソースは、GETアクションのみをサポートしています。 |
「プログラム登録」>「プログラム特典詳細」 |
プログラム・ベネフィット詳細子リソースは、GETアクションのみをサポートしています。 |
プログラム・ベネフィット詳細子リソースは、GETアクションのみをサポートしています。 |
「プログラム登録」>「ノート」 |
/crmRestApi/resources/11.13.18.10/programEnrollments /{ProgramEnrollment}/child/Notes |
ProgramEnrollment |