世帯: 必須属性およびパス・パラメータ
この項では、Householdsリソースとその子リソースのリクエスト・ペイロードに必要な属性およびパス・パラメータを示します。
次の表に、親リソースとその子リソースの関係を示します。
親レベル |
世帯 |
子リソース |
Address |
「世帯」>「住所」>「住所目的」 |
|
プライマリ住所 |
|
関係 |
|
SalesTeamMember |
|
ノート |
|
補助分類 |
|
添付 |
次の表に、HouseholdsリソースのPOSTメソッドに必要な属性を示します。
リソース | 属性 | 属性の説明 |
---|---|---|
世帯 |
HouseholdName |
このパーティの一意の識別番号。 この属性に格納されるデータは、HZ_PARTIESのPARTY_NUMBERから取得されます。 |
GroupType |
世帯が販売アカウントか見込み客か、参照タイプZCA_ HOUSEHOLD _TYPEを使用して指定されたその他のユーザー定義パーティ・タイプのいずれであるかを定義する世帯パーティ・タイプ。 値が指定されていない場合は、デフォルトでZCA_CUSTOMERに設定されます。 指定可能な値は、ZCA_CUSTOMERまたはZCA_PROSPECTです。 有効な値のリストは、参照ZCA_HOUSEHOLD_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。 グループ・タイプの値リストは、GroupTypeLookupLOVにあります。 |
次の表に、世帯子リソースのPOSTメソッドに必要な属性を示します。
リソース | 属性 | 属性の説明 |
---|---|---|
「世帯」>「住所」
世帯の場合、プロファイル・オプション・コードZCA_HOUSEHOLD_ADDRESS_REQUIRED_ENABLEDに基づいて住所が必要です。 プロファイル・オプションが次のように設定されている場合、
|
AddressLine1 |
住所の最初の行。 |
AddressLine2 |
住所の2行目。 |
|
Country |
住所の国コード。 国の値リストは、CountryLOVにあります。 |
|
「世帯」>「住所」>「住所目的」 |
使途 |
住所の使用目的または目的を示します。 たとえば、請求、出荷などです。 |
「世帯」>「プライマリ住所」 |
AddressLine1 |
プライマリ住所の1行目。 |
AddressLine2 |
プライマリ住所の2行目。 |
|
Country |
プライマリ住所の国コード。 国の値リストは、CountryLOVにあります。 |
|
「世帯」>「関係」 |
SubjectPartyNumber |
関係のサブジェクト・パーティの一意の識別番号。 |
RelationshipType |
関係タイプ名。 たとえば、CUSTOMER_SUPPLIERです。 関係タイプの値リストは、RelationshipTypeLookupLOVにあります。 |
|
RelationshipCode |
これがフォワード関係コードかバック・ワード関係コードかを示します。 関係コードの値リストは、RelationshipTypeLookupLOVにあります。 |
|
「世帯」>「営業チーム・メンバー」 |
AccessLevelCode |
アクセス・レベルによって、リソースに付与されるアクセスのタイプと組織のマネージャが決まります。 指定可能な値は、ZCA_ACCESS_LEVEL参照で定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 アクセス・レベル・コードの値リストは、AccessLevelLOVにあります。 |
LockAssignmentFlag |
自動テリトリ割当を設定できるかどうかを示します。 値がTrueの場合、自動テリトリ割当では販売アカウント・チーム・リソースを削除できません。 販売アカウント・チーム・メンバーを手動で追加すると、このフラグはYにデフォルト設定されます。 |
|
AssignmentTypeCode |
リソースが販売アカウント・チームにどのように割り当てられるかを示すコード。 指定可能な値は、ZCA_ASSIGNMENT_TYPE参照で使用できます。 |
|
ResourceEmailAddress |
リソースの電子メール・アドレス。 |
|
「世帯」>「ノート」 |
NoteTxt |
ノート・テキストを格納する列。 |
NoteTypeCode |
ノートのカテゴリ化のノート・タイプ・コード。 ノート・タイプ・コードの値リストは、NoteSourceTypeVAにあります。 |
|
VisibilityCode |
ノートの表示レベル。 表示コードの値リストは、NoteVisibilityLookupVAにあります。 |
|
「世帯」>「補助分類」 |
ClassCategory |
分類カテゴリの名前。 |
ClassCode |
分類カテゴリに対応する有効な分類コード。 |
|
「世帯」>「添付ファイル」 |
DatatypeCode |
データ型を示す値。 |
FileName |
添付のファイル名。 |
|
UploadedText |
添付のテキスト。 |
|
CategoryName |
添付のカテゴリ。 |
次の表に、HouseholdsリソースのPATCHメソッドに必要なパス・パラメータを示します。
リソース | パス | パス・パラメータ |
---|---|---|
世帯 |
/crmRestApi/resources/11.13.18.10/households/{PartyNumber} |
PartyNumber |
次の表に、世帯子リソースのPATCHメソッドに必要なパス・パラメータを示します。
リソース | パス | パス・パラメータ |
---|---|---|
「世帯」>「住所」 |
/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/Address/{AddressNumber} |
PartyNumber AddressNumber |
「世帯」>「住所」>「住所目的」 |
/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{ AddressPurposeId } |
PartyNumber AddressNumber AddressPurposeId |
「世帯」>「プライマリ住所」 |
/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber} |
PartyNumber AddressNumber |
「世帯」>「関係」 |
Relationship子リソースでは、GETアクションのみがサポートされます。 |
Relationship子リソースでは、GETアクションのみがサポートされます。 |
「世帯」>「営業チーム・メンバー」 |
/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/SalesTeamMember/{SalesTeamMemberId} |
PartyNumber SalesTeamMemberId |
「世帯」>「ノート」 |
/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Note/{NoteId} |
PartyNumber NoteId |
「世帯」>「補助分類」 |
/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId} |
PartyNumber CodeAssignmentId |
「世帯」>「添付ファイル」 |
/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/Attachment/{AttachmentUniqID} |
PartyNumber AttachmentUniqID |