Get Worker Profile Valid Values

Describes the API specifications for retrieving all valid city, state, and country values for a profile worker.

Request

URI: https://<SAP Fieldglass envionment URL>/api/vi/worker-profile/<workerRef>/valid-values

HTTP Method: GET

Request Parameters

Parameter	Required	Data Type	Description	Parameter Type
workerRef	Yes	String	The unique reference ID of the user.	Path

Request Example

GET https://company.com/api/v1/worker-profile/ANTEPW00000008/valid-values
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Body

Element	Data Type	Description
Country	Array	A list of all valid country values.
State	Array	A list of all valid state and country values.
City	Array	A list of all valid city, state and country values.

Response Example

{
    "Country": [
        "Afghanistan (AFG)",
        "Aland Islands (ALA)",
        "Albania (ALB)",
        "Algeria (DZA)",
        "American Samoa (ASM)",
        "Andorra (AND)",
        .
        .
        .
        "Zaire (ZAR)",
        "Zambia (ZMB)",
        "Zimbabwe (ZWE)"
    ],
    "State": [
        "‘Adan, Yemen (AD)",
        "‘Ajlūn, Jordan (AJ)",
        "‘Amrān, Yemen (AM)",
        "‘Anseba, Eritrea (AN)",
        "A Coruña  [La Coruña], Spain (C)",
        "Aakkâr, Lebanon (AK)",
        "A'ana, Samoa (AA)",
        "Aargau (de), Switzerland (AG)",
        "Aberdeen City, United Kingdom (ABE)",
        "Aberdeenshire, United Kingdom (ABD)",
        .
        .
        .
        "Zug (de), Switzerland (ZG)",
        "Zuid-Holland, Netherlands (ZH)",
        "Zulia, Venezuela (V)",
        "Zürich (de), Switzerland (ZH)",
        "Żurrieq, Malta (68)",
        "Žužemberk, Slovenia (193)"
    ],
    "City": [
        "A dos Cunhados, Lisboa, Portugal (A dos Cunhados)",
        "A Guarda, Pontevedra  [Pontevedra], Spain (A Guarda)",
        "Å i Lofoten, Nordland, Norway (Å i Lofoten)",
        "A Pobra de Trives, Spain (A Pobra de Trives)",
        "A Pontenova, Lugo  [Lugo], Spain (A Pontenova)",
        "A Rua de Valdeorras, Ourense  [Orense], Spain (A Rua de Valdeorras)",
        "A Rua Petin, Ourense  [Orense], Spain (A Rua Petin)",
        "A Teixeira, Ourense  [Orense], Spain (A Teixeira)",
        "Aa en Hunze, Drenthe, Netherlands (Aa en Hunze)",
        "Aach, Baden-Württemberg, Germany (Aach)",
        "Aach, Rheinland-Pfalz, Germany (Aach)",
        .
        .
        .
        "Zwolle, Louisiana, United States (Zwolle)",
        "Zwönitz, Sachsen, Germany (Zwönitz)",
        "Zychlin, Łódzkie, Poland (Zychlin)",
        "Zyraków, Podkarpackie, Poland (Zyraków)",
        "Zyrardów, Poland (Zyrardów)",
        "Zyryanovsk, Shyghys Qazaqstan oblysy, Kazakhstan (Zyryanovsk)",
        "Zywiec, Poland (Zywiec)",
        "Zyyi, Larnaka, Cyprus (Zyyi)"
    ]
}