digitaluapi

<back to all web services

StatusCodesViewQuery

The following routes are available for this service:
GET/statuscodesview
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
StatusCodesView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TenantsIdformintNo
StatusTypesIdformintNo
CodeformstringNo
DescriptionformstringNo
StatusTypeDescriptionformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<CampaignCustomersView>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
CampaignCustomersView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
NameformstringNo
DescriptionformstringNo
CustomersIdformlong?No
FirstNameformstringNo
LastNameformstringNo
IdNumberformstringNo
PassportNumberformstringNo
EmailformstringNo
MobileNumberformstringNo
CustomerUniqueIdentifierformstringNo
CustomerPublicAccessGuidformGuid?No
CampaignPublicAccessGuidformGuid?No
TenantsIdformint?No

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 /statuscodesview HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"TenantsId":0,"StatusTypesId":0,"Code":"String","Description":"String","StatusTypeDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}