GET eo-spouses?ClientId={ClientId}&limit={limit}
Retrieve all Spouses
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
ClientId |
string |
Required |
| limit | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberId | globally unique identifier |
None. |
|
| FullName | string |
None. |
|
| EmailAddress | string |
None. |
|
| SpousePartnerName | string |
None. |
|
| SpousePartnerEmail | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"MemberId": "3de4d296-df70-4450-b28c-060ad363f04b",
"FullName": "sample string 2",
"EmailAddress": "sample string 3",
"SpousePartnerName": "sample string 4",
"SpousePartnerEmail": "sample string 5"
}
application/xml, text/xml
Sample:
<SpouseResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MemberId>3de4d296-df70-4450-b28c-060ad363f04b</MemberId> <FullName>sample string 2</FullName> <EmailAddress>sample string 3</EmailAddress> <SpousePartnerName>sample string 4</SpousePartnerName> <SpousePartnerEmail>sample string 5</SpousePartnerEmail> </SpouseResult>