Firm
Details
Curl request
$ curl 'http://skylar.livingfire.de/api/profile/firms' -i -X GET
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" : "2d845b50-74cb-4d18-b1bb-c7b969024f66",
"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" : "7d06d925-4e61-4648-9679-49b95c88fdec",
"logstash" : "2017-04-01T00:00:00+02:00",
"description" : "John Doe",
"email" : "gibts@gar.net",
"phone" : "555-123456",
"recruiter" : false
},
"relationTechnologies" : [ {
"id" : null,
"uuid" : "fde1b0dc-e49c-4073-afc9-1ac215104661",
"logstash" : "2017-04-01T00:00:00+02:00",
"description" : "Java"
} ],
"relationNotes" : [ {
"id" : null,
"uuid" : "26d78edc-b8d2-485b-b1bf-f2f9c0651256",
"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/1
Retrieve
A GET
request will retrieve a Firm.
Response fields
Path | Type | Description |
---|---|---|
|
|
|
|
|
ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z |
|
|
Description or name |
|
|
Active state e.g. 'true' |
|
|
a URL like https://www.youtube.com/ |
|
|
a postal code like 12345 |
|
|
a city name like 'ACME city' |
|
|
a street address like 'ACME street 5' |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/firms/1' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 765
{
"uuid" : "7d06d925-4e61-4648-9679-49b95c88fdec",
"logstash" : "2017-04-01T00:00:00+02:00",
"description" : "John Doe",
"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/1"
},
"firm" : {
"href" : "http://skylar.livingfire.de/api/firms/1"
},
"relationTechnologies" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationTechnologies"
},
"relationRecruiter" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationRecruiter"
},
"relationNotes" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationNotes"
}
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
|
This Firm |
|
Relation Notes |
|
Relation Technologies |
|
Relation Contact |
Update
A PATCH
request will update a Firm.
Curl request
$ curl 'http://skylar.livingfire.de/api/firms/1' -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/1' -i -X DELETE \
-H 'Content-Type: application/hal+json'
HTTP response
HTTP/1.1 204 No Content
Search
Details
Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 534
{
"_links" : {
"findByDescription" : {
"href" : "http://skylar.livingfire.de/api/firms/search/findByDescription{?description}",
"templated" : true
},
"findByActive" : {
"href" : "http://skylar.livingfire.de/api/firms/search/findByActive{?active}",
"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 |
---|---|
|
Response fields
Path | Type | Description |
---|---|---|
|
|
|
|
|
ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z |
|
|
Description or name |
|
|
Active state e.g. 'true' |
|
|
a URL like https://www.youtube.com/ |
|
|
a postal code like 12345 |
|
|
a city name like 'ACME city' |
|
|
a street address like 'ACME street 5' |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search/findByUuid?uuid=7d06d925-4e61-4648-9679-49b95c88fdec' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 763
{
"uuid" : "7d06d925-4e61-4648-9679-49b95c88fdec",
"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/1"
},
"firm" : {
"href" : "http://skylar.livingfire.de/api/firms/1"
},
"relationTechnologies" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationTechnologies"
},
"relationRecruiter" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationRecruiter"
},
"relationNotes" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationNotes"
}
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
|
This Firm |
|
Relation Notes |
|
Relation Technologies |
|
Relation Contact |
findByDescription
A GET
request will retrieve a array of Firm.
Request parameters
Parameter | Description |
---|---|
|
Description or name |
Response fields
Path | Type | Description |
---|---|---|
|
|
An array of Firm |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/firms/search/findByDescription?description=John+Doe' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 164
{
"_embedded" : {
"firms" : [ ]
},
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/firms/search/findByDescription"
}
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
Firms
Listing
A GET
request will retrieve a paginated view of all Firm.
Response fields
Path | Type | Description |
---|---|---|
|
|
An array of Firm |
|
|
Firms to other resources |
|
|
Curl request
$ curl 'http://skylar.livingfire.de/api/firms' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1323
{
"_embedded" : {
"firms" : [ {
"uuid" : "7d06d925-4e61-4648-9679-49b95c88fdec",
"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/1"
},
"firm" : {
"href" : "http://skylar.livingfire.de/api/firms/1"
},
"relationTechnologies" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationTechnologies"
},
"relationRecruiter" : {
"href" : "http://skylar.livingfire.de/api/firms/1/relationRecruiter"
},
"relationNotes" : {
"href" : "http://skylar.livingfire.de/api/firms/1/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
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
|
|
|
Canonical link to search resources |