Package org.apache.fineract.client.services

Interface ClientIdentifierApi

public interface ClientIdentifierApi

  • Method Details

    • createClientIdentifier

      @Headers("Content-Type:application/json") @POST("v1/clients/{clientId}/identifiers") retrofit2.Call<PostClientsClientIdIdentifiersResponse> createClientIdentifier(@Path("clientId") Long clientId, @Body PostClientsClientIdIdentifiersRequest postClientsClientIdIdentifiersRequest)
      Create an Identifier for a Client Mandatory Fields documentKey, documentTypeId
      Parameters:
      clientId - clientId (required)
      postClientsClientIdIdentifiersRequest - (required)
      Returns:
      Call<PostClientsClientIdIdentifiersResponse>

    • deleteClientIdentifier

      @DELETE("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<DeleteClientsClientIdIdentifiersIdentifierIdResponse> deleteClientIdentifier(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId)
      Delete a Client Identifier Deletes a Client Identifier
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      Returns:
      Call<DeleteClientsClientIdIdentifiersIdentifierIdResponse>

    • newClientIdentifierDetails

      @GET("v1/clients/{clientId}/identifiers/template") retrofit2.Call<ClientIdentifierData> newClientIdentifierDetails(@Path("clientId") Long clientId)
      Retrieve Client Identifier Details Template This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: clients/1/identifiers/template
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<ClientIdentifierData>

    • retrieveAllClientIdentifiers

      @GET("v1/clients/{clientId}/identifiers") retrofit2.Call<List<ClientIdentifierData>> retrieveAllClientIdentifiers(@Path("clientId") Long clientId)
      List all Identifiers for a Client Example Requests: clients/1/identifiers clients/1/identifiers?fields=documentKey,documentType,description
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<List<ClientIdentifierData>>

    • retrieveClientIdentifiers

      @GET("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<GetClientsClientIdIdentifiersResponse> retrieveClientIdentifiers(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId)
      Retrieve a Client Identifier Example Requests: clients/1/identifier/2 clients/1/identifier/2?template=true clients/1/identifiers/2?fields=documentKey,documentType,description
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      Returns:
      Call<GetClientsClientIdIdentifiersResponse>

    • updateClientIdentifer

      @Headers("Content-Type:application/json") @PUT("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<PutClientsClientIdIdentifiersIdentifierIdResponse> updateClientIdentifer(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId, @Body ClientIdentifierRequest clientIdentifierRequest)
      Update a Client Identifier Updates a Client Identifier
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      clientIdentifierRequest - (required)
      Returns:
      Call<PutClientsClientIdIdentifiersIdentifierIdResponse>

    • createClientIdentifier

      @Headers("Content-Type:application/json") @POST("v1/clients/{clientId}/identifiers") retrofit2.Call<PostClientsClientIdIdentifiersResponse> createClientIdentifier(@Path("clientId") Long clientId, @Body PostClientsClientIdIdentifiersRequest postClientsClientIdIdentifiersRequest, @HeaderMap Map<String,String> headers)
      Create an Identifier for a Client Mandatory Fields documentKey, documentTypeId
      Parameters:
      clientId - clientId (required)
      postClientsClientIdIdentifiersRequest - (required)
      Returns:
      Call<PostClientsClientIdIdentifiersResponse>

    • deleteClientIdentifier

      @DELETE("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<DeleteClientsClientIdIdentifiersIdentifierIdResponse> deleteClientIdentifier(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId, @HeaderMap Map<String,String> headers)
      Delete a Client Identifier Deletes a Client Identifier
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      Returns:
      Call<DeleteClientsClientIdIdentifiersIdentifierIdResponse>

    • newClientIdentifierDetails

      @GET("v1/clients/{clientId}/identifiers/template") retrofit2.Call<ClientIdentifierData> newClientIdentifierDetails(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      Retrieve Client Identifier Details Template This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: clients/1/identifiers/template
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<ClientIdentifierData>

    • retrieveAllClientIdentifiers

      @GET("v1/clients/{clientId}/identifiers") retrofit2.Call<List<ClientIdentifierData>> retrieveAllClientIdentifiers(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      List all Identifiers for a Client Example Requests: clients/1/identifiers clients/1/identifiers?fields=documentKey,documentType,description
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<List<ClientIdentifierData>>

    • retrieveClientIdentifiers

      @GET("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<GetClientsClientIdIdentifiersResponse> retrieveClientIdentifiers(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Identifier Example Requests: clients/1/identifier/2 clients/1/identifier/2?template=true clients/1/identifiers/2?fields=documentKey,documentType,description
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      Returns:
      Call<GetClientsClientIdIdentifiersResponse>

    • updateClientIdentifer

      @Headers("Content-Type:application/json") @PUT("v1/clients/{clientId}/identifiers/{identifierId}") retrofit2.Call<PutClientsClientIdIdentifiersIdentifierIdResponse> updateClientIdentifer(@Path("clientId") Long clientId, @Path("identifierId") Long identifierId, @Body ClientIdentifierRequest clientIdentifierRequest, @HeaderMap Map<String,String> headers)
      Update a Client Identifier Updates a Client Identifier
      Parameters:
      clientId - clientId (required)
      identifierId - identifierId (required)
      clientIdentifierRequest - (required)
      Returns:
      Call<PutClientsClientIdIdentifiersIdentifierIdResponse>