POST api/customdata/asphaltgreen/AddHousehold

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Parent1	AGPerson	None.
Parent2	AGPerson	None.
Children	Collection of AGPerson	None.
HomePhone	string	None.
HomeAddress	AGAddress	None.
ClientDefinedKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Parent1": {
    "Id": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2"
    },
    "GenderId": 1,
    "Dob": "2025-11-01T17:24:17.313319-06:00",
    "LoginEmail": "sample string 2",
    "WorkPhone": "sample string 3",
    "WorkAddress": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6"
    },
    "ClientDefinedKey": "sample string 4"
  },
  "Parent2": {
    "Id": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2"
    },
    "GenderId": 1,
    "Dob": "2025-11-01T17:24:17.313319-06:00",
    "LoginEmail": "sample string 2",
    "WorkPhone": "sample string 3",
    "WorkAddress": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6"
    },
    "ClientDefinedKey": "sample string 4"
  },
  "Children": [
    {
      "Id": 1,
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2"
      },
      "GenderId": 1,
      "Dob": "2025-11-01T17:24:17.313319-06:00",
      "LoginEmail": "sample string 2",
      "WorkPhone": "sample string 3",
      "WorkAddress": {
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "StateProvince": "sample string 4",
        "PostalCode": "sample string 5",
        "Country": "sample string 6"
      },
      "ClientDefinedKey": "sample string 4"
    },
    {
      "Id": 1,
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2"
      },
      "GenderId": 1,
      "Dob": "2025-11-01T17:24:17.313319-06:00",
      "LoginEmail": "sample string 2",
      "WorkPhone": "sample string 3",
      "WorkAddress": {
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "StateProvince": "sample string 4",
        "PostalCode": "sample string 5",
        "Country": "sample string 6"
      },
      "ClientDefinedKey": "sample string 4"
    }
  ],
  "HomePhone": "sample string 2",
  "HomeAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "StateProvince": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6"
  },
  "ClientDefinedKey": "sample string 3"
}

application/javascript

Sample:

