GET api/Vet/V1/Employers?key={key}&opt={opt}&value={value}
Get all employer information list
[Optional] You can filter employer result with specific search filter set by query strings (must provide 3 valid keys set.)
E.g.- GET 'api/Vet/V1/Employers'
- GET 'api/Vet/V1/Employers?key=name&opt=equal&value=Wilson Parking'
- GET 'api/Vet/V1/Employers?key=name&opt=contain&value=Wilson'
- GET 'api/Vet/V1/Employers?key=code&opt=startwith&value=1'
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
Enum search key (code, name, user) |
EnumSearchKey |
None. |
| opt |
Enum operator to do filter (equal, notequal, startwith, endwith, contain) |
EnumOperator |
None. |
| value |
Value to filter against the key and operator. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ModelVetEmployerV1
Collection of ModelVetEmployerV1| Name | Description | Type | Additional information |
|---|---|---|---|
| EmployerCode |
Unique employer code/identifier |
string |
None. |
| EmployerName |
Employer legal name |
string |
None. |
| UserName |
User name. It can be null. |
string |
None. |
|
Contact email address |
string |
None. |
|
| ABN |
Company ABN number |
string |
None. |
| ContactPerson |
Contact person name |
string |
None. |
| TradingName |
Company trading name |
string |
None. |
Response Formats
application/json, text/json
[
{
"EmployerCode": "sample string 1",
"EmployerName": "sample string 2",
"UserName": "sample string 3",
"Email": "sample string 4",
"ABN": "sample string 5",
"ContactPerson": "sample string 6",
"TradingName": "sample string 7"
},
{
"EmployerCode": "sample string 1",
"EmployerName": "sample string 2",
"UserName": "sample string 3",
"Email": "sample string 4",
"ABN": "sample string 5",
"ContactPerson": "sample string 6",
"TradingName": "sample string 7"
}
]
application/xml, text/xml
<ArrayOfModelVetEmployerV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
<ModelVetEmployerV1>
<ABN>sample string 5</ABN>
<ContactPerson>sample string 6</ContactPerson>
<Email>sample string 4</Email>
<EmployerCode>sample string 1</EmployerCode>
<EmployerName>sample string 2</EmployerName>
<TradingName>sample string 7</TradingName>
<UserName>sample string 3</UserName>
</ModelVetEmployerV1>
<ModelVetEmployerV1>
<ABN>sample string 5</ABN>
<ContactPerson>sample string 6</ContactPerson>
<Email>sample string 4</Email>
<EmployerCode>sample string 1</EmployerCode>
<EmployerName>sample string 2</EmployerName>
<TradingName>sample string 7</TradingName>
<UserName>sample string 3</UserName>
</ModelVetEmployerV1>
</ArrayOfModelVetEmployerV1>