World Music API API documentation

Basic Information

Endpoint

http://{environment}.musicapi.com/{version}

environment string, one of [`stg`, `dev`, `test`, `prod`], required
version string, one of [`v1`], required

Getting Started

This is a getting started guide for the World Music API.

Legal

See http://legal.musicapi.com

Resources

/api

/api ¶
GET /api

/api ¶
POST /api

Request

Body

application/json

Properties (object)

propString

string, required

propStringArray1

Array of string, required

ideas

Array of object, required

object[]

comment string, required

extIdeas

object, required

extIdeas

comment string, required
createdBy string, required

feedback

string , default: very nice, minimum length: 1, maximum length: 255, pattern: [a-zA-Z\s]*, required

propNumber

number, minimum: 0, maximum: 32, required

propInteger

integer, minimum: 3, maximum: 5, required

propBoolean

boolean, required

propDate

date-only, required

userPicture

file, required

NilValue

object, required

NilValue

name string, required
comment Union of string or nil, required

CatOrDog

Union of ApiLib.Cat or ApiLib.Dog, required

CatAndDog

ApiLib.Cat, required

CatAndDog

name string, required
fangs string, required
color string, required

PossibleMeetingDate

ApiLib.CustomDate, required

/entry

/entry ¶
POST /entry

Response

Body

application/json

/entry ¶
GET /entry

returns a list of entry

Response

Body

application/json

Songs

Access to all songs inside the music world library.

/songs ¶
GET /songs

Request

Query Parameters

genre string, required	filter the songs by genre
access_token string, required

/songs ¶
POST /songs

Request

Query Parameters

access_token string, required

/songs/{songId} ¶
GET /songs/{songId}

Request

Path Variables

songId string, required

Response

Body

application/json
application/xml

Properties (object)

title string, required
length number, required

Examples

song1

{
  "title": "My Song",
  "length": 12
}

song2
```
{
  "title": "Last",
  "length": 3
}
```

Examples

Example
```
  str1234
  str1234
```

deprecated

Type Reference

AnotherEntry ¶

This is just another entry to simulate that you can add facets also on JSON schema defined types. Although you can only add documentation-based facets.

Type Information

AnotherEntry (json)

Cat ¶

Type Information

object

CustomDate ¶

Type Information

date-only

Dog ¶

Type Information

object

RamlDataType ¶

Type Information

object

Entry ¶

Type Information

Entry (json)

Song ¶

Type Information

object

Examples

song1

{
  "title": "My Song",
  "length": 12
}

song2
```
{
  "title": "Last",
  "length": 3
}
```

User ¶

Examples

Example
```
{
  "firstname": "John"
}
```