Skip to content

Profile Interface

jassoncasey edited this page Oct 10, 2014 · 2 revisions

#Get Profile Names blah blah

##REST Sequence

GET https://<host>[:<port>]/api/profiles HTTP/1.1
<--empty-->

HTTP/1.1 200 OK
{
  value: {
    names: [String]
  }
}

HTTP/1.1 200 OK
{
  error: {
    message: String,
    details: { <--detailed error object--> }
  }
}

#Get Profile blah blah

##REST Sequence

GET https://<host>[:<port>]/api/profile/<name> HTTP/1.1
<--empty-->

HTTP/1.1 200 OK
{
  value: {
    ...
  }
}

HTTP/1.1 200 OK
{
  error: {
    message: String,
    details: { <--detailed error object--> }
  }
}

#CREATE Profile blah blah

##REST Sequence

POST https://<host>[:<port>]/api/profile/<name> HTTP/1.1
{
  ...
}

HTTP/1.1 200 OK
{
  value: {
    ...
  }
}

HTTP/1.1 200 OK
{
  error: {
    message: String,
    details: { <--detailed error object--> }
  }
}

#Update Profile blah blah

##REST Sequence

UPDATE https://<host>[:<port>]/api/profile/<name> HTTP/1.1
{
  ...
}

HTTP/1.1 200 OK
{
  value: {
    ...
  }
}

HTTP/1.1 200 OK
{
  error: {
    message: String,
    details: { <--detailed error object--> }
  }
}

Clone this wiki locally