Jump to

• Request
• Response

Create a case household

post

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds

Request

Path Parameters

• CaseNumber(required): string
  The alternate key identifier of the case.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• HouseholdName: string
  Title: Household Name

  Maximum Length: 360

  The name of the household.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : cases-caseHouseholds-item-response

Type: object

Show Source

• CaseHouseholdId: integer (int64)
  Title: Household ID

  Read Only: true

  The unique identifier of the case household.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the household for the case.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the case household was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• HouseholdName: string
  Title: Household Name

  Maximum Length: 360

  The name of the household.
• HouseholdPartyNumber: string
  Title: Household Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the household party.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the household for the case was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the household for the case.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the household for the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PrimaryFlag: boolean
  Title: Primary Household

  Read Only: true

  Indicates whether the household is the primary household for the case.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case household was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Household",
            "type":"boolean",
            "description":"Indicates whether the household is the primary household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the household party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseHouseholdId":{
            "title":"Household ID",
            "type":"integer",
            "description":"The unique identifier of the case household.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the household for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Links

HouseholdVO

Operation: /crmRestApi/resources/11.13.18.05/households

An object that includes attributes used to store values while creating or updating a household. A household is a group that has a relationship with either an account or a contact.

Back to Top