POST api/GetMemberInfoSummary_V2
Returns basic membership and household information.
Request Information
URI Parameters
None.
Body Parameters
MemberInfoRequestName | Description | Type | Additional information |
---|---|---|---|
SessionKey |
Authenticated session key |
string |
Required |
IncludeHousehold |
Deprecated : Household data will always be returned if availalbe |
boolean |
Request Formats
application/json, text/json
Sample:
{ "SessionKey": "sample string 1", "IncludeHousehold": true }
application/xml, text/xml
Sample:
<MemberInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account"> <IncludeHousehold>true</IncludeHousehold> <SessionKey>sample string 1</SessionKey> </MemberInfoRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetMemberInfoSummaryResult object
ApiSuccessOfGetMemberInfoSummaryResultV2Name | Description | Type | Additional information |
---|---|---|---|
Success | boolean | ||
Data | GetMemberInfoSummaryResultV2 |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "Data": { "HouseholdInfo": { "MemberOrgNumber": 1, "CurrentStatusDescription": "sample string 2", "MemberLevelDescription": "sample string 3", "CategoryDescription": "sample string 4", "MemberOrgDescription": "sample string 5", "ConstituentId": 6, "HouseholdId": 7, "MembershipStatus": "sample string 8", "MembershipLevel": "sample string 9", "MembershipExpiration": "2024-12-19T19:03:10.3421326+00:00", "UserName": "sample string 10" }, "MemberOrgNumber": 1, "CurrentStatusDescription": "sample string 2", "MemberLevelDescription": "sample string 3", "CategoryDescription": "sample string 4", "MemberOrgDescription": "sample string 5", "ConstituentId": 6, "HouseholdId": 7, "MembershipStatus": "sample string 8", "MembershipLevel": "sample string 9", "MembershipExpiration": "2024-12-19T19:03:10.3421326+00:00", "UserName": "sample string 10" } }
application/xml, text/xml
Sample:
<ApiSuccessOfGetMemberInfoSummaryResultV2gLC8bFpX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account"> <d2p1:ConstituentId>6</d2p1:ConstituentId> <d2p1:HouseholdId>7</d2p1:HouseholdId> <d2p1:MembershipExpiration>2024-12-19T19:03:10.3421326+00:00</d2p1:MembershipExpiration> <d2p1:MembershipLevel>sample string 9</d2p1:MembershipLevel> <d2p1:MembershipStatus>sample string 8</d2p1:MembershipStatus> <d2p1:UserName>sample string 10</d2p1:UserName> <d2p1:CategoryDescription>sample string 4</d2p1:CategoryDescription> <d2p1:CurrentStatusDescription>sample string 2</d2p1:CurrentStatusDescription> <d2p1:HouseholdInfo> <d2p1:ConstituentId>6</d2p1:ConstituentId> <d2p1:HouseholdId>7</d2p1:HouseholdId> <d2p1:MembershipExpiration>2024-12-19T19:03:10.3421326+00:00</d2p1:MembershipExpiration> <d2p1:MembershipLevel>sample string 9</d2p1:MembershipLevel> <d2p1:MembershipStatus>sample string 8</d2p1:MembershipStatus> <d2p1:UserName>sample string 10</d2p1:UserName> <d2p1:CategoryDescription>sample string 4</d2p1:CategoryDescription> <d2p1:CurrentStatusDescription>sample string 2</d2p1:CurrentStatusDescription> <d2p1:MemberLevelDescription>sample string 3</d2p1:MemberLevelDescription> <d2p1:MemberOrgDescription>sample string 5</d2p1:MemberOrgDescription> <d2p1:MemberOrgNumber>1</d2p1:MemberOrgNumber> </d2p1:HouseholdInfo> <d2p1:MemberLevelDescription>sample string 3</d2p1:MemberLevelDescription> <d2p1:MemberOrgDescription>sample string 5</d2p1:MemberOrgDescription> <d2p1:MemberOrgNumber>1</d2p1:MemberOrgNumber> </Data> </ApiSuccessOfGetMemberInfoSummaryResultV2gLC8bFpX>