OrganizationsApi (REST Client 0.25.35 API)

```
public interface OrganizationsApi
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`retrofit2.Call<Message>`	`addMember(String orgId, String userId)` Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
`retrofit2.Call<Message>`	`addStudySponsor(String studyId, String orgId)` Add this organization as a sponsor
`retrofit2.Call<Message>`	`addStudySponsorship(String orgId, String studyId)` Sponsor this study
`retrofit2.Call<Organization>`	`createOrganization(Organization organization)` Create a new organization Create a new organization.
`retrofit2.Call<Message>`	`deleteOrganization(String orgId)` Delete an organization.
`retrofit2.Call<AccountSummaryList>`	`getMembers(String orgId, AccountSummarySearch accountSummarySearch)` Get members of organization (using search terms).
`retrofit2.Call<Organization>`	`getOrganization(String orgId)` Get an organization Get a single organization record.
`retrofit2.Call<OrganizationList>`	`getOrganizations(Integer offsetBy, Integer pageSize)` Get all of the organizations in an app Return all the organizations that have been defined for the app context of the caller.
`retrofit2.Call<StudyList>`	`getSponsoredStudies(String orgId, Integer offsetBy, Integer pageSize)` Get the studies that are sponsored by this organization.
`retrofit2.Call<OrganizationList>`	`getSponsors(String studyId, Integer offsetBy, Integer pageSize)` Get the sponsors of this study.
`retrofit2.Call<AccountSummaryList>`	`getUnassignedAdminAccounts(AccountSummarySearch accountSummarySearch)` Get paged listing of unassigned administrative accounts Get administrative accounts that have not been assigned to an organization.
`retrofit2.Call<Message>`	`removeMember(String orgId, String userId)` Remove a member from this organization (the user will no longer belong to any organization).
`retrofit2.Call<Message>`	`removeStudySponsorship(String orgId, String studyId)` Stop sponsoring this study
`retrofit2.Call<Organization>`	`updateOrganization(String orgId, Organization organization)` Update an organization Update an existing organization.

Method Detail

addMember

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations/{orgId}/members/{userId}")
retrofit2.Call<Message> addMember(@Path(value="orgId")
                                                                                                                                            String orgId,
                                                                                                                                            @Path(value="userId")
                                                                                                                                            String userId)

Add user as a member of the organization (this will return an error if the user is already assigned to another organization).

Parameters:: orgId - Organization ID (required); userId - User ID (required)
Returns:: Call<Message>

addStudySponsor

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/sponsors/{orgId}")
retrofit2.Call<Message> addStudySponsor(@Path(value="studyId")
                                                                                                                                              String studyId,
                                                                                                                                              @Path(value="orgId")
                                                                                                                                              String orgId)

Add this organization as a sponsor

Parameters:: studyId - Study identifier (required); orgId - Organization ID (required)
Returns:: Call<Message>

addStudySponsorship

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations/{orgId}/studies/{studyId}")
retrofit2.Call<Message> addStudySponsorship(@Path(value="orgId")
                                                                                                                                                       String orgId,
                                                                                                                                                       @Path(value="studyId")
                                                                                                                                                       String studyId)

Sponsor this study

Parameters:: orgId - Organization ID (required); studyId - Study identifier (required)
Returns:: Call<Message>

createOrganization

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations")
retrofit2.Call<Organization> createOrganization(@Body
                                                                                                                                 Organization organization)

Create a new organization Create a new organization.

Parameters:: organization - (required)
Returns:: Call<Organization>

deleteOrganization

@Headers(value="Content-Type:application/json")
 @DELETE(value="v1/organizations/{orgId}")
retrofit2.Call<Message> deleteOrganization(@Path(value="orgId")
                                                                                                                                      String orgId)

Delete an organization. Delete an organization. This call will fail if any users are members of the organization.

Parameters:: orgId - Organization ID (required)
Returns:: Call<Message>

getMembers

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations/{orgId}/members")
retrofit2.Call<AccountSummaryList> getMembers(@Path(value="orgId")
                                                                                                                                               String orgId,
                                                                                                                                               @Body
                                                                                                                                               AccountSummarySearch accountSummarySearch)

Get members of organization (using search terms). Caller must be a member of the organization.

Parameters:: orgId - Organization ID (required); accountSummarySearch - Account summary search parameters (required)
Returns:: Call<AccountSummaryList>

getOrganization

@Headers(value="Content-Type:application/json")
 @GET(value="v1/organizations/{orgId}")
retrofit2.Call<Organization> getOrganization(@Path(value="orgId")
                                                                                                                                     String orgId)

Get an organization Get a single organization record. Caller must be a member of the organization to retrieve the record (or an admin).

Parameters:: orgId - Organization ID (required)
Returns:: Call<Organization>

getOrganizations

@Headers(value="Content-Type:application/json")
 @GET(value="v1/organizations")
retrofit2.Call<OrganizationList> getOrganizations(@Query(value="offsetBy")
                                                                                                                                  Integer offsetBy,
                                                                                                                                  @Query(value="pageSize")
                                                                                                                                  Integer pageSize)

Get all of the organizations in an app Return all the organizations that have been defined for the app context of the caller. For most roles this will only return the caller’s organization, but admins can view all organizations. These organization objects only contain the name and identifier of the organization (for the full record, call `getOrganization()`).

Parameters:: offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<OrganizationList>

getSponsoredStudies

@Headers(value="Content-Type:application/json")
 @GET(value="v1/organizations/{orgId}/studies")
retrofit2.Call<StudyList> getSponsoredStudies(@Path(value="orgId")
                                                                                                                                              String orgId,
                                                                                                                                              @Query(value="offsetBy")
                                                                                                                                              Integer offsetBy,
                                                                                                                                              @Query(value="pageSize")
                                                                                                                                              Integer pageSize)

Get the studies that are sponsored by this organization.

Parameters:: orgId - Organization ID (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<StudyList>

getSponsors

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/sponsors")
retrofit2.Call<OrganizationList> getSponsors(@Path(value="studyId")
                                                                                                                                          String studyId,
                                                                                                                                          @Query(value="offsetBy")
                                                                                                                                          Integer offsetBy,
                                                                                                                                          @Query(value="pageSize")
                                                                                                                                          Integer pageSize)

Get the sponsors of this study.

Parameters:: studyId - Study identifier (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<OrganizationList>

getUnassignedAdminAccounts

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations/nonmembers")
retrofit2.Call<AccountSummaryList> getUnassignedAdminAccounts(@Body
                                                                                                                                                          AccountSummarySearch accountSummarySearch)

Get paged listing of unassigned administrative accounts Get administrative accounts that have not been assigned to an organization. These are the accounts that still need to be assigned to an organization.

Parameters:: accountSummarySearch - Account summary search parameters. This method only returns administrative accounts that are not currently assigned to an organization. (required)
Returns:: Call<AccountSummaryList>

removeMember

@Headers(value="Content-Type:application/json")
 @DELETE(value="v1/organizations/{orgId}/members/{userId}")
retrofit2.Call<Message> removeMember(@Path(value="orgId")
                                                                                                                                                 String orgId,
                                                                                                                                                 @Path(value="userId")
                                                                                                                                                 String userId)

Remove a member from this organization (the user will no longer belong to any organization).

Parameters:: orgId - Organization ID (required); userId - User ID (required)
Returns:: Call<Message>

removeStudySponsorship

@Headers(value="Content-Type:application/json")
 @DELETE(value="v1/organizations/{orgId}/studies/{studyId}")
retrofit2.Call<Message> removeStudySponsorship(@Path(value="orgId")
                                                                                                                                                            String orgId,
                                                                                                                                                            @Path(value="studyId")
                                                                                                                                                            String studyId)

Stop sponsoring this study

Parameters:: orgId - Organization ID (required); studyId - Study identifier (required)
Returns:: Call<Message>

updateOrganization

@Headers(value="Content-Type:application/json")
 @POST(value="v1/organizations/{orgId}")
retrofit2.Call<Organization> updateOrganization(@Path(value="orgId")
                                                                                                                                         String orgId,
                                                                                                                                         @Body
                                                                                                                                         Organization organization)

Update an organization Update an existing organization.

Parameters:: orgId - Organization ID (required); organization - (required)
Returns:: Call<Organization>

Interface OrganizationsApi