POST api/GenericCrud/GetGciList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
GciOption	GciOption	None.
ActiveOnly	boolean	None.
FilterParameterString	string	None.
FilterParameterStringSeparator	string	None.
ValuesToInclude	Collection of string	None.
ValuesToExclude	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "GciOption": null,
  "ActiveOnly": true,
  "FilterParameterString": "sample string 2",
  "FilterParameterStringSeparator": "sample string 3",
  "ValuesToInclude": [
    "sample string 1",
    "sample string 2"
  ],
  "ValuesToExclude": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"GciOption":null,"ActiveOnly":true,"FilterParameterString":"sample string 2","FilterParameterStringSeparator":"sample string 3","ValuesToInclude":["sample string 1","sample string 2"],"ValuesToExclude":["sample string 1","sample string 2"]}

Response Information

Resource Description

GenericGetListResponse

Name	Description	Type	Additional 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}