World Music API version v1

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

This is an example of a music API.

  • environment: required (one of stg, dev, test, prod)
  • version: required (v1)

Getting Started

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

See http://legal.musicapi.com

/api

get post

get
post
Secured by custom_scheme

A custom security scheme for authenticating requests.

Body

Media type: application/json

Type: object

Properties
  • propString: required (string)
  • propStringArray1: required (array of string)
  • ideas: required (array of object)

    Items: items

    • comment: required (string)
  • extIdeas: required (object)
    • comment: required (string)
    • createdBy: required (string)
  • feedback: required (string - default: very nice - minLength: 1 - maxLength: 255 - pattern: [a-zA-Z\s]*)

    Example:

    very well made
  • propNumber: required (number - minimum: 0 - maximum: 32)
  • propInteger: required (integer - minimum: 3 - maximum: 5)
  • propBoolean: required (boolean)
  • propDate: required (date-only)

    Example:

    2015-05-23
  • userPicture: required (file)
  • NilValue: required (object)
    • name: required (string)
    • comment: required (union of string or nil)
  • CatOrDog: required (union of ApiLib.Cat or ApiLib.Dog)
  • CatAndDog: required (object)
    • name: required (string)
    • fangs: required (string)
    • color: required (string)
  • PossibleMeetingDate: required (date-only)

Secured by custom_scheme

Headers

  • SpecialToken: required (string)

    Used to send a custom token.

HTTP status code 401

Bad token.

HTTP status code 403

/entry

post get

post
get

returns a list of entry

Secured by custom_scheme

A custom security scheme for authenticating requests.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "type": "array",
  "items": {
    "$ref": "#/definitions/song"
  },
  "definitions": {
    "song": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "artist": {
          "type": "string"
        }
      }
    }
  }
}

Secured by custom_scheme

Headers

  • SpecialToken: required (string)

    Used to send a custom token.

HTTP status code 401

Bad token.

HTTP status code 403

returns a list of entry

Secured by custom_scheme

A custom security scheme for authenticating requests.

HTTP status code 200

Body

Media type: application/json

Secured by custom_scheme

Headers

  • SpecialToken: required (string)

    Used to send a custom token.

HTTP status code 401

Bad token.

HTTP status code 403

Songs

Access to all songs inside the music world library.

get post

get
post
Secured by custom_scheme

A custom security scheme for authenticating requests.

Query Parameters

  • access_token: required (string)

Secured by custom_scheme

Headers

  • SpecialToken: required (string)

    Used to send a custom token.

HTTP status code 401

Bad token.

HTTP status code 403

get

get
Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • songId: required (string)

Annotations

  • deprecated 
    {"date":"2016-02-28T16:41:41.090Z","deprecatedBy":{"firstname":"Christian"},"comment":"no comment"}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • title: required (string)
  • length: required (number)

Examples:

song1:

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

song2:

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

Media type: application/xml

Type:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified">
  <xs:element name="song">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="title" type="xs:string" />
        <xs:element name="artist" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Example:

<?xml version="1.0" encoding="utf-8"?>
<song>
  <title>str1234</title>
  <artist>str1234</artist>
</song>

Secured by custom_scheme

Headers

  • SpecialToken: required (string)

    Used to send a custom token.

HTTP status code 401

Bad token.

HTTP status code 403