POST api/PreferredList/GetAllOffice

Request Information

URI Parameters

None.

Body Parameters

OfficeFilterViewModel
NameDescriptionTypeAdditional information
OfficeName

string

None.

DepartmentId

integer

None.

DistrictId

integer

None.

AdminDepartmentCode

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "OfficeName": "sample string 1",
  "DepartmentId": 2,
  "DistrictId": 3,
  "AdminDepartmentCode": 4
}

application/xml, text/xml

Sample:
<OfficeFilterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2G.Models.UserModel.PerferredList">
  <AdminDepartmentCode>4</AdminDepartmentCode>
  <DepartmentId>2</DepartmentId>
  <DistrictId>3</DistrictId>
  <OfficeName>sample string 1</OfficeName>
</OfficeFilterViewModel>

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 'OfficeFilterViewModel'.

multipart/form-data

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

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

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

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AdminDepartmentCode"

4
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ServiceResponseOfListOfOfficeListViewModel
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

StatusCode

integer

None.

Data

Collection of OfficeListViewModel

None.

Exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Message": "sample string 2",
  "StatusCode": 3,
  "Data": [
    {
      "OfficeId": 1,
      "OfficeName": "sample string 2",
      "DepartmentName": "sample string 3",
      "DistrictName": "sample string 4",
      "OfficeAddress": "sample string 5"
    },
    {
      "OfficeId": 1,
      "OfficeName": "sample string 2",
      "DepartmentName": "sample string 3",
      "DistrictName": "sample string 4",
      "OfficeAddress": "sample string 5"
    }
  ],
  "Exception": "sample string 4"
}

application/xml, text/xml

Sample:
<ServiceResponseOfArrayOfOfficeListViewModelAxs_PMXaL 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.UserModel.PerferredList">
    <d2p1:OfficeListViewModel>
      <d2p1:DepartmentName>sample string 3</d2p1:DepartmentName>
      <d2p1:DistrictName>sample string 4</d2p1:DistrictName>
      <d2p1:OfficeAddress>sample string 5</d2p1:OfficeAddress>
      <d2p1:OfficeId>1</d2p1:OfficeId>
      <d2p1:OfficeName>sample string 2</d2p1:OfficeName>
    </d2p1:OfficeListViewModel>
    <d2p1:OfficeListViewModel>
      <d2p1:DepartmentName>sample string 3</d2p1:DepartmentName>
      <d2p1:DistrictName>sample string 4</d2p1:DistrictName>
      <d2p1:OfficeAddress>sample string 5</d2p1:OfficeAddress>
      <d2p1:OfficeId>1</d2p1:OfficeId>
      <d2p1:OfficeName>sample string 2</d2p1:OfficeName>
    </d2p1:OfficeListViewModel>
  </Data>
  <Exception>sample string 4</Exception>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <StatusCode>3</StatusCode>
</ServiceResponseOfArrayOfOfficeListViewModelAxs_PMXaL>

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[0].OfficeId"

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

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

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

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

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

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

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

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

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

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

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--