Table of Contents

Codeunit "Page Summary Provider"

ID 2718
Namespace: System.Integration

Exposes functionality that gets page summary for a selected page. This codeunit is exposed as a webservice and hence all functions are available through OData calls.

Properties

Name Value
Access Public

Methods

GetPageSummary

procedure GetPageSummary(PageId: Integer, Bookmark: Text): Text

Parameters

Name Type Description
PageId Integer
Bookmark Text

Returns

Type Description
Text

Text value for the page summary in JSON format.

Examples

{ "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Brick", "cardPageId": "0", "url":"https://businesscentral.dynamics.com/?company=CRONUS%20International%20Ltd.&page=22&bookmark=27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3", "fields":[ {"caption":"No.","fieldValue":"01445544","fieldType":"Code", "tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Progressive Home Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Contact","fieldValue":"Mr. Scott Mitchell","fieldType":"Text", "tooltip":"Specifies the name of the person you regularly contact when you do business with this customer."}, {"caption":"Balance Due (LCY)","fieldValue":"1.499,03","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales."}], "recordFields":[ {"caption":"No.","fieldValue":"01121212","fieldType":"Code","tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Spotsmeyer's Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Balance (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales. This value is also known as the customer's balance."}, {"caption":"Balance Due (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies payments from the customer that are overdue per today's date."}, {"caption":"Credit Limit (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the maximum amount you allow the customer to exceed the payment balance before warnings are issued."}, {"caption":"Blocked","fieldValue":" ","fieldType":"Option","tooltip":"Specifies which transactions with the customer that cannot be processed, for example, because the customer is insolvent."}, {"caption":"Privacy Blocked","fieldValue":"No","fieldType":"Boolean","tooltip":"Specifies whether to limit access to data for the data subject during daily operations. This is useful, for example, when protecting data from changes while it is under privacy review."}, {"caption":"Salesperson Code","fieldValue":"JR","fieldType":"Code","tooltip":"Specifies a code for the salesperson who normally handles this customer's account."}, {"caption":"Service Zone Code","fieldValue":"X","fieldType":"Code","tooltip":"Specifies the code for the service zone that is assigned to the customer."}, {"caption":"Address","fieldValue":"612 South Sunset Drive","fieldType":"Text","tooltip":"Specifies the customer's address. This address will appear on all sales documents for the customer."} {"caption":"Payments This Year","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the sum of payments received from the customer in the current fiscal year."}, {"caption":"Last Date Modified","fieldValue":"08/02/24","fieldType":"Date","tooltip":"Specifies when the customer card was last modified."}] }

In case of an error: { "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", "error":[ "code":"InvalidBookmark" "message":"The bookmark is invalid." ] }

GetPageSummaryBySystemID

procedure GetPageSummaryBySystemID(PageId: Integer, SystemId: Guid): Text

Parameters

Name Type Description
PageId Integer
SystemId Guid

Returns

Type Description
Text

Text value for the page summary in JSON format.

Examples

{ "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Brick", "cardPageId": "0", "url":"https://businesscentral.dynamics.com/?company=CRONUS%20International%20Ltd.&page=22&bookmark=27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3", "fields":[ {"caption":"No.","fieldValue":"01445544","fieldType":"Code", "tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Progressive Home Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Contact","fieldValue":"Mr. Scott Mitchell","fieldType":"Text", "tooltip":"Specifies the name of the person you regularly contact when you do business with this customer."}, {"caption":"Balance Due (LCY)","fieldValue":"1.499,03","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales."}], "recordFields":[ {"caption":"No.","fieldValue":"01121212","fieldType":"Code","tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Spotsmeyer's Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Balance (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales. This value is also known as the customer's balance."}, {"caption":"Balance Due (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies payments from the customer that are overdue per today's date."}, {"caption":"Credit Limit (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the maximum amount you allow the customer to exceed the payment balance before warnings are issued."}, {"caption":"Blocked","fieldValue":" ","fieldType":"Option","tooltip":"Specifies which transactions with the customer that cannot be processed, for example, because the customer is insolvent."}, {"caption":"Privacy Blocked","fieldValue":"No","fieldType":"Boolean","tooltip":"Specifies whether to limit access to data for the data subject during daily operations. This is useful, for example, when protecting data from changes while it is under privacy review."}, {"caption":"Salesperson Code","fieldValue":"JR","fieldType":"Code","tooltip":"Specifies a code for the salesperson who normally handles this customer's account."}, {"caption":"Service Zone Code","fieldValue":"X","fieldType":"Code","tooltip":"Specifies the code for the service zone that is assigned to the customer."}, {"caption":"Address","fieldValue":"612 South Sunset Drive","fieldType":"Text","tooltip":"Specifies the customer's address. This address will appear on all sales documents for the customer."} {"caption":"Payments This Year","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the sum of payments received from the customer in the current fiscal year."}, {"caption":"Last Date Modified","fieldValue":"08/02/24","fieldType":"Date","tooltip":"Specifies when the customer card was last modified."}] }

