ApexERPHost

<back to all web services

CrmCompanyBranchByStatusQuery

Requires Authentication
The following routes are available for this service:
GET/Crm/Company/Branch/GetCompanyBranchesByStatus/Lite/Query
CrmCompanyBranchByStatusQuery Parameters:
NameParameterData TypeRequiredDescription
StatusIdqueryintNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CompanyBranchesByStatusLite Parameters:
NameParameterData TypeRequiredDescription
idformintNo
parent_idformint?No
codeformstringNo
nameformstringNo
full_addressformstringNo
spendformboolNo
companyNameformstringNo
companyCodeformstringNo
vat_typeformint?No
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.

GET /Crm/Company/Branch/GetCompanyBranchesByStatus/Lite/Query HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"id":0,"parent_id":0,"code":"String","name":"String","full_address":"String","spend":false,"companyName":"String","companyCode":"String","vat_type":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}