/organisations/login/{login} Resource

Returns an organisation by its login name.

Access: Unauthorized (public) access allowed.

GET /organisations/login/{login}

Returns an organisation by its login name.

Access: Unauthorized (public) access allowed.

Request Parameters
name type description constraints
login path login name of the organisation to return required
runas query optional login name whose identity is used to execute the request (only available to users with the RunAs privilege)  
Response Codes
code condition
200 if the request was completed successfully
401 if the user is not authenticated (error code 401001)
404 if the organisation with the given login name could not be found (error code 404001)
Response Body
media type data type description
application/json Organisation (JSON) the organisation

Example

Request
GET /organisations/login/{login}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "self" : "http://example.org/organisations/id/1",
  "id" : "1",
  "login" : "dnb",
  "created" : "2017-03-02T15:23:16.123Z",
  "lastModified" : "2017-03-02T15:23:16.123Z",
  "name" : "Deutsche Nationalbibliothek",
  "email" : "urn-group@example.org",
  "address" : {
    "street" : "Adickesallee 1",
    "postcode" : "60322",
    "city" : "Frankfurt am Main",
    "country" : "Germany"
  },
  "comment" : "This organisation is used for testing purposes only",
  "primaryContactSurname" : "Cantor",
  "primaryContactForename" : "Georg",
  "primaryContactEmail" : "g.cantor@example.org",
  "primaryContactPhone" : "+49 69 1525-0",
  "primaryContactFunction" : "Team Lead URN-Services",
  "primaryContactComment" : "Only in the office until for 1pm",
  "contacts" : "http://example.org/organisation/id/1/contacts",
  "namespaces" : "http://example.org/organisation/id/1/namespaces"
}