POST api/FrontierWeb/InterfaceCrud/GetList

Request Information

URI Parameters

None.

Body Parameters

GenericGetListRequest
NameDescriptionTypeAdditional information
ObjectTypeName

string

None.

StartRowIndex

integer

None.

PageSize

integer

None.

SortExpression

string

None.

FilterExpression

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ObjectTypeName": "sample string 1",
  "StartRowIndex": 1,
  "PageSize": 1,
  "SortExpression": "sample string 2",
  "FilterExpression": "sample string 3"
}

text/html

Sample:
{"ObjectTypeName":"sample string 1","StartRowIndex":1,"PageSize":1,"SortExpression":"sample string 2","FilterExpression":"sample string 3"}

Response Information

Resource Description

GenericGetListResponse
NameDescriptionTypeAdditional information
RetrievedList

Collection of Object

None.

Count

integer

None.

IsSuccessful

Indicates if the transaction was successful or not.

boolean

None.

ReturnedMessages

Contains a list of Informational, Warning, and/or Error messages regarding the outcome of the transaction.

Collection of ReturnedMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "RetrievedList": [
    {},
    {}
  ],
  "Count": 1,
  "IsSuccessful": true,
  "ReturnedMessages": null
}

text/html

Sample:
{"RetrievedList":[{},{}],"Count":1,"IsSuccessful":true,"ReturnedMessages":null}