{"Id":1,"Parent1":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.313319-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},"Parent2":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.313319-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},"Children":[{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.313319-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.313319-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"}],"HomePhone":"sample string 2","HomeAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 3"}

application/xml, text/xml

Sample:

<AGHousehold xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <Parent1>
    <Id>1</Id>
    <Name>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
    </Name>
    <GenderId>1</GenderId>
    <Dob>2025-11-01T17:24:17.313319-06:00</Dob>
    <LoginEmail>sample string 2</LoginEmail>
    <WorkPhone>sample string 3</WorkPhone>
    <WorkAddress>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <City>sample string 3</City>
      <StateProvince>sample string 4</StateProvince>
      <PostalCode>sample string 5</PostalCode>
      <Country>sample string 6</Country>
    </WorkAddress>
    <ClientDefinedKey>sample string 4</ClientDefinedKey>
  </Parent1>
  <Parent2>
    <Id>1</Id>
    <Name>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
    </Name>
    <GenderId>1</GenderId>
    <Dob>2025-11-01T17:24:17.313319-06:00</Dob>
    <LoginEmail>sample string 2</LoginEmail>
    <WorkPhone>sample string 3</WorkPhone>
    <WorkAddress>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <City>sample string 3</City>
      <StateProvince>sample string 4</StateProvince>
      <PostalCode>sample string 5</PostalCode>
      <Country>sample string 6</Country>
    </WorkAddress>
    <ClientDefinedKey>sample string 4</ClientDefinedKey>
  </Parent2>
  <Children>
    <AGPerson>
      <Id>1</Id>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
      </Name>
      <GenderId>1</GenderId>
      <Dob>2025-11-01T17:24:17.313319-06:00</Dob>
      <LoginEmail>sample string 2</LoginEmail>
      <WorkPhone>sample string 3</WorkPhone>
      <WorkAddress>
        <Address1>sample string 1</Address1>
        <Address2>sample string 2</Address2>
        <City>sample string 3</City>
        <StateProvince>sample string 4</StateProvince>
        <PostalCode>sample string 5</PostalCode>
        <Country>sample string 6</Country>
      </WorkAddress>
      <ClientDefinedKey>sample string 4</ClientDefinedKey>
    </AGPerson>
    <AGPerson>
      <Id>1</Id>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
      </Name>
      <GenderId>1</GenderId>
      <Dob>2025-11-01T17:24:17.313319-06:00</Dob>
      <LoginEmail>sample string 2</LoginEmail>
      <WorkPhone>sample string 3</WorkPhone>
      <WorkAddress>
        <Address1>sample string 1</Address1>
        <Address2>sample string 2</Address2>
        <City>sample string 3</City>
        <StateProvince>sample string 4</StateProvince>
        <PostalCode>sample string 5</PostalCode>
        <Country>sample string 6</Country>
      </WorkAddress>
      <ClientDefinedKey>sample string 4</ClientDefinedKey>
    </AGPerson>
  </Children>
  <HomePhone>sample string 2</HomePhone>
  <HomeAddress>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <City>sample string 3</City>
    <StateProvince>sample string 4</StateProvince>
    <PostalCode>sample string 5</PostalCode>
    <Country>sample string 6</Country>
  </HomeAddress>
  <ClientDefinedKey>sample string 3</ClientDefinedKey>
</AGHousehold>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AGHousehold'.

Response Information

Resource Description

WebMethodResultOfAddHouseholdResponse

Name	Type	Additional information
Result	AddHouseholdResponse	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Household": {
      "Id": 1,
      "Parent1": {
        "Id": 1,
        "Name": {
          "LastName": "sample string 1",
          "FirstName": "sample string 2"
        },
        "GenderId": 1,
        "Dob": "2025-11-01T17:24:17.3315204-06:00",
        "LoginEmail": "sample string 2",
        "WorkPhone": "sample string 3",
        "WorkAddress": {
          "Address1": "sample string 1",
          "Address2": "sample string 2",
          "City": "sample string 3",
          "StateProvince": "sample string 4",
          "PostalCode": "sample string 5",
          "Country": "sample string 6"
        },
        "ClientDefinedKey": "sample string 4"
      },
      "Parent2": {
        "Id": 1,
        "Name": {
          "LastName": "sample string 1",
          "FirstName": "sample string 2"
        },
        "GenderId": 1,
        "Dob": "2025-11-01T17:24:17.3315204-06:00",
        "LoginEmail": "sample string 2",
        "WorkPhone": "sample string 3",
        "WorkAddress": {
          "Address1": "sample string 1",
          "Address2": "sample string 2",
          "City": "sample string 3",
          "StateProvince": "sample string 4",
          "PostalCode": "sample string 5",
          "Country": "sample string 6"
        },
        "ClientDefinedKey": "sample string 4"
      },
      "Children": [
        {
          "Id": 1,
          "Name": {
            "LastName": "sample string 1",
            "FirstName": "sample string 2"
          },
          "GenderId": 1,
          "Dob": "2025-11-01T17:24:17.3315204-06:00",
          "LoginEmail": "sample string 2",
          "WorkPhone": "sample string 3",
          "WorkAddress": {
            "Address1": "sample string 1",
            "Address2": "sample string 2",
            "City": "sample string 3",
            "StateProvince": "sample string 4",
            "PostalCode": "sample string 5",
            "Country": "sample string 6"
          },
          "ClientDefinedKey": "sample string 4"
        },
        {
          "Id": 1,
          "Name": {
            "LastName": "sample string 1",
            "FirstName": "sample string 2"
          },
          "GenderId": 1,
          "Dob": "2025-11-01T17:24:17.3315204-06:00",
          "LoginEmail": "sample string 2",
          "WorkPhone": "sample string 3",
          "WorkAddress": {
            "Address1": "sample string 1",
            "Address2": "sample string 2",
            "City": "sample string 3",
            "StateProvince": "sample string 4",
            "PostalCode": "sample string 5",
            "Country": "sample string 6"
          },
          "ClientDefinedKey": "sample string 4"
        }
      ],
      "HomePhone": "sample string 2",
      "HomeAddress": {
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "StateProvince": "sample string 4",
        "PostalCode": "sample string 5",
        "Country": "sample string 6"
      },
      "ClientDefinedKey": "sample string 3"
    },
    "Parent1Id": 1,
    "Parent2Id": 1,
    "Success": true
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"Household":{"Id":1,"Parent1":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.3315204-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},"Parent2":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.3315204-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},"Children":[{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.3315204-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"},{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2025-11-01T17:24:17.3315204-06:00","LoginEmail":"sample string 2","WorkPhone":"sample string 3","WorkAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 4"}],"HomePhone":"sample string 2","HomeAddress":{"Address1":"sample string 1","Address2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"ClientDefinedKey":"sample string 3"},"Parent1Id":1,"Parent2Id":1,"Success":true},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfAddHouseholdResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Household>
      <Id>1</Id>
      <Parent1>
        <Id>1</Id>
        <Name>
          <LastName>sample string 1</LastName>
          <FirstName>sample string 2</FirstName>
        </Name>
        <GenderId>1</GenderId>
        <Dob>2025-11-01T17:24:17.3315204-06:00</Dob>
        <LoginEmail>sample string 2</LoginEmail>
        <WorkPhone>sample string 3</WorkPhone>
        <WorkAddress>
          <Address1>sample string 1</Address1>
          <Address2>sample string 2</Address2>
          <City>sample string 3</City>
          <StateProvince>sample string 4</StateProvince>
          <PostalCode>sample string 5</PostalCode>
          <Country>sample string 6</Country>
        </WorkAddress>
        <ClientDefinedKey>sample string 4</ClientDefinedKey>
      </Parent1>
      <Parent2>
        <Id>1</Id>
        <Name>
          <LastName>sample string 1</LastName>
          <FirstName>sample string 2</FirstName>
        </Name>
        <GenderId>1</GenderId>
        <Dob>2025-11-01T17:24:17.3315204-06:00</Dob>
        <LoginEmail>sample string 2</LoginEmail>
        <WorkPhone>sample string 3</WorkPhone>
        <WorkAddress>
          <Address1>sample string 1</Address1>
          <Address2>sample string 2</Address2>
          <City>sample string 3</City>
          <StateProvince>sample string 4</StateProvince>
          <PostalCode>sample string 5</PostalCode>
          <Country>sample string 6</Country>
        </WorkAddress>
        <ClientDefinedKey>sample string 4</ClientDefinedKey>
      </Parent2>
      <Children>
        <AGPerson>
          <Id>1</Id>
          <Name>
            <LastName>sample string 1</LastName>
            <FirstName>sample string 2</FirstName>
          </Name>
          <GenderId>1</GenderId>
          <Dob>2025-11-01T17:24:17.3315204-06:00</Dob>
          <LoginEmail>sample string 2</LoginEmail>
          <WorkPhone>sample string 3</WorkPhone>
          <WorkAddress>
            <Address1>sample string 1</Address1>
            <Address2>sample string 2</Address2>
            <City>sample string 3</City>
            <StateProvince>sample string 4</StateProvince>
            <PostalCode>sample string 5</PostalCode>
            <Country>sample string 6</Country>
          </WorkAddress>
          <ClientDefinedKey>sample string 4</ClientDefinedKey>
        </AGPerson>
        <AGPerson>
          <Id>1</Id>
          <Name>
            <LastName>sample string 1</LastName>
            <FirstName>sample string 2</FirstName>
          </Name>
          <GenderId>1</GenderId>
          <Dob>2025-11-01T17:24:17.3315204-06:00</Dob>
          <LoginEmail>sample string 2</LoginEmail>
          <WorkPhone>sample string 3</WorkPhone>
          <WorkAddress>
            <Address1>sample string 1</Address1>
            <Address2>sample string 2</Address2>
            <City>sample string 3</City>
            <StateProvince>sample string 4</StateProvince>
            <PostalCode>sample string 5</PostalCode>
            <Country>sample string 6</Country>
          </WorkAddress>
          <ClientDefinedKey>sample string 4</ClientDefinedKey>
        </AGPerson>
      </Children>
      <HomePhone>sample string 2</HomePhone>
      <HomeAddress>
        <Address1>sample string 1</Address1>
        <Address2>sample string 2</Address2>
        <City>sample string 3</City>
        <StateProvince>sample string 4</StateProvince>
        <PostalCode>sample string 5</PostalCode>
        <Country>sample string 6</Country>
      </HomeAddress>
      <ClientDefinedKey>sample string 3</ClientDefinedKey>
    </Household>
    <Parent1Id>1</Parent1Id>
    <Parent2Id>1</Parent2Id>
    <Success>true</Success>
  </Result>
</WebMethodResultOfAddHouseholdResponse>