Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Note:

...

These

...

operations

...

are

...

RESTful

...

so

...

that

...

the

...

APIs

...

are

...

easy

...

to

...

understand

...

and

...

access,

...

and

...

not

...

bound

...

to

...

a

...

particular

...

implementation's

...

model.

...

Authentication

...

is

...

at

...

the

...

HTTP

...

layer

...

and

...

not

...

discussed

...

here.

...

This

...

document

...

assumes

...

JSON,

...

however

...

XML-based

...

documents

...

are

...

easy

...

to

...

envision.

...

hasMember

Determine if a subject is a member of a group.

Request Format

Method

GET

URL

/groups/<groupid>/members/<memberid>[?immediacy=<immediacy>]

Request Body

None

Response Format

HTTP Status

Response Body

Description

200 OK

SubjectID Document

Code Block

 {"ResponseType":"SubjectIDResponse",
 "Version":"1.0",
 "SubjectType":("Group"|"Person"),
 "Id":"<ID>"}

...

Member

...

Found

...

404

...

Not

...

Found

...

None

Member Not Found

...

Note: Because RESTful URLs are "eternal",

...

groupid

...

and

...

memberid

...

must

...

be

...

persistent

...

(ie:

...

pretty

...

much

...

non-changeable),

...

and

...

therefore

...

should

...

probably

...

be

...

implemented

...

as

...

UUIDs

...

.

...

We

...

would

...

therefore

...

need

...

an

...

identifier

...

mapping

...

service.