In case of an error: { "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", "error":[ "code":"InvalidSystemId" "message":"The system id is invalid." ] }

GetPageSummary

procedure GetPageSummary(PageId: Integer): Text

Parameters

Name Type Description
PageId Integer

Returns

Type Description
Text

Text value for the page summary in JSON format.

Examples

{ "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", }

In case of error: { "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", "error":[ "code":"error code" "message":"error message" ] }

GetPageSummary

procedure GetPageSummary(Parameters: Text): Text

Parameters

Name Type Description
Parameters Text

Returns

Type Description
Text

Text value for the page summary in JSON format.

Examples

{ "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Brick", "cardPageId": "0", "url":"https://businesscentral.dynamics.com/?company=CRONUS%20International%20Ltd.&page=22&bookmark=27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3", "fields":[ {"caption":"No.","fieldValue":"01445544","fieldType":"Code", "tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Progressive Home Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Contact","fieldValue":"Mr. Scott Mitchell","fieldType":"Text", "tooltip":"Specifies the name of the person you regularly contact when you do business with this customer."}, {"caption":"Balance Due (LCY)","fieldValue":"1.499,03","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales."}], "recordFields":[ {"caption":"No.","fieldValue":"01121212","fieldType":"Code","tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Spotsmeyer's Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Balance (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales. This value is also known as the customer's balance."}, {"caption":"Balance Due (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies payments from the customer that are overdue per today's date."}, {"caption":"Credit Limit (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the maximum amount you allow the customer to exceed the payment balance before warnings are issued."}, {"caption":"Blocked","fieldValue":" ","fieldType":"Option","tooltip":"Specifies which transactions with the customer that cannot be processed, for example, because the customer is insolvent."}, {"caption":"Privacy Blocked","fieldValue":"No","fieldType":"Boolean","tooltip":"Specifies whether to limit access to data for the data subject during daily operations. This is useful, for example, when protecting data from changes while it is under privacy review."}, {"caption":"Salesperson Code","fieldValue":"JR","fieldType":"Code","tooltip":"Specifies a code for the salesperson who normally handles this customer's account."}, {"caption":"Service Zone Code","fieldValue":"X","fieldType":"Code","tooltip":"Specifies the code for the service zone that is assigned to the customer."}, {"caption":"Address","fieldValue":"612 South Sunset Drive","fieldType":"Text","tooltip":"Specifies the customer's address. This address will appear on all sales documents for the customer."} {"caption":"Payments This Year","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the sum of payments received from the customer in the current fiscal year."}, {"caption":"Last Date Modified","fieldValue":"08/02/24","fieldType":"Date","tooltip":"Specifies when the customer card was last modified."}] }

In case of an error: { "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", "error":[ "code":"InvalidSystemId" "message":"The system id is invalid." ] }

GetPageUrlBySystemID

procedure GetPageUrlBySystemID(PageId: Integer, SystemId: Guid): Text

Parameters

Name Type Description
PageId Integer
SystemId Guid

Returns

Type Description
Text

Text value for the page url info in JSON format.

Examples

{ "version":"1.1", "url":"https://businesscentral.dynamics.com/?company=CRONUS%20International%20Ltd.&page=22&bookmark=27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3", }

In case of an error: { "version":"1.1", "error":[ "code":"InvalidSystemId" "message":"The system id is invalid." ] }

GetVersion

Gets the current version of the Page Summary Provider.

