rt_get_rate

rt_get_rate

Description

Returns an array of rate type detail structures. Each detail structure contains the “id”, “name” and any extra information requested of the designated rate type.

Access

Read-only, master access not required, available to all users.

Parameters

Number	Name	O/R	Version	Usage
1	Auth	Required		Authentication structure.*
2	Search	Optional		Search for specific rate names. This search may use * or % as wildcard characters.
3	Default	Optional		If set to 1, only the default rate for the user is returned.
4	Agent	Optional		“Id” of specific agent to lookup. Internal users may use the code “public” to list all public rate types or “linked” to specify that the linked agent should be used. Case sensitive.
5	Extra	Optional	5.20.0+	An array specifying extra information to return about each rate – see table below. For backwards compatibility, if this field is left out it will default to returning the currency and default flag.

*See call structure explanation.

5. Array keys

Array key	Structure key	Description
0	abbreviation	If not empty add the abbreviation.
1	colour	If not empty add the colour. Only internal users have access to this field.
2	currency	If not empty add the currency symbol.
3	default	If not empty add specify if the rate is the default rate or not. 1=default, 0=not default.
4	note	If not empty add the note. Only internal users have access to this field.

Example

Request

{
    "method": "rt_get_rate",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        "",
        "",
        "",
        {
            "abbreviation":"1",
            "colour":"0",
            "currency":"0",
            "default":"0",
            "note":"0"
        }
    ],
    "id": 1
}

Response

{

    "id": 1,

    "error": null,

    "result": [

        {

            "id": "WB1",

            "name": "Rack (USD)",

            "abbreviation": ""

        },

        {

            "id": "11e7afe604aa7e6bb0600cc47a969e7c",

            "name": "Pezz rate",

            "abbreviation": ""

        },

        {

            "id": "11e7b015cd80564cb0600cc47a969e7c",

            "name": "Rate Test",

            "abbreviation": ""

        },

        {

            "id": "11e7c4487c86ec2cb0600cc47a969e7c",

            "name": "Agent rate allocation",

            "abbreviation": ""

        },

        {

            "id": "11e7c448d8a9eb94b0600cc47a969e7c",

            "name": "Rack test",

            "abbreviation": ""

        },

        {

            "id": "WB10",

            "name": "STO 20 ZAR",

            "abbreviation": ""

        },

        {

            "id": "WB2",

            "name": "Rack (ZAR)",

            "abbreviation": ""

        },

        {

            "id": "WB3",

            "name": "Staff Rate (USD)",

            "abbreviation": ""

        },

        {

            "id": "WB4",

            "name": "Staff Rate (ZAR)",

            "abbreviation": ""

        },

        {

            "id": "WB5",

            "name": "Complimentary (USD)",

            "abbreviation": ""

        },

        {

            "id": "WB6",

            "name": "Complimentary (ZAR)",

            "abbreviation": ""

        },

        {

            "id": "WB7",

            "name": "Override Rate (USD)",

            "abbreviation": ""

        },

        {

            "id": "WB8",

            "name": "Override Rate (ZAR)",

            "abbreviation": ""

        }

    ]

}

rt_get_rate

Description

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules