Provinces

Province Instance

Represents a single province instance.

URI

https://app.jobcast.net/api/v1.0/provinces/{id}

Properties

Property	Type	Description
id	Int32	Unique identifier of the province.
name	String (max 255)	Human readable name for the province.
country	Object	Object with the following properties. See Countries for a full list.
	Property Type Description id Int32 Unique identifier of the country. name String (max 255) Human readable name for the country.

HTTP GET

Authentication: Not Required

Example

https://app.jobcast.net/api/v1.0/provinces/12938

{
    "data":{
        "id":12938,
        "name":"British Columbia",
        "country":{
            "id":42,
            "name":"Canada"
        }
    },
    "warnings":[]
}
    

HTTP POST, PUT, and DELETE

Not supported.

Provinces List

Represents a list of provinces.

URI

https://app.jobcast.net/api/v1.0/provinces

HTTP GET

Authentication: Not Required

If no query string parameters are sent, all provinces will be returned by default. To filter the list returned by the API, include the following query strings:

Query String

Paramter	Type	Required?	Description
country.id	Int32	No	Passing the country ID will filter the list to only return provinces for that country.

Example

https://app.jobcast.net/api/v1.0/provinces?country.id=42

{
    "data":[
        {
            "id":12940,
            "name":"Alberta",
            "country":{
                "id":42,
                "name":"Canada"
            }
        },
        {
            "id":12938,
            "name":"British Columbia",
            "country":{
                "id":42,
                "name":"Canada"
            }
        },
        ...
        {
            "id":12947,
            "name":"Yukon Territory",
            "country":{
                "id":42,
                "name":"Canada"
            }
        }
    ],
    "warnings":[]
}