GET api/CoreAPI/PersonAgreementInquiry
Request Information
URI Parameters
None.
Body Parameters
PersonAgreementInquiryRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityNumber | decimal number |
None. |
|
| EntityTypeCode | string |
None. |
|
| IsPrimaryOwner | boolean |
None. |
|
| ShouldFetchAllAgreementStatuses | boolean |
None. |
|
| UserId | string |
None. |
|
| ParentRequestNumber | string |
None. |
|
| RequestNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"EntityNumber": 1.0,
"EntityTypeCode": "sample string 1",
"IsPrimaryOwner": true,
"ShouldFetchAllAgreementStatuses": true,
"UserId": "sample string 2",
"ParentRequestNumber": "sample string 3",
"RequestNumber": "sample string 4"
}
application/xml, text/xml
Sample:
<PersonAgreementInquiryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opensolutions.com/CoreApi"> <ParentRequestNumber>sample string 3</ParentRequestNumber> <RequestNumber>sample string 4</RequestNumber> <EntityNumber>1</EntityNumber> <EntityTypeCode>sample string 1</EntityTypeCode> <IsPrimaryOwner>true</IsPrimaryOwner> <ShouldFetchAllAgreementStatuses>true</ShouldFetchAllAgreementStatuses> <UserId>sample string 2</UserId> </PersonAgreementInquiryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |