POST B2GWebsite/District/Get

Request Information

URI Parameters

None.

Body Parameters

DistrictListRequestModel
NameDescriptionTypeAdditional information
DistrictName

string

None.

StateId

integer

None.

IsActive

boolean

None.

Page

integer

None.

PageSize

integer

None.

Search

string

None.

OrderBy

string

None.

OrderByAsc

integer

None.

IsPostBack

boolean

None.

AdvanceSearchModel

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "DistrictName": "sample string 1",
  "StateId": 2,
  "IsActive": true,
  "Page": 4,
  "PageSize": 5,
  "Search": "sample string 6",
  "OrderBy": "sample string 7",
  "OrderByAsc": 8,
  "IsPostBack": true,
  "AdvanceSearchModel": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:
<DistrictListRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.AdminModel.District">
  <AdvanceSearchModel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </AdvanceSearchModel>
  <IsPostBack xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">true</IsPostBack>
  <OrderBy xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">sample string 7</OrderBy>
  <OrderByAsc xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">8</OrderByAsc>
  <Page xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">4</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">5</PageSize>
  <Search xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">sample string 6</Search>
  <DistrictName>sample string 1</DistrictName>
  <IsActive>true</IsActive>
  <StateId>2</StateId>
</DistrictListRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DistrictListRequestModel'.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DistrictName"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StateId"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsActive"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Page"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PageSize"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Search"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderBy"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderByAsc"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsPostBack"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AdvanceSearchModel[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AdvanceSearchModel[0].Value"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AdvanceSearchModel[1].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AdvanceSearchModel[1].Value"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ServiceResponseOfPagedDataOfDistrictViewModel
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

StatusCode

integer

None.

Data

PagedDataOfDistrictViewModel

None.

Exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Message": "sample string 2",
  "StatusCode": 3,
  "Data": {
    "Data": [
      {
        "DistrictId": 1,
        "DistrictCode": 2,
        "DistrictTitle": "sample string 3",
        "DistrictTitleHindi": "sample string 4",
        "DistrictShortTitle": "sample string 5",
        "DistrictShortTitleHindi": "sample string 6",
        "District_DivisionCode": 1,
        "District_StateCode": 1,
        "DistrictIsActive": true,
        "DistrictIsDeleted": true,
        "DISTRICT_ID_TEXT": "sample string 8",
        "DISTRICT_Jeelapramukh": "sample string 9",
        "DistrictImage": "sample string 10",
        "CreatedDate": "2025-06-30T02:25:01.5589151+05:30",
        "CreatedBy": 1,
        "ModifiedDate": "2025-06-30T02:25:01.5589151+05:30",
        "ModifiedBy": 1,
        "State": "sample string 11",
        "DivisionTitle": "sample string 12"
      },
      {
        "DistrictId": 1,
        "DistrictCode": 2,
        "DistrictTitle": "sample string 3",
        "DistrictTitleHindi": "sample string 4",
        "DistrictShortTitle": "sample string 5",
        "DistrictShortTitleHindi": "sample string 6",
        "District_DivisionCode": 1,
        "District_StateCode": 1,
        "DistrictIsActive": true,
        "DistrictIsDeleted": true,
        "DISTRICT_ID_TEXT": "sample string 8",
        "DISTRICT_Jeelapramukh": "sample string 9",
        "DistrictImage": "sample string 10",
        "CreatedDate": "2025-06-30T02:25:01.5589151+05:30",
        "CreatedBy": 1,
        "ModifiedDate": "2025-06-30T02:25:01.5589151+05:30",
        "ModifiedBy": 1,
        "State": "sample string 11",
        "DivisionTitle": "sample string 12"
      }
    ],
    "NumberOfPages": 1,
    "CurrentPage": 2,
    "ColumnNames": [
      "sample string 1",
      "sample string 2"
    ],
    "PageSize": 3,
    "HeaderNames": [
      "sample string 1",
      "sample string 2"
    ],
    "TotalRecords": 4,
    "HelpDocUrl": "sample string 5"
  },
  "Exception": "sample string 4"
}

application/xml, text/xml

