Contact

Details

See Application-Level Profile Semantics (ALPS)

Curl request

$ curl 'http://skylar.livingfire.de/api/profile/contacts' -i -X GET

Create

A POST request will create a Contact.

Curl request

$ curl 'http://skylar.livingfire.de/api/contacts' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "id" : null,
  "uuid" : "8e5c0df2-0ba6-4c74-8393-d38ec198e754",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Jon Doe",
  "email" : "gibts@gar.net",
  "phone" : "555-123456",
  "recruiter" : false
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/contacts/0

Retrieve

A GET request will retrieve a Contact.

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

email

String

a email address like 'gibts@gar.net'

phone

String

a phone number like '555-123456'

recruiter

Boolean

true == external recruiter firm

_links

Object

Links to other resources

Curl request

$ curl 'http://skylar.livingfire.de/api/contacts/0' -i -X GET

HTTP response

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

{
  "uuid" : "8e5c0df2-0ba6-4c74-8393-d38ec198e754",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Jon Doe",
  "email" : "gibts@gar.net",
  "phone" : "555-123456",
  "recruiter" : false,
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/contacts/0"
    },
    "contact" : {
      "href" : "http://skylar.livingfire.de/api/contacts/0"
    }
  }
}
Relation Description

self

Canonical link for this resource

contact

This Contact

Update

A PATCH request will update a Contact.

Curl request

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

HTTP response

HTTP/1.1 204 No Content

Delete

A DELETE request will delete a Contact.

Curl request

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

HTTP response

HTTP/1.1 204 No Content

Details

See Application-Level Profile Semantics (ALPS)

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

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

findByUuid

A GET request will retrieve a Contact.

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

email

String

a email address like 'gibts@gar.net'

phone

String

a phone number like '555-123456'

recruiter

Boolean

true == external recruiter firm

_links

Object

Links to other resources
Curl request
$ curl 'http://skylar.livingfire.de/api/contacts/search/findByUuid?uuid=8e5c0df2-0ba6-4c74-8393-d38ec198e754' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 391

{
  "uuid" : "8e5c0df2-0ba6-4c74-8393-d38ec198e754",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "John Doe",
  "email" : "gibts@gar.net",
  "phone" : "555-123456",
  "recruiter" : false,
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/contacts/0"
    },
    "contact" : {
      "href" : "http://skylar.livingfire.de/api/contacts/0"
    }
  }
}
Relation Description

self

Canonical link for this resource

contact

This Contact

findByDescription

A GET request will retrieve a array of Contact.

Request parameters
Parameter Description

description

Description or name
Response fields
Path Type Description

_embedded.contacts

Array

An array of Contact

_links

Object

Links to other resources
Curl request
$ curl 'http://skylar.livingfire.de/api/contacts/search/findByDescription?description=Jon+Doe' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 170

{
  "_embedded" : {
    "contacts" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/contacts/search/findByDescription"
    }
  }
}
Relation Description

self

Canonical link for this resource

Contacts

Listing

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

Response fields

Path Type Description

_embedded.contacts

Array

An array of Contact

_links

Object

Links to other resources

page

Object

paging information

Curl request

$ curl 'http://skylar.livingfire.de/api/contacts' -i -X GET

HTTP response

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

{
  "_embedded" : {
    "contacts" : [ {
      "uuid" : "8e5c0df2-0ba6-4c74-8393-d38ec198e754",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "John Doe",
      "email" : "gibts@gar.net",
      "phone" : "555-123456",
      "recruiter" : false,
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/contacts/0"
        },
        "contact" : {
          "href" : "http://skylar.livingfire.de/api/contacts/0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/contacts{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "http://skylar.livingfire.de/api/profile/contacts"
    },
    "search" : {
      "href" : "http://skylar.livingfire.de/api/contacts/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