Gemma.WebApi

<back to all web services

SoggettoRecapitoQuery

Requires Authentication
Required role:Admin
SoggettoRecapitoQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
SoggettoIdqueryint?No
SoggettoIdGreaterThanOrEqualToqueryint?No
SoggettoIdGreaterThanqueryint?No
SoggettoIdLessThanqueryint?No
SoggettoIdLessThanOrEqualToqueryint?No
SoggettoIdNotEqualToqueryint?No
SoggettoIdBetweenqueryint[]No
SoggettoIdInqueryint[]No
TipoRecapitoIdqueryint?No
TipoRecapitoIdGreaterThanOrEqualToqueryint?No
TipoRecapitoIdGreaterThanqueryint?No
TipoRecapitoIdLessThanqueryint?No
TipoRecapitoIdLessThanOrEqualToqueryint?No
TipoRecapitoIdNotEqualToqueryint?No
TipoRecapitoIdBetweenqueryint[]No
TipoRecapitoIdInqueryint[]No
RecapitoquerystringNo
RecapitoStartsWithquerystringNo
RecapitoEndsWithquerystringNo
RecapitoContainsquerystringNo
RecapitoLikequerystringNo
RecapitoBetweenquerystring[]No
RecapitoInquerystring[]No
CodiceEsternoquerystringNo
CodiceEsternoStartsWithquerystringNo
CodiceEsternoEndsWithquerystringNo
CodiceEsternoContainsquerystringNo
CodiceEsternoLikequerystringNo
CodiceEsternoBetweenquerystring[]No
CodiceEsternoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SoggettoRecapito Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SoggettoIdformintNo
TipoRecapitoIdformintNo
RecapitoformstringNo
CodiceEsternoformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SoggettoRecapitoQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"idGreaterThanOrEqualTo":0,"idGreaterThan":0,"idLessThan":0,"idLessThanOrEqualTo":0,"idNotEqualTo":0,"idBetween":[0],"idIn":[0],"soggettoId":0,"soggettoIdGreaterThanOrEqualTo":0,"soggettoIdGreaterThan":0,"soggettoIdLessThan":0,"soggettoIdLessThanOrEqualTo":0,"soggettoIdNotEqualTo":0,"soggettoIdBetween":[0],"soggettoIdIn":[0],"tipoRecapitoId":0,"tipoRecapitoIdGreaterThanOrEqualTo":0,"tipoRecapitoIdGreaterThan":0,"tipoRecapitoIdLessThan":0,"tipoRecapitoIdLessThanOrEqualTo":0,"tipoRecapitoIdNotEqualTo":0,"tipoRecapitoIdBetween":[0],"tipoRecapitoIdIn":[0],"recapito":"String","recapitoStartsWith":"String","recapitoEndsWith":"String","recapitoContains":"String","recapitoLike":"String","recapitoBetween":["String"],"recapitoIn":["String"],"codiceEsterno":"String","codiceEsternoStartsWith":"String","codiceEsternoEndsWith":"String","codiceEsternoContains":"String","codiceEsternoLike":"String","codiceEsternoBetween":["String"],"codiceEsternoIn":["String"],"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"soggettoId":0,"tipoRecapitoId":0,"recapito":"String","codiceEsterno":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}