Skip to content

Documentation changes to update response of post budget item API to include budget item details. #1554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Documentation changes to update response of post budget item API to include budget item details. #1554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion src/api-explorer/v4-0/Budget.swagger2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BudgetItemHeaderResponse"
"$ref": "#/definitions/BudgetItemHeaderSaveResponse"
}
},
"201": {
Expand Down Expand Up @@ -1262,6 +1262,24 @@
},
"title": "BudgetItemHeaderResponse"
},
"BudgetItemHeaderSaveResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"budgetItemHeaderSyncGuid": {
"type": "string"
},
"budgetItemDetailSyncGuids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "BudgetItemHeaderSaveResponse"
},
"BudgetPerson": {
"type": "object",
"required": [
Expand Down
21 changes: 16 additions & 5 deletions src/api-reference/budget/v4.budget-header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1016,7 +1016,7 @@ N/A

#### Payload

[Budget Item Response](#budgetItemResponse) or [Error Response](#errorResponse)
[Budget Item Save Response](#budgetItemHeaderSaveResponse) or [Error Response](#errorResponse)

### Example

Expand Down Expand Up @@ -1338,10 +1338,13 @@ concur-correlationid: 809a0898-e523-4114-950d-bd22705a3b25
```

```json
{
"success": true,
"budgetItemHeaderId": "72eee673-3d81-49c2-966a-b63c7a9302e6"
}
{
"success": true,
"budgetItemHeaderSyncGuid": "6f5c0189-f680-407b-b474-df917151a947",
"budgetItemDetailSyncGuids": [
"29e46a1e-ea18-43ef-80b1-4c311cdf0fe7"
]
}
```

##### Failure Response
Expand Down Expand Up @@ -1657,6 +1660,14 @@ Name|Type|Format|Description
`success`|`boolean`|-|`True` or `False` for success or failure.
`budgetItemHeaderId`|`guid`|-|The key of the created/updated/removed budget item header.

### <a name="budgetItemHeaderSaveResponse"></a>BudgetItemHeaderSaveResponse

Name|Type|Format|Description
---|---|---|---
`success`|`boolean`|-|`True` or `False` for success or failure.
`budgetItemHeaderSyncGuid`|`guid`|-|The key of the created/updated budget item header.
`budgetItemDetailSyncGuids`|`array` of `guid`|-|The keys of the created/updated budget item details.

### <a name="dateRange"></a>DateRange
Name|Type|Format|Description
---|---|---|---
Expand Down