Sample:
<ServiceResponseOfPagedDataOfDistrictViewModel_SpPN8l3_PCGS7Xsrn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2G.Services.ServiceHelper">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/B2G.Models.GeneralModel">
    <d2p1:ColumnNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:ColumnNames>
    <d2p1:CurrentPage>2</d2p1:CurrentPage>
    <d2p1:Data xmlns:d3p1="http://schemas.datacontract.org/2004/07/B2G.Models.AdminModel.MasterModel">
      <d3p1:DistrictViewModel>
        <d3p1:CreatedBy>1</d3p1:CreatedBy>
        <d3p1:CreatedDate>2025-06-30T02:25:01.5589151+05:30</d3p1:CreatedDate>
        <d3p1:DISTRICT_ID_TEXT>sample string 8</d3p1:DISTRICT_ID_TEXT>
        <d3p1:DISTRICT_Jeelapramukh>sample string 9</d3p1:DISTRICT_Jeelapramukh>
        <d3p1:DistrictCode>2</d3p1:DistrictCode>
        <d3p1:DistrictId>1</d3p1:DistrictId>
        <d3p1:DistrictImage>sample string 10</d3p1:DistrictImage>
        <d3p1:DistrictIsActive>true</d3p1:DistrictIsActive>
        <d3p1:DistrictIsDeleted>true</d3p1:DistrictIsDeleted>
        <d3p1:DistrictShortTitle>sample string 5</d3p1:DistrictShortTitle>
        <d3p1:DistrictShortTitleHindi>sample string 6</d3p1:DistrictShortTitleHindi>
        <d3p1:DistrictTitle>sample string 3</d3p1:DistrictTitle>
        <d3p1:DistrictTitleHindi>sample string 4</d3p1:DistrictTitleHindi>
        <d3p1:District_DivisionCode>1</d3p1:District_DivisionCode>
        <d3p1:District_StateCode>1</d3p1:District_StateCode>
        <d3p1:DivisionTitle>sample string 12</d3p1:DivisionTitle>
        <d3p1:ModifiedBy>1</d3p1:ModifiedBy>
        <d3p1:ModifiedDate>2025-06-30T02:25:01.5589151+05:30</d3p1:ModifiedDate>
        <d3p1:State>sample string 11</d3p1:State>
      </d3p1:DistrictViewModel>
      <d3p1:DistrictViewModel>
        <d3p1:CreatedBy>1</d3p1:CreatedBy>
        <d3p1:CreatedDate>2025-06-30T02:25:01.5589151+05:30</d3p1:CreatedDate>
        <d3p1:DISTRICT_ID_TEXT>sample string 8</d3p1:DISTRICT_ID_TEXT>
        <d3p1:DISTRICT_Jeelapramukh>sample string 9</d3p1:DISTRICT_Jeelapramukh>
        <d3p1:DistrictCode>2</d3p1:DistrictCode>
        <d3p1:DistrictId>1</d3p1:DistrictId>
        <d3p1:DistrictImage>sample string 10</d3p1:DistrictImage>
        <d3p1:DistrictIsActive>true</d3p1:DistrictIsActive>
        <d3p1:DistrictIsDeleted>true</d3p1:DistrictIsDeleted>
        <d3p1:DistrictShortTitle>sample string 5</d3p1:DistrictShortTitle>
        <d3p1:DistrictShortTitleHindi>sample string 6</d3p1:DistrictShortTitleHindi>
        <d3p1:DistrictTitle>sample string 3</d3p1:DistrictTitle>
        <d3p1:DistrictTitleHindi>sample string 4</d3p1:DistrictTitleHindi>
        <d3p1:District_DivisionCode>1</d3p1:District_DivisionCode>
        <d3p1:District_StateCode>1</d3p1:District_StateCode>
        <d3p1:DivisionTitle>sample string 12</d3p1:DivisionTitle>
        <d3p1:ModifiedBy>1</d3p1:ModifiedBy>
        <d3p1:ModifiedDate>2025-06-30T02:25:01.5589151+05:30</d3p1:ModifiedDate>
        <d3p1:State>sample string 11</d3p1:State>
      </d3p1:DistrictViewModel>
    </d2p1:Data>
    <d2p1:HeaderNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:HeaderNames>
    <d2p1:HelpDocUrl>sample string 5</d2p1:HelpDocUrl>
    <d2p1:NumberOfPages>1</d2p1:NumberOfPages>
    <d2p1:PageSize>3</d2p1:PageSize>
    <d2p1:TotalRecords>4</d2p1:TotalRecords>
  </Data>
  <Exception>sample string 4</Exception>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <StatusCode>3</StatusCode>
</ServiceResponseOfPagedDataOfDistrictViewModel_SpPN8l3_PCGS7Xsrn>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsSuccess"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictCode"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictTitle"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictTitleHindi"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictShortTitle"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictShortTitleHindi"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].District_DivisionCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].District_StateCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictIsActive"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictIsDeleted"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DISTRICT_ID_TEXT"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DISTRICT_Jeelapramukh"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DistrictImage"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].CreatedDate"

2025-06-30T02:25:01.5589151+05:30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].CreatedBy"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].ModifiedDate"

2025-06-30T02:25:01.5589151+05:30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].ModifiedBy"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].State"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[0].DivisionTitle"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictCode"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictTitle"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictTitleHindi"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictShortTitle"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictShortTitleHindi"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].District_DivisionCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].District_StateCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictIsActive"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictIsDeleted"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DISTRICT_ID_TEXT"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DISTRICT_Jeelapramukh"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DistrictImage"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].CreatedDate"

2025-06-30T02:25:01.5589151+05:30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].CreatedBy"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].ModifiedDate"

2025-06-30T02:25:01.5589151+05:30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].ModifiedBy"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].State"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Data[1].DivisionTitle"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.NumberOfPages"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.CurrentPage"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.ColumnNames[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.ColumnNames[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.PageSize"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.HeaderNames[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.HeaderNames[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.TotalRecords"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.HelpDocUrl"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Exception"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--