GET api/State
Api to Get States
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
StateResponseDataModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StateList | Collection of StateDataModel |
None. |
|
| ReturnID | integer |
Required |
|
| Message | string |
Required |
|
| Successful | boolean |
Required |
|
| Code | integer |
None. |
|
| TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{
"stateList": [
{
"stateID": 1,
"stateName": "sample string 2",
"shortName": "sample string 3",
"countryID": 4,
"countryName": "sample string 5"
},
{
"stateID": 1,
"stateName": "sample string 2",
"shortName": "sample string 3",
"countryID": 4,
"countryName": "sample string 5"
}
],
"returnID": 1,
"message": "sample string 2",
"successful": true,
"code": 4,
"totalRecord": 5
}
application/xml, text/xml
Sample:
<StateResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel">
<Code xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">4</Code>
<Message xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">sample string 2</Message>
<ReturnID xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">1</ReturnID>
<Successful xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">true</Successful>
<TotalRecord xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">5</TotalRecord>
<StateList>
<StateDataModel>
<CountryID>4</CountryID>
<CountryName>sample string 5</CountryName>
<ShortName>sample string 3</ShortName>
<StateID>1</StateID>
<StateName>sample string 2</StateName>
<TotalRecord>6</TotalRecord>
</StateDataModel>
<StateDataModel>
<CountryID>4</CountryID>
<CountryName>sample string 5</CountryName>
<ShortName>sample string 3</ShortName>
<StateID>1</StateID>
<StateName>sample string 2</StateName>
<TotalRecord>6</TotalRecord>
</StateDataModel>
</StateList>
</StateResponseDataModel>
multipart/form-data
Sample:
<StateResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">5</TotalRecord><StateList><StateDataModel><CountryID>4</CountryID><CountryName>sample string 5</CountryName><ShortName>sample string 3</ShortName><StateID>1</StateID><StateName>sample string 2</StateName><TotalRecord>6</TotalRecord></StateDataModel><StateDataModel><CountryID>4</CountryID><CountryName>sample string 5</CountryName><ShortName>sample string 3</ShortName><StateID>1</StateID><StateName>sample string 2</StateName><TotalRecord>6</TotalRecord></StateDataModel></StateList></StateResponseDataModel>