Firm

Details

Curl request

$ curl 'http://skylar.livingfire.de/api/profile/firms' -i

Create

A POST request will create a Firm.

Curl request

$ curl 'http://skylar.livingfire.de/api/firms' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "id" : null,
  "uuid" : "5bbee916-4a27-4b08-906a-2a165763c519",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Google",
  "active" : true,
  "url" : "http://www.google.de",
  "postalCode" : "12345",
  "city" : "ACME city",
  "street" : "ACME street 5",
  "relationRecruiter" : {
    "id" : null,
    "uuid" : "671e7867-6ab1-4fd2-95d6-fca6a7523e35",
    "logstash" : "2017-04-01T00:00:00+02:00",
    "description" : "John Doe",
    "email" : "gibts@gar.net",
    "phone" : "555-123456",
    "recruiter" : false
  },
  "relationTechnologies" : [ {
    "id" : null,
    "uuid" : "f0815d6e-5e1e-46da-88cf-e47202879e58",
    "logstash" : "2017-04-01T00:00:00+02:00",
    "description" : "Java"
  } ],
  "relationNotes" : [ {
    "id" : null,
    "uuid" : "913846ba-d5d9-4715-9598-2de7543b8680",
    "logstash" : "2017-04-01T00:00:00+02:00",
    "description" : "2017-04-01 cycle started - Java Webdeveloper",
    "url" : "http://www.google.de/webdeveloper"
  } ]
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/firms/3

Retrieve

A GET request will retrieve a Firm.

Response fields

Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

active

Boolean

Active state e.g. 'true'

url

String

a URL like https://www.youtube.com/

postalCode

String

a postal code like 12345

city

String

a city name like 'ACME city'

street

String

a street address like 'ACME street 5'

_links

Object

Links to other resources

Curl request

$ curl 'http://skylar.livingfire.de/api/firms/3' -i

HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 763

{
  "uuid" : "5bbee916-4a27-4b08-906a-2a165763c519",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Google",
  "active" : true,
  "url" : "http://www.google.de",
  "postalCode" : "12345",
  "city" : "ACME city",
  "street" : "ACME street 5",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/firms/3"
    },
    "firm" : {
      "href" : "http://skylar.livingfire.de/api/firms/3"
    },
    "relationRecruiter" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationRecruiter"
    },
    "relationTechnologies" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationTechnologies"
    },
    "relationNotes" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationNotes"
    }
  }
}
Relation Description

self

Canonical link for this resource

firm

This Firm

relationNotes

Relation Notes

relationTechnologies

Relation Technologies

relationRecruiter

Relation Contact

Update

A PATCH request will update a Firm.

Curl request

$ curl 'http://skylar.livingfire.de/api/firms/3' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "description" : "Google"
}'

HTTP response

HTTP/1.1 204 No Content

Delete

A DELETE request will delete a Firm.

Curl request

$ curl 'http://skylar.livingfire.de/api/firms/3' -i -X DELETE \
    -H 'Content-Type: application/hal+json'

HTTP response

HTTP/1.1 204 No Content

Details

Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 534

{
  "_links" : {
    "findByActive" : {
      "href" : "http://skylar.livingfire.de/api/firms/search/findByActive{?active}",
      "templated" : true
    },
    "findByDescription" : {
      "href" : "http://skylar.livingfire.de/api/firms/search/findByDescription{?description}",
      "templated" : true
    },
    "findByUuid" : {
      "href" : "http://skylar.livingfire.de/api/firms/search/findByUuid{?uuid}",
      "templated" : true
    },
    "self" : {
      "href" : "http://skylar.livingfire.de/api/firms/search"
    }
  }
}

findByUuid

A GET request will retrieve a Firm.

Request parameters
Parameter Description

uuid

Java UUID

Response fields
Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

active

Boolean

Active state e.g. 'true'

url

String

a URL like https://www.youtube.com/

postalCode

String

a postal code like 12345

city

String

a city name like 'ACME city'

street

String

a street address like 'ACME street 5'

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search/findByUuid?uuid=5bbee916-4a27-4b08-906a-2a165763c519' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 763

{
  "uuid" : "5bbee916-4a27-4b08-906a-2a165763c519",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Google",
  "active" : true,
  "url" : "http://www.google.de",
  "postalCode" : "12345",
  "city" : "ACME city",
  "street" : "ACME street 5",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/firms/3"
    },
    "firm" : {
      "href" : "http://skylar.livingfire.de/api/firms/3"
    },
    "relationRecruiter" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationRecruiter"
    },
    "relationTechnologies" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationTechnologies"
    },
    "relationNotes" : {
      "href" : "http://skylar.livingfire.de/api/firms/3/relationNotes"
    }
  }
}
Relation Description

self

Canonical link for this resource

firm

This Firm

relationNotes

Relation Notes

relationTechnologies

Relation Technologies

relationRecruiter

Relation Contact

findByDescription

A GET request will retrieve a array of Firm.

Request parameters
Parameter Description

description

Description or name

Response fields
Path Type Description

_embedded.firms

Array

An array of Firm

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search/findByDescription?description=Google' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1032

{
  "_embedded" : {
    "firms" : [ {
      "uuid" : "5bbee916-4a27-4b08-906a-2a165763c519",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "Google",
      "active" : true,
      "url" : "http://www.google.de",
      "postalCode" : "12345",
      "city" : "ACME city",
      "street" : "ACME street 5",
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/firms/3"
        },
        "firm" : {
          "href" : "http://skylar.livingfire.de/api/firms/3"
        },
        "relationRecruiter" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationRecruiter"
        },
        "relationTechnologies" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationTechnologies"
        },
        "relationNotes" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationNotes"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/firms/search/findByDescription"
    }
  }
}
Relation Description

self

Canonical link for this resource

Firms

Listing

A GET request will retrieve a paginated view of all Firm.

Response fields

Path Type Description

_embedded.firms

Array

An array of Firm

_links

Object

Firms to other resources

page

Object

paging information

Curl request

$ curl 'http://skylar.livingfire.de/api/firms' -i

HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1323

{
  "_embedded" : {
    "firms" : [ {
      "uuid" : "5bbee916-4a27-4b08-906a-2a165763c519",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "Google",
      "active" : true,
      "url" : "http://www.google.de",
      "postalCode" : "12345",
      "city" : "ACME city",
      "street" : "ACME street 5",
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/firms/3"
        },
        "firm" : {
          "href" : "http://skylar.livingfire.de/api/firms/3"
        },
        "relationRecruiter" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationRecruiter"
        },
        "relationTechnologies" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationTechnologies"
        },
        "relationNotes" : {
          "href" : "http://skylar.livingfire.de/api/firms/3/relationNotes"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/firms{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "http://skylar.livingfire.de/api/profile/firms"
    },
    "search" : {
      "href" : "http://skylar.livingfire.de/api/firms/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Relation Description

self

Canonical link for this resource

profile

The Application-Level Profile Semantics (ALPS)

search

Canonical link to search resources