A Badge represents a qualification or skill that a Worker can acquire and which can be specified as required for a particular Job Request.

If a Job Request specifies that Badges are required, only those Workers who posess all the specified Badges will see the Job Request and be able to Accept it.


Supported Formats

json

GET /api_v2/badges
List available Badges

Returns a list of available Badges, optionally paginated. Note: the maximum number returned per page in any case is 50.

Supported Formats

json

Errors

Code Description
401 Unauthorized

Examples

curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/badges
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/badges?page=10&per=25
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/badges?query=test

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String

page
optional

The page number to start from

Validations:

  • Must be Integer

per
optional

The size of the page

Validations:

  • Must be Integer

query
optional

Filter by name of badge

Validations:

  • Must be String


GET /api_v2/badges/:id
Get a specific Badge

Supported Formats

json

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String


POST /api_v2/badges
Create a new Badge

Supported Formats

json

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String

badge
required

Validations:

  • Must be a Hash

badge[name]
required

Name of Badge

Validations:

  • Must be String

badge[description]
required

Description of Badge Detail

Validations:

  • Must be String

badge[info_url]
optional

External Url for more Information about Badge

Validations:

  • Must be String

badge[remote_icon_url]
optional

Remote URL of Icon Image

Validations:

  • Must be String

badge[is_soft]
optional

Allow Wonoloers to be ranked/notified about a job even though they do not have the badge

Validations:

  • Must be one of: true, false.


Supported Formats

json

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String

badge
required

Validations:

  • Must be a Hash

badge[name]
required

Name of Badge

Validations:

  • Must be String

badge[description]
required

Description of Badge Detail

Validations:

  • Must be String

badge[info_url]
optional

External Url for more Information about Badge

Validations:

  • Must be String

badge[remote_icon_url]
optional

Remote URL of Icon Image

Validations:

  • Must be String

badge[is_soft]
optional

Allow Wonoloers to be ranked/notified about a job even though they do not have the badge

Validations:

  • Must be one of: true, false.


Supported Formats

json

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String