POST api/v1/GetEntityDocuments
Request Information
URI Parameters
None.
Body Parameters
EntityDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| Credential | Credential |
None. |
|
| CreateCodeFrom | integer |
None. |
|
| FindAvailableCode | boolean |
None. |
|
| IfExists | string |
None. |
|
| Name | string |
None. |
|
| EntityType | string |
None. |
|
| TaxPayerID | string |
None. |
|
| AreaCode | string |
None. |
|
| Address | string |
None. |
|
| ZipCode | string |
None. |
|
| Location | string |
None. |
|
| EntityCode | integer |
None. |
|
| Phone | string |
None. |
|
| string |
None. |
||
| PostalCode | string |
None. |
|
| Password | string |
None. |
|
| DOB | string |
None. |
|
| NameDayDate | string |
None. |
|
| AcceptMarketing | boolean |
None. |
|
| Remarks | string |
None. |
|
| Addresses | Collection of Address |
None. |
Request Formats
application/json, text/json
Sample:
{
"Credential": {
"CompanyCode": "sample string 1",
"CompanyName": "sample string 2",
"UserLogin": "sample string 3",
"UserPassword": "sample string 4",
"DropDate": "sample string 5",
"WebServiceURL": "sample string 6",
"PageNumber": 7,
"EntityCode": 8,
"ConnectionString": "sample string 9",
"TerminalNo": "sample string 10",
"PhoneNumber": "sample string 11"
},
"CreateCodeFrom": 1,
"FindAvailableCode": true,
"IfExists": "sample string 3",
"Name": "sample string 4",
"EntityType": "sample string 5",
"TaxPayerID": "sample string 6",
"AreaCode": "sample string 7",
"Address": "sample string 8",
"ZipCode": "sample string 9",
"Location": "sample string 10",
"EntityCode": 11,
"Phone": "sample string 12",
"Email": "sample string 13",
"PostalCode": "sample string 14",
"Password": "sample string 15",
"DOB": "sample string 16",
"NameDayDate": "sample string 17",
"AcceptMarketing": true,
"Remarks": "sample string 19",
"Addresses": [
{
"Designation": "sample string 1",
"ZipCode": "sample string 2",
"Location": "sample string 3",
"CountryCode": "sample string 4",
"Phone": "sample string 5",
"Address": "sample string 6"
},
{
"Designation": "sample string 1",
"ZipCode": "sample string 2",
"Location": "sample string 3",
"CountryCode": "sample string 4",
"Phone": "sample string 5",
"Address": "sample string 6"
}
]
}
application/xml, text/xml
Sample:
<EntityDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WinMax4API.Models">
<AcceptMarketing>true</AcceptMarketing>
<Address>sample string 8</Address>
<Addresses>
<Address>
<Address>sample string 6</Address>
<CountryCode>sample string 4</CountryCode>
<Designation>sample string 1</Designation>
<Location>sample string 3</Location>
<Phone>sample string 5</Phone>
<ZipCode>sample string 2</ZipCode>
</Address>
<Address>
<Address>sample string 6</Address>
<CountryCode>sample string 4</CountryCode>
<Designation>sample string 1</Designation>
<Location>sample string 3</Location>
<Phone>sample string 5</Phone>
<ZipCode>sample string 2</ZipCode>
</Address>
</Addresses>
<AreaCode>sample string 7</AreaCode>
<CreateCodeFrom>1</CreateCodeFrom>
<Credential>
<CompanyCode>sample string 1</CompanyCode>
<CompanyName>sample string 2</CompanyName>
<ConnectionString>sample string 9</ConnectionString>
<DropDate>sample string 5</DropDate>
<EntityCode>8</EntityCode>
<PageNumber>7</PageNumber>
<PhoneNumber>sample string 11</PhoneNumber>
<TerminalNo>sample string 10</TerminalNo>
<UserLogin>sample string 3</UserLogin>
<UserPassword>sample string 4</UserPassword>
<WebServiceURL>sample string 6</WebServiceURL>
</Credential>
<DOB>sample string 16</DOB>
<Email>sample string 13</Email>
<EntityCode>11</EntityCode>
<EntityType>sample string 5</EntityType>
<FindAvailableCode>true</FindAvailableCode>
<IfExists>sample string 3</IfExists>
<Location>sample string 10</Location>
<Name>sample string 4</Name>
<NameDayDate>sample string 17</NameDayDate>
<Password>sample string 15</Password>
<Phone>sample string 12</Phone>
<PostalCode>sample string 14</PostalCode>
<Remarks>sample string 19</Remarks>
<TaxPayerID>sample string 6</TaxPayerID>
<ZipCode>sample string 9</ZipCode>
</EntityDetails>
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. |