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

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
idNumber

Budget id.

Query parameters

FieldTypeDescription
contextIdoptionalString

Context id

contextTypeoptionalNumber

Context type 1: Department 2: Group 3: Approval group

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject[]
    canPublishLogical

TRUE, if the budget can be published, FALSE otherwise.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

{
"response": {
"data": {
{
"canPublish": TRUE
}
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.