POST api/customdata/asphaltgreen/AddHouseholdMember

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HouseholdId	integer	None.
RoleID	integer	None.
Person	AGPerson	None.

Request Formats

application/json, text/json

Sample:

{
  "HouseholdId": 1,
  "RoleID": 2,
  "Person": {
    "Id": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2"
    },
    "GenderId": 1,
    "Dob": "2024-05-07T04:36:48.06633-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"
  }
}

application/javascript

Sample:

{"HouseholdId":1,"RoleID":2,"Person":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2024-05-07T04:36:48.06633-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"}}

application/xml, text/xml

Sample:

<AddHouseholdMemberRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HouseholdId>1</HouseholdId>
  <RoleID>2</RoleID>
  <Person>
    <Id>1</Id>
    <Name>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
    </Name>
    <GenderId>1</GenderId>
    <Dob>2024-05-07T04:36:48.06633-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>
  </Person>
</AddHouseholdMemberRequest>

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 'AddHouseholdMemberRequest'.

Response Information

Resource Description

WebMethodResultOfAGPerson

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

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Id": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2"
    },
    "GenderId": 1,
    "Dob": "2024-05-07T04:36:48.06633-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"
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"Id":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2"},"GenderId":1,"Dob":"2024-05-07T04:36:48.06633-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"},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfAGPerson 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>
    <Id>1</Id>
    <Name>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
    </Name>
    <GenderId>1</GenderId>
    <Dob>2024-05-07T04:36:48.06633-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>
  </Result>
</WebMethodResultOfAGPerson>