GET api/Establishment/GetEstablishment?merchantkey={merchantkey}
Gets the establishment.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
merchantkey |
The merchantkey. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
This function returns get establishment.
EstablishmentResultName | Description | Type | Additional information |
---|---|---|---|
ListEstablishment |
Gets or sets the list establishment. |
Collection of EstablishmentModels |
None. |
Status |
Gets or sets the status. |
string |
None. |
ErrorCode |
Gets or sets the error code. |
integer |
None. |
ErrorText |
Gets or sets the error text. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ListEstablishment": [ { "EstablishmentId": 1, "EstablishmentName": "sample string 2", "EstablishmentGroupId": 3 }, { "EstablishmentId": 1, "EstablishmentName": "sample string 2", "EstablishmentGroupId": 3 } ], "Status": "sample string 1", "ErrorCode": 2, "ErrorText": "sample string 3" }
multipart/form-data
Sample:
{"ListEstablishment":[{"EstablishmentId":1,"EstablishmentName":"sample string 2","EstablishmentGroupId":3},{"EstablishmentId":1,"EstablishmentName":"sample string 2","EstablishmentGroupId":3}],"Status":"sample string 1","ErrorCode":2,"ErrorText":"sample string 3"}
application/xml, text/xml
Sample:
<EstablishmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Models"> <ErrorCode>2</ErrorCode> <ErrorText>sample string 3</ErrorText> <ListEstablishment> <EstablishmentModels> <EstablishmentGroupId>3</EstablishmentGroupId> <EstablishmentId>1</EstablishmentId> <EstablishmentName>sample string 2</EstablishmentName> </EstablishmentModels> <EstablishmentModels> <EstablishmentGroupId>3</EstablishmentGroupId> <EstablishmentId>1</EstablishmentId> <EstablishmentName>sample string 2</EstablishmentName> </EstablishmentModels> </ListEstablishment> <Status>sample string 1</Status> </EstablishmentResult>