| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientHostName | query | string | No | |
| UserName | query | string | No | |
| IsPro | query | bool | No | |
| ClientId | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientCode | form | string | No | |
| ClientRegistrationCode | form | string | No | |
| Token | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientIpAddress | form | string | No | |
| ClientGuid | form | string | No | |
| ClientName | form | string | No | |
| ClientId | form | string | No | |
| UserHomeFolder | form | string | No | |
| UserEmail | form | string | No | |
| ServerVersion | form | string | No | |
| AllowUpdate | form | bool | No | |
| FtpUsername | form | string | No | |
| FtpPassword | form | string | No | |
| AdminUsername | form | string | No | |
| AdminPassword | form | string | No | |
| FtpPort | form | int | No | |
| SupportedDocumentFormats | form | string[] | No | |
| HpnVersion | form | string | 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/JsonServerInformationRequest HTTP/1.1
Host: buildmax.org
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ClientHostName":"String","UserName":"String","IsPro":false,"ClientId":"String","ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ClientIpAddress":"String","ClientGuid":"String","ClientName":"String","ClientId":"String","UserHomeFolder":"String","UserEmail":"String","ServerVersion":"String","AllowUpdate":false,"FtpUsername":"String","FtpPassword":"String","AdminUsername":"String","AdminPassword":"String","FtpPort":0,"SupportedDocumentFormats":["String"],"HpnVersion":"String"}