Budgets - Return TRUE/FALSE if a budget can be published
API Url
Use it to see if a budget can be published.
GET
http://localhost:16010/ProMarkREST/web/System/budgets/{id}/publish
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| id | Number | Budget id. |
Query parameters
| Field | Type | Description |
|---|---|---|
contextIdoptional | String | Context id |
contextTypeoptional | Number | Context type |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object[] | |
| canPublish | Logical | TRUE, if the budget can be published, FALSE otherwise. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
{"response": {"data": {{"canPublish": TRUE}}}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |