labelsByCode

Schema

type Query {

    labelsByCode(

        first: Int=10,

        offset: Int=0,

        criteria: String,

        locale: String,

        country: String,

        codeTypes: [String!]!

    ): CodesResult

}

Field

Type

Description

first

Int

Optional for pagination. Specifies ...

10 (default)

... to limit the number of results to get for the first page. The same number to limit results can be specified again to limit results for each of the following pages.

If this limit exceeds the server's number, then number of results is determined by the server.

offset

Int

Optional for pagination. Specifies ...

0 (default)

... to not offset the first number of results for the first page. However, offset is required for a following page to skip <total number results already retrieved on previous pages> to the next number to get from remaining results. For example:

●  "offset: Int = 0" and "first: Int = 10" gets first 10 results for page 1

●  "offset: Int = 10" and "first: Int = 10" skips first 10 results to get next 10 results for page 2

●  "offset: Int = 20" and "first: Int = 10" skips first 20 results to get next 10 results for page 3

criteria

String

Optional. Specifies free text for an exact code (based on Id column) search.

codeTypes

[String!]!

Specifies one or more types of code as criteria to limit search to code records matching those types. For example:

codeTypes: [“SP”,”1SP”]

locale

String

Optional. Specifies the language of users in a country/region. For example:

locale: "en"  (default)

If not specified, then the default locale of the space is used.

country

String

Optional. Specifies a country as criteria to limit search to records collected on activities within that country.