| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProspectID | query | string | No | |
| ProspectIDStartsWith | query | string | No | |
| ProspectIDEndsWith | query | string | No | |
| ProspectIDContains | query | string | No | |
| ProspectIDLike | query | string | No | |
| ProspectIDBetween | query | string[] | No | |
| ProspectIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
| ProspectNumber | query | string | No | |
| ProspectNumberStartsWith | query | string | No | |
| ProspectNumberEndsWith | query | string | No | |
| ProspectNumberContains | query | string | No | |
| ProspectNumberLike | query | string | No | |
| ProspectNumberBetween | query | string[] | No | |
| ProspectNumberIn | query | string[] | No | |
| CompanyName | query | string | No | |
| CompanyNameStartsWith | query | string | No | |
| CompanyNameEndsWith | query | string | No | |
| CompanyNameContains | query | string | No | |
| CompanyNameLike | query | string | No | |
| CompanyNameBetween | query | string[] | No | |
| CompanyNameIn | query | string[] | No | |
| Address1 | query | string | No | |
| Address1StartsWith | query | string | No | |
| Address1EndsWith | query | string | No | |
| Address1Contains | query | string | No | |
| Address1Like | query | string | No | |
| Address1Between | query | string[] | No | |
| Address1In | query | string[] | No | |
| Address2 | query | string | No | |
| Address2StartsWith | query | string | No | |
| Address2EndsWith | query | string | No | |
| Address2Contains | query | string | No | |
| Address2Like | query | string | No | |
| Address2Between | query | string[] | No | |
| Address2In | query | string[] | No | |
| Address3 | query | string | No | |
| Address3StartsWith | query | string | No | |
| Address3EndsWith | query | string | No | |
| Address3Contains | query | string | No | |
| Address3Like | query | string | No | |
| Address3Between | query | string[] | No | |
| Address3In | query | string[] | No | |
| State | query | string | No | |
| StateStartsWith | query | string | No | |
| StateEndsWith | query | string | No | |
| StateContains | query | string | No | |
| StateLike | query | string | No | |
| StateBetween | query | string[] | No | |
| StateIn | query | string[] | No | |
| PostCode | query | string | No | |
| PostCodeStartsWith | query | string | No | |
| PostCodeEndsWith | query | string | No | |
| PostCodeContains | query | string | No | |
| PostCodeLike | query | string | No | |
| PostCodeBetween | query | string[] | No | |
| PostCodeIn | query | string[] | No | |
| Phone | query | string | No | |
| PhoneStartsWith | query | string | No | |
| PhoneEndsWith | query | string | No | |
| PhoneContains | query | string | No | |
| PhoneLike | query | string | No | |
| PhoneBetween | query | string[] | No | |
| PhoneIn | query | string[] | No | |
| Fax | query | string | No | |
| FaxStartsWith | query | string | No | |
| FaxEndsWith | query | string | No | |
| FaxContains | query | string | No | |
| FaxLike | query | string | No | |
| FaxBetween | query | string[] | No | |
| FaxIn | query | string[] | No | |
| EmailAddress | query | string | No | |
| EmailAddressStartsWith | query | string | No | |
| EmailAddressEndsWith | query | string | No | |
| EmailAddressContains | query | string | No | |
| EmailAddressLike | query | string | No | |
| EmailAddressBetween | query | string[] | No | |
| EmailAddressIn | query | string[] | No | |
| CRAccountNo | query | string | No | |
| CRAccountNoStartsWith | query | string | No | |
| CRAccountNoEndsWith | query | string | No | |
| CRAccountNoContains | query | string | No | |
| CRAccountNoLike | query | string | No | |
| CRAccountNoBetween | query | string[] | No | |
| CRAccountNoIn | query | string[] | No | |
| DBAccountNo | query | string | No | |
| DBAccountNoStartsWith | query | string | No | |
| DBAccountNoEndsWith | query | string | No | |
| DBAccountNoContains | query | string | No | |
| DBAccountNoLike | query | string | No | |
| DBAccountNoBetween | query | string[] | No | |
| DBAccountNoIn | query | string[] | No | |
| CreditorID | query | string | No | |
| CreditorIDStartsWith | query | string | No | |
| CreditorIDEndsWith | query | string | No | |
| CreditorIDContains | query | string | No | |
| CreditorIDLike | query | string | No | |
| CreditorIDBetween | query | string[] | No | |
| CreditorIDIn | query | string[] | No | |
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| ExternalAppRecID | query | string | No | |
| ExternalAppRecIDStartsWith | query | string | No | |
| ExternalAppRecIDEndsWith | query | string | No | |
| ExternalAppRecIDContains | query | string | No | |
| ExternalAppRecIDLike | query | string | No | |
| ExternalAppRecIDBetween | query | string[] | No | |
| ExternalAppRecIDIn | query | string[] | No | |
| AustPostDPID | query | string | No | |
| AustPostDPIDStartsWith | query | string | No | |
| AustPostDPIDEndsWith | query | string | No | |
| AustPostDPIDContains | query | string | No | |
| AustPostDPIDLike | query | string | No | |
| AustPostDPIDBetween | query | string[] | No | |
| AustPostDPIDIn | query | string[] | No | |
| AustPostBCSP | query | string | No | |
| AustPostBCSPStartsWith | query | string | No | |
| AustPostBCSPEndsWith | query | string | No | |
| AustPostBCSPContains | query | string | No | |
| AustPostBCSPLike | query | string | No | |
| AustPostBCSPBetween | query | string[] | No | |
| AustPostBCSPIn | query | string[] | No | |
| Country | query | string | No | |
| CountryStartsWith | query | string | No | |
| CountryEndsWith | query | string | No | |
| CountryContains | query | string | No | |
| CountryLike | query | string | No | |
| CountryBetween | query | string[] | No | |
| CountryIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProspectID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| ProspectNumber | form | string | No | |
| CompanyName | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| State | form | string | No | |
| PostCode | form | string | No | |
| Phone | form | string | No | |
| Fax | form | string | No | |
| EmailAddress | form | string | No | |
| CRAccountNo | form | string | No | |
| DBAccountNo | form | string | No | |
| CreditorID | form | string | No | |
| DebtorID | form | string | No | |
| ExternalAppRecID | form | string | No | |
| AustPostDPID | form | string | No | |
| AustPostBCSP | form | string | No | |
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/CN_MainQuery HTTP/1.1
Host: localhost
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ProspectID":"String","ProspectIDStartsWith":"String","ProspectIDEndsWith":"String","ProspectIDContains":"String","ProspectIDLike":"String","ProspectIDBetween":["String"],"ProspectIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"ProspectNumber":"String","ProspectNumberStartsWith":"String","ProspectNumberEndsWith":"String","ProspectNumberContains":"String","ProspectNumberLike":"String","ProspectNumberBetween":["String"],"ProspectNumberIn":["String"],"CompanyName":"String","CompanyNameStartsWith":"String","CompanyNameEndsWith":"String","CompanyNameContains":"String","CompanyNameLike":"String","CompanyNameBetween":["String"],"CompanyNameIn":["String"],"Address1":"String","Address1StartsWith":"String","Address1EndsWith":"String","Address1Contains":"String","Address1Like":"String","Address1Between":["String"],"Address1In":["String"],"Address2":"String","Address2StartsWith":"String","Address2EndsWith":"String","Address2Contains":"String","Address2Like":"String","Address2Between":["String"],"Address2In":["String"],"Address3":"String","Address3StartsWith":"String","Address3EndsWith":"String","Address3Contains":"String","Address3Like":"String","Address3Between":["String"],"Address3In":["String"],"State":"String","StateStartsWith":"String","StateEndsWith":"String","StateContains":"String","StateLike":"String","StateBetween":["String"],"StateIn":["String"],"PostCode":"String","PostCodeStartsWith":"String","PostCodeEndsWith":"String","PostCodeContains":"String","PostCodeLike":"String","PostCodeBetween":["String"],"PostCodeIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"Fax":"String","FaxStartsWith":"String","FaxEndsWith":"String","FaxContains":"String","FaxLike":"String","FaxBetween":["String"],"FaxIn":["String"],"EmailAddress":"String","EmailAddressStartsWith":"String","EmailAddressEndsWith":"String","EmailAddressContains":"String","EmailAddressLike":"String","EmailAddressBetween":["String"],"EmailAddressIn":["String"],"CRAccountNo":"String","CRAccountNoStartsWith":"String","CRAccountNoEndsWith":"String","CRAccountNoContains":"String","CRAccountNoLike":"String","CRAccountNoBetween":["String"],"CRAccountNoIn":["String"],"DBAccountNo":"String","DBAccountNoStartsWith":"String","DBAccountNoEndsWith":"String","DBAccountNoContains":"String","DBAccountNoLike":"String","DBAccountNoBetween":["String"],"DBAccountNoIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"ExternalAppRecID":"String","ExternalAppRecIDStartsWith":"String","ExternalAppRecIDEndsWith":"String","ExternalAppRecIDContains":"String","ExternalAppRecIDLike":"String","ExternalAppRecIDBetween":["String"],"ExternalAppRecIDIn":["String"],"AustPostDPID":"String","AustPostDPIDStartsWith":"String","AustPostDPIDEndsWith":"String","AustPostDPIDContains":"String","AustPostDPIDLike":"String","AustPostDPIDBetween":["String"],"AustPostDPIDIn":["String"],"AustPostBCSP":"String","AustPostBCSPStartsWith":"String","AustPostBCSPEndsWith":"String","AustPostBCSPContains":"String","AustPostBCSPLike":"String","AustPostBCSPBetween":["String"],"AustPostBCSPIn":["String"],"Country":"String","CountryStartsWith":"String","CountryEndsWith":"String","CountryContains":"String","CountryLike":"String","CountryBetween":["String"],"CountryIn":["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
{"Results":[{"ProspectID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ProspectNumber":"String","CompanyName":"String","Address1":"String","Address2":"String","Address3":"String","State":"String","PostCode":"String","Phone":"String","Fax":"String","EmailAddress":"String","CRAccountNo":"String","DBAccountNo":"String","CreditorID":"String","DebtorID":"String","ExternalAppRecID":"String","AustPostDPID":"String","AustPostBCSP":"String","Country":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}