GET Register/PostalROI/LoadAll?SessionId={SessionId}&CompanyId={CompanyId}&searchKey={searchKey}&includeDeleted={includeDeleted}

Request Information

URI Parameters

Name	Type	Additional information
SessionId	string	None.
CompanyId	integer	None.
searchKey	string	Required
includeDeleted	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ListReplyOfPostalROIRecord

Name	Type	Additional information
total	integer	None.
data	Collection of PostalROIRecord	None.
errorCode	integer	None.
error	string	None.
top	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "postalCodeList": "sample string 3"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "postalCodeList": "sample string 3"
    }
  ],
  "errorCode": 1,
  "error": "sample string 2",
  "top": 3,
  "total": 2
}

text/javascript

Sample:

{"data":[{"id":1,"name":"sample string 2","postalCodeList":"sample string 3"},{"id":1,"name":"sample string 2","postalCodeList":"sample string 3"}],"errorCode":1,"error":"sample string 2","top":3,"total":2}

application/xml, text/xml

Sample:

<ListReplyOfPostalROIRecordjGpisWsr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/T8UtilityLib.Models">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/T8LSPModel.Register">
    <d2p1:PostalROIRecord>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:postalCodeList>sample string 3</d2p1:postalCodeList>
    </d2p1:PostalROIRecord>
    <d2p1:PostalROIRecord>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:postalCodeList>sample string 3</d2p1:postalCodeList>
    </d2p1:PostalROIRecord>
  </data>
  <error>sample string 2</error>
  <errorCode>1</errorCode>
  <top>3</top>
</ListReplyOfPostalROIRecordjGpisWsr>

application/x-protobuf

Sample:

An exception has occurred while using the formatter 'ProtoBufFormatter' to generate sample for media type 'application/x-protobuf'. Exception message: Type is not expected, and no contract can be inferred: T8UtilityLib.Models.ListReply`1[[T8LSPModel.Register.PostalROIRecord, T8LSPModel, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]