GET cre/city/{secretKey}?DisplayFields={DisplayFields}&NoneDisplayFields={NoneDisplayFields}&SortFields={SortFields}&Limit1={Limit1}&Limit2={Limit2}&LanguageId={LanguageId}&IsWriteLogSQL={IsWriteLogSQL}

This function will get city list.

Request Information

URI Parameters

Name	Description	Type	Additional information
secretKey	is used to authenticate user	string	Required
DisplayFields	List of fields need to be displayed	string	None.
NoneDisplayFields	Gets or sets the none display fields.	string	None.
SortFields	Sort Conditions	string	None.
Limit1	Get the list of items that their indexes larger than or equal this value	integer	None.
Limit2	Get the list of items that their indexes less than or equal this value	integer	None.
LanguageId	1: NL, 2: FR, 3: EN, Default value = 1	integer	None.
IsWriteLogSQL	Write sql query for debug	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Return city list

ReturnResultOfWsListOfCRECity

Name	Description	Type	Additional information
Success	Value = true is successful (If this value = false, then we should see Code and Message to have more info about error.)	boolean	None.
Code	It's error code (If value = 0, it's successful)	integer	None.
Message	It's error message (If value = empty, it's successful).	string	None.
Value	Data which you need to get.	WsListOfCRECity	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Code": 2,
  "Message": "sample string 3",
  "Value": {
    "Items": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Zip": "sample string 3",
        "ZipAndName": "sample string 4"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Zip": "sample string 3",
        "ZipAndName": "sample string 4"
      }
    ],
    "RowsCount": 1,
    "From": 2,
    "To": 3
  }
}

application/xml, text/xml

Sample:

<ReturnResultOfWsListOfCRECityOpzxWdDHOpzxWdDH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Models">
  <Code>2</Code>
  <Message>sample string 3</Message>
  <Success>true</Success>
  <Value>
    <From>2</From>
    <Items>
      <CRECity>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Zip>sample string 3</Zip>
        <ZipAndName>sample string 4</ZipAndName>
      </CRECity>
      <CRECity>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Zip>sample string 3</Zip>
        <ZipAndName>sample string 4</ZipAndName>
      </CRECity>
    </Items>
    <RowsCount>1</RowsCount>
    <To>3</To>
  </Value>
</ReturnResultOfWsListOfCRECityOpzxWdDHOpzxWdDH>