Jump to

• Request
• Response

Get Report Groups

post

/config/sim/v1/setup/getReportGroups

Gets all the Report Groups configured

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

Get request Body

Root Schema : ReportGroupGetRequest

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Report Groups objects of the organization

Body ()

Root Schema : ReportGroups

Type: object

Model for Report Groups Object

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit where the Report Groups is configured

  Example: 3599
• hierUnitName(optional): object hierUnitName
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit where the Report Groups is configured

  Example: 26
• name: object name
  A group of string objects representing the name of the Report Group in configured languages
• objectNum: integer
  Object Number of the Report Groups.

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Report Groups

  Example: 1111100000000000
• optionsExt(optional): object optionsExt
  An object containing the descriptive option list
• type(optional): integer
  Type of the report group; 0 - None; 1 ??? Tender / Media; 2 ??? Discount; 3 ??? Service Charge

  Example: 1

{
    "description":"Model for Report Groups Object",
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object Number of the Report Groups.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Report Groups is configured",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the Report Groups is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "description":"A string that contains translations of hierarchy unit name into multiple languages",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "ar-AR":"??????????"
            }
        },
        "name":{
            "description":"A group of string objects representing the name of the Report Group  in configured languages",
            "type":"object",
            "example":{
                "en-US":"Routing Group",
                "de-DE":"Routing-Gruppe"
            }
        },
        "options":{
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Report Groups",
            "type":"string",
            "example":"1111100000000000"
        },
        "optionsExt":{
            "description":"An object containing the descriptive option list",
            "type":"object",
            "properties":{
                "includeInBankDueSection":{
                    "description":"A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1",
                    "type":"integer",
                    "example":1
                },
                "subtractInBankDueSection":{
                    "description":"A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1",
                    "type":"integer",
                    "example":1
                },
                "dontIncludeInTenderBreakdownSection":{
                    "description":"A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1",
                    "type":"integer",
                    "example":1
                },
                "dontDisplayForBlindDropReports":{
                    "description":"A Boolean flag indicating   to prevent tenders in this group from appearing on reports. Applicable only if type = 1",
                    "type":"integer",
                    "example":1
                },
                "depositTypeOfTenderMedia":{
                    "description":"A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1",
                    "type":"integer",
                    "example":1
                },
                "dontIncludeInDiscountBreakdownSection":{
                    "description":"A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2",
                    "type":"integer",
                    "example":1
                },
                "dontIncludeInSvcChgBreakdownSection":{
                    "description":"A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3",
                    "type":"integer",
                    "example":1
                }
            }
        },
        "type":{
            "description":"Type of the report group; 0 - None; 1 ??? Tender / Media; 2 ??? Discount; 3 ??? Service Charge",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : hierUnitName

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}

Nested Schema : name

Type: object

A group of string objects representing the name of the Report Group in configured languages

Example:

{
    "en-US":"Routing Group",
    "de-DE":"Routing-Gruppe"
}

Nested Schema : optionsExt

Type: object

An object containing the descriptive option list

Show Source

• depositTypeOfTenderMedia(optional): integer
  A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1

  Example: 1
• dontDisplayForBlindDropReports(optional): integer
  A Boolean flag indicating to prevent tenders in this group from appearing on reports. Applicable only if type = 1

  Example: 1
• dontIncludeInDiscountBreakdownSection(optional): integer
  A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2

  Example: 1
• dontIncludeInSvcChgBreakdownSection(optional): integer
  A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3

  Example: 1
• dontIncludeInTenderBreakdownSection(optional): integer
  A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1

  Example: 1
• includeInBankDueSection(optional): integer
  A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1

  Example: 1
• subtractInBankDueSection(optional): integer
  A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1

  Example: 1

{
    "description":"An object containing the descriptive option list",
    "type":"object",
    "properties":{
        "includeInBankDueSection":{
            "description":"A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1",
            "type":"integer",
            "example":1
        },
        "subtractInBankDueSection":{
            "description":"A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1",
            "type":"integer",
            "example":1
        },
        "dontIncludeInTenderBreakdownSection":{
            "description":"A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1",
            "type":"integer",
            "example":1
        },
        "dontDisplayForBlindDropReports":{
            "description":"A Boolean flag indicating   to prevent tenders in this group from appearing on reports. Applicable only if type = 1",
            "type":"integer",
            "example":1
        },
        "depositTypeOfTenderMedia":{
            "description":"A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1",
            "type":"integer",
            "example":1
        },
        "dontIncludeInDiscountBreakdownSection":{
            "description":"A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2",
            "type":"integer",
            "example":1
        },
        "dontIncludeInSvcChgBreakdownSection":{
            "description":"A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top