procedure GetVersion(): Text[30]

Returns

Type Description
Text[30]

Text value for the current version of Page Summary Provider.

GetPageSummary

procedure GetPageSummary(PageSummaryParameters: Record "Page Summary Parameters" temporary): Text

Parameters

Name Type Description
PageSummaryParameters Table System.Integration."Page Summary Parameters"

Returns

Type Description
Text

Text value for the page summary in JSON format.

Examples

{ "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Brick", "cardPageId": "0", "url":"https://businesscentral.dynamics.com/?company=CRONUS%20International%20Ltd.&page=22&bookmark=27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3", "fields":[ {"caption":"No.","fieldValue":"01445544","fieldType":"Code", "tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Progressive Home Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Contact","fieldValue":"Mr. Scott Mitchell","fieldType":"Text", "tooltip":"Specifies the name of the person you regularly contact when you do business with this customer."}, {"caption":"Balance Due (LCY)","fieldValue":"1.499,03","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales."}], "recordFields":[ {"caption":"No.","fieldValue":"01121212","fieldType":"Code","tooltip":"Specifies the number of the customer."}, {"caption":"Name","fieldValue":"Spotsmeyer's Furnishings","fieldType":"Text","tooltip":"Specifies the customer's name. This name will appear on all sales documents for the customer."}, {"caption":"Balance (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the payment amount that the customer owes for completed sales. This value is also known as the customer's balance."}, {"caption":"Balance Due (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies payments from the customer that are overdue per today's date."}, {"caption":"Credit Limit (LCY)","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the maximum amount you allow the customer to exceed the payment balance before warnings are issued."}, {"caption":"Blocked","fieldValue":" ","fieldType":"Option","tooltip":"Specifies which transactions with the customer that cannot be processed, for example, because the customer is insolvent."}, {"caption":"Privacy Blocked","fieldValue":"No","fieldType":"Boolean","tooltip":"Specifies whether to limit access to data for the data subject during daily operations. This is useful, for example, when protecting data from changes while it is under privacy review."}, {"caption":"Salesperson Code","fieldValue":"JR","fieldType":"Code","tooltip":"Specifies a code for the salesperson who normally handles this customer's account."}, {"caption":"Service Zone Code","fieldValue":"X","fieldType":"Code","tooltip":"Specifies the code for the service zone that is assigned to the customer."}, {"caption":"Address","fieldValue":"612 South Sunset Drive","fieldType":"Text","tooltip":"Specifies the customer's address. This address will appear on all sales documents for the customer."} {"caption":"Payments This Year","fieldValue":"0","fieldType":"Decimal","tooltip":"Specifies the sum of payments received from the customer in the current fiscal year."}, {"caption":"Last Date Modified","fieldValue":"08/02/24","fieldType":"Date","tooltip":"Specifies when the customer card was last modified."}] }

In case of an error: { "version":"1.1", "pageCaption":"Customer Card", "pageType":"Card", "summaryType":"Caption", "error":[ "code":"InvalidSystemId" "message":"The system id is invalid." ] }

Events

OnBeforeGetPageSummary

Allows changing which fields and values are returned when fetching page summary.

[IntegrationEvent(False,False)]
internal procedure OnBeforeGetPageSummary(PageId: Integer, RecId: RecordId, var FieldsJsonArray: JsonArray, var Handled: Boolean)

Parameters

Name Type Description
PageId Integer
RecId RecordId
FieldsJsonArray JsonArray
Handled Boolean

OnAfterGetSummaryFields

Allows changing which fields are shown when fetching page summary, including their order.

[IntegrationEvent(False,False)]
internal procedure OnAfterGetSummaryFields(PageId: Integer, RecId: RecordId, var FieldList: List of [Integer])

Parameters

Name Type Description
PageId Integer
RecId RecordId
FieldList List of [Integer]

OnAfterGetPageSummary

Allows changing which fields and values are returned just before sending the response.

[IntegrationEvent(False,False)]
internal procedure OnAfterGetPageSummary(PageId: Integer, RecId: RecordId, var FieldsJsonArray: JsonArray)

Parameters

Name Type Description
PageId Integer
RecId RecordId
FieldsJsonArray JsonArray

See also