You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@fineract.apache.org by Nikhil Pawar <ni...@gmail.com> on 2016/07/04 12:55:40 UTC
Address API docs
Hello Markus,Myrle,Adi,Nazeer
As we have agreed in previous mail chain regarding adding of Address API as
part of core product, I thought of completing its development prior to
other dependent modules.
I have come up with REST API docs for this module and wanted your
feedback.Kindly provide your feedback as soon as possible, since this is a
pre-requisite for other modules. Please note that I have added an
additional field 'is_active' to support address change of same type of
address( and also to keep track of past address for audit purpose).
1. Create new address for client:
POST https://DomainName/api/v1/clients/{clientid}/address/
*Sample request:*
POST address
Content-Type: application/json Request Body:
{
"address_type": 1,
"street": "507 west street",
"address_line_1": "apt no 5",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
}
2. Retrieve all addresses of all types for particular client:
GET https://DomainName/api/v1/clients/{clientid}/address/
*Sample response:*
[
{
"clientId":1,
"addressId":2,
"address_type": 1,
"street": "507 west street",
"address_line_1": "apt no 5",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
"is_active":1
},
{
"clientId":2,
"addressId":3,
"address_type": 1,
"street": "100 west street",
"address_line_1": "apt no 7",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
"is_active":0
}
]
3. Retreive all addresses of particular type for specified client
GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
*Sample response:*
[
{
"clientId":2,
"addressId":2,
"address_type": 1,
"street": "507 west street",
"address_line_1": "apt no 5",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
"is_active":0
},
{
"clientId":2,
"addressId":2,
"address_type": 1,
"street": "100 west street",
"address_line_1": "apt no 7",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
"is_active":1
}
]
4. Retrieve active address of particular type for specified clientid
GET
https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
Sample response:
{
"clientId":1,
"addressId":2,
"address_type": 1,
"street": "507 west street",
"address_line_1": "apt no 5",
"address_line_2": "opposite to college park",
"city":"Dallas",
"state_province_id":1,
"country_id":2,
"postal_code":"40041",
"40041",
"is_active":1
}
5. update:
update particular "active" address of client
PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
sample request
{
is_active:false
}
supported fields:
address line fields,addresstypeid,is_active
Regards,
Nikhil
RE: Getting a problem in creating a client
Posted by Adi Raju <ad...@confluxtechnologies.com>.
Hi Zayyad,
These are minor enhancements; community contributions are welcome here :)
Regards,
Adi
-----Original Message-----
From: Zayyad A. Said [mailto:zayyad@intrasofttechnologies.com]
Sent: 14 July 2016 20:14
To: dev@fineract.incubator.apache.org
Subject: RE: Getting a problem in creating a client
Adi,
I think we should also think of adding office short code as a prefix for client account number.
Most institutions would like to differentiate their clients by office and having only office name with restrictions of 20 character may pose similar challenges.
I had a case like this with a client and we used different codes as client types just to differentiate the account numbers.
Regards;
*******
Zayyad A. Said | Chairman & C.E.O
Cell No.: +254 716 615274 | Skype: zsaid2011
Email: zayyad@intrasofttechnologies.com
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 17:03
To: dev@fineract.incubator.apache.org
Subject: Re: Getting a problem in creating a client
Dear Adi
I have understood you.
Thank you for the explanation.
Regards
Mexina.
On 07/14/2016 03:52 PM, Adi Raju wrote:
> Max length for account no is 20 characters.
> When you configure it to have a prefix of office name and length of office name is more than 20 char, it gets truncated. Thus for all the successive clients account number generated would be same, which violates the uniqueness of that field.
>
> When someone wants to use office name as prefix, I would assume they would have consciously used office names that are short. An account No with long office name as prefix doesn't make sense to me.
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 18:13
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Hi Adi
>
> The prefix that I configured before in "Account Number Preference" for CLIENT was "office-name" and when i changed to "client-type" i can create a client now.
>
> I don't know the reason but thank you for the help.
>
> Regards
> Mexina.
>
> On 07/14/2016 01:06 PM, Adi Raju wrote:
>> You might be giving duplicate value for external_id or mobile no.
>> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>>
>> Regards,
>> Adi
>>
>> -----Original Message-----
>> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
>> Sent: 14 July 2016 15:12
>> To: dev@fineract.incubator.apache.org
>> Subject: Re: Getting a problem in creating a client
>>
>> Sorry, small correction "Getting a problem in creating a client"
>>
>> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>>> Hi devs
>>>
>>> I have an urgent problem here please if you will be able to assist me.
>>> The maker checker in my installed mifos is enabled and now i am
>>> creating a client, the problem is on an approval, even the superuser
>>> can not approve, i was able to create and approve only the first
>>> client
>>>
>>> In maker checker tasks, in portfolio i have selected are:
>>>
>>> Close Center,
>>> Update Chartslab,
>>> Activate Client,
>>> Close Client,
>>> Reactivate Client,
>>> Reject Client,
>>> Withdraw Client,
>>> Create FloatingRate,
>>> Update FloatingRate,
>>> Close Group,
>>> RemoveSavingOfficer SavingAccount
>>> UpdateSavingOfficer SavingAccount,
>>> Create StaffImage,
>>> Delete StaffImage
>>>
>>> I have created a client with a user who is just a loan officer and
>>> wanted to check with a user with a role of superuser it fail to
>>> approve. I also tried to create a client by superuser and check it
>>> by another superuser, it did not work too.
>>>
>>> Is there another task that i forgot to select or there is the one
>>> that am not supposed to select?
>>>
>>> Thanks in advance.
>>> --
>>>
>>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>>> Hi Nikhil,
>>>>
>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> RɅĐɅЯ, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>>
>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>
>>>>>
>>>>> As we have agreed in previous mail chain regarding adding of
>>>>> Address API as part of core product, I thought of completing its
>>>>> development prior to other dependent modules.
>>>>>
>>>>> I have come up with REST API docs for this module and wanted your
>>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>>> this is a pre-requisite for other modules. Please note that I have
>>>>> added an additional field 'is_active' to support address change of
>>>>> same type of address( and also to keep track of past address for
>>>>> audit purpose).
>>>>>
>>>>>
>>>>>
>>>>> 1. Create new address for client:
>>>>>
>>>>>
>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>> *Sample request:*
>>>>>
>>>>>
>>>>> POST address
>>>>>
>>>>> Content-Type: application/json Request Body:
>>>>>
>>>>> {
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":3,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> 4. Retrieve active address of particular type for specified
>>>>> clientid
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?co
>>>>> m
>>>>> m
>>>>> and=active
>>>>>
>>>>>
>>>>>
>>>>> Sample response:
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 5. update:
>>>>>
>>>>>
>>>>> update particular "active" address of client
>>>>>
>>>>> PUT
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> sample request
>>>>>
>>>>> {
>>>>>
>>>>> is_active:false
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>> supported fields:
>>>>>
>>>>> address line fields,addresstypeid,is_active
>>>>>
>>>>>
>>>>>
>>>>> Regards,
>>>>>
>>>>> Nikhil
>>>>>
>>>>>
>
Re: Getting a problem in creating a client
Posted by Sendoro juma <se...@singo.co.tz>.
Dear Zayyad,
I agree... Mostly 3 characters
RegardsSendoro
On Thu, Jul 14, 2016 at 5:44 PM +0300, "Zayyad A. Said" <za...@intrasofttechnologies.com> wrote:
Adi,
I think we should also think of adding office short code as a prefix for client account number.
Most institutions would like to differentiate their clients by office and having only office name with restrictions of 20 character may pose similar challenges.
I had a case like this with a client and we used different codes as client types just to differentiate the account numbers.
Regards;
*******
Zayyad A. Said | Chairman & C.E.O
Cell No.: +254 716 615274 | Skype: zsaid2011
Email: zayyad@intrasofttechnologies.com
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 17:03
To: dev@fineract.incubator.apache.org
Subject: Re: Getting a problem in creating a client
Dear Adi
I have understood you.
Thank you for the explanation.
Regards
Mexina.
On 07/14/2016 03:52 PM, Adi Raju wrote:
> Max length for account no is 20 characters.
> When you configure it to have a prefix of office name and length of office name is more than 20 char, it gets truncated. Thus for all the successive clients account number generated would be same, which violates the uniqueness of that field.
>
> When someone wants to use office name as prefix, I would assume they would have consciously used office names that are short. An account No with long office name as prefix doesn't make sense to me.
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 18:13
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Hi Adi
>
> The prefix that I configured before in "Account Number Preference" for CLIENT was "office-name" and when i changed to "client-type" i can create a client now.
>
> I don't know the reason but thank you for the help.
>
> Regards
> Mexina.
>
> On 07/14/2016 01:06 PM, Adi Raju wrote:
>> You might be giving duplicate value for external_id or mobile no.
>> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>>
>> Regards,
>> Adi
>>
>> -----Original Message-----
>> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
>> Sent: 14 July 2016 15:12
>> To: dev@fineract.incubator.apache.org
>> Subject: Re: Getting a problem in creating a client
>>
>> Sorry, small correction "Getting a problem in creating a client"
>>
>> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>>> Hi devs
>>>
>>> I have an urgent problem here please if you will be able to assist me.
>>> The maker checker in my installed mifos is enabled and now i am
>>> creating a client, the problem is on an approval, even the superuser
>>> can not approve, i was able to create and approve only the first
>>> client
>>>
>>> In maker checker tasks, in portfolio i have selected are:
>>>
>>> Close Center,
>>> Update Chartslab,
>>> Activate Client,
>>> Close Client,
>>> Reactivate Client,
>>> Reject Client,
>>> Withdraw Client,
>>> Create FloatingRate,
>>> Update FloatingRate,
>>> Close Group,
>>> RemoveSavingOfficer SavingAccount
>>> UpdateSavingOfficer SavingAccount,
>>> Create StaffImage,
>>> Delete StaffImage
>>>
>>> I have created a client with a user who is just a loan officer and
>>> wanted to check with a user with a role of superuser it fail to
>>> approve. I also tried to create a client by superuser and check it
>>> by another superuser, it did not work too.
>>>
>>> Is there another task that i forgot to select or there is the one
>>> that am not supposed to select?
>>>
>>> Thanks in advance.
>>> --
>>>
>>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>>> Hi Nikhil,
>>>>
>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> RɅĐɅЯ, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar wrote:
>>>>
>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>
>>>>>
>>>>> As we have agreed in previous mail chain regarding adding of
>>>>> Address API as part of core product, I thought of completing its
>>>>> development prior to other dependent modules.
>>>>>
>>>>> I have come up with REST API docs for this module and wanted your
>>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>>> this is a pre-requisite for other modules. Please note that I have
>>>>> added an additional field 'is_active' to support address change of
>>>>> same type of address( and also to keep track of past address for
>>>>> audit purpose).
>>>>>
>>>>>
>>>>>
>>>>> 1. Create new address for client:
>>>>>
>>>>>
>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>> *Sample request:*
>>>>>
>>>>>
>>>>> POST address
>>>>>
>>>>> Content-Type: application/json Request Body:
>>>>>
>>>>> {
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":3,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> 4. Retrieve active address of particular type for specified
>>>>> clientid
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?co
>>>>> m
>>>>> m
>>>>> and=active
>>>>>
>>>>>
>>>>>
>>>>> Sample response:
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 5. update:
>>>>>
>>>>>
>>>>> update particular "active" address of client
>>>>>
>>>>> PUT
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> sample request
>>>>>
>>>>> {
>>>>>
>>>>> is_active:false
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>> supported fields:
>>>>>
>>>>> address line fields,addresstypeid,is_active
>>>>>
>>>>>
>>>>>
>>>>> Regards,
>>>>>
>>>>> Nikhil
>>>>>
>>>>>
>
RE: Getting a problem in creating a client
Posted by "Zayyad A. Said" <za...@intrasofttechnologies.com>.
Adi,
I think we should also think of adding office short code as a prefix for client account number.
Most institutions would like to differentiate their clients by office and having only office name with restrictions of 20 character may pose similar challenges.
I had a case like this with a client and we used different codes as client types just to differentiate the account numbers.
Regards;
*******
Zayyad A. Said | Chairman & C.E.O
Cell No.: +254 716 615274 | Skype: zsaid2011
Email: zayyad@intrasofttechnologies.com
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 17:03
To: dev@fineract.incubator.apache.org
Subject: Re: Getting a problem in creating a client
Dear Adi
I have understood you.
Thank you for the explanation.
Regards
Mexina.
On 07/14/2016 03:52 PM, Adi Raju wrote:
> Max length for account no is 20 characters.
> When you configure it to have a prefix of office name and length of office name is more than 20 char, it gets truncated. Thus for all the successive clients account number generated would be same, which violates the uniqueness of that field.
>
> When someone wants to use office name as prefix, I would assume they would have consciously used office names that are short. An account No with long office name as prefix doesn't make sense to me.
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 18:13
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Hi Adi
>
> The prefix that I configured before in "Account Number Preference" for CLIENT was "office-name" and when i changed to "client-type" i can create a client now.
>
> I don't know the reason but thank you for the help.
>
> Regards
> Mexina.
>
> On 07/14/2016 01:06 PM, Adi Raju wrote:
>> You might be giving duplicate value for external_id or mobile no.
>> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>>
>> Regards,
>> Adi
>>
>> -----Original Message-----
>> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
>> Sent: 14 July 2016 15:12
>> To: dev@fineract.incubator.apache.org
>> Subject: Re: Getting a problem in creating a client
>>
>> Sorry, small correction "Getting a problem in creating a client"
>>
>> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>>> Hi devs
>>>
>>> I have an urgent problem here please if you will be able to assist me.
>>> The maker checker in my installed mifos is enabled and now i am
>>> creating a client, the problem is on an approval, even the superuser
>>> can not approve, i was able to create and approve only the first
>>> client
>>>
>>> In maker checker tasks, in portfolio i have selected are:
>>>
>>> Close Center,
>>> Update Chartslab,
>>> Activate Client,
>>> Close Client,
>>> Reactivate Client,
>>> Reject Client,
>>> Withdraw Client,
>>> Create FloatingRate,
>>> Update FloatingRate,
>>> Close Group,
>>> RemoveSavingOfficer SavingAccount
>>> UpdateSavingOfficer SavingAccount,
>>> Create StaffImage,
>>> Delete StaffImage
>>>
>>> I have created a client with a user who is just a loan officer and
>>> wanted to check with a user with a role of superuser it fail to
>>> approve. I also tried to create a client by superuser and check it
>>> by another superuser, it did not work too.
>>>
>>> Is there another task that i forgot to select or there is the one
>>> that am not supposed to select?
>>>
>>> Thanks in advance.
>>> --
>>>
>>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>>> Hi Nikhil,
>>>>
>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> RɅĐɅЯ, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>>
>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>
>>>>>
>>>>> As we have agreed in previous mail chain regarding adding of
>>>>> Address API as part of core product, I thought of completing its
>>>>> development prior to other dependent modules.
>>>>>
>>>>> I have come up with REST API docs for this module and wanted your
>>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>>> this is a pre-requisite for other modules. Please note that I have
>>>>> added an additional field 'is_active' to support address change of
>>>>> same type of address( and also to keep track of past address for
>>>>> audit purpose).
>>>>>
>>>>>
>>>>>
>>>>> 1. Create new address for client:
>>>>>
>>>>>
>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>> *Sample request:*
>>>>>
>>>>>
>>>>> POST address
>>>>>
>>>>> Content-Type: application/json Request Body:
>>>>>
>>>>> {
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":3,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> 4. Retrieve active address of particular type for specified
>>>>> clientid
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?co
>>>>> m
>>>>> m
>>>>> and=active
>>>>>
>>>>>
>>>>>
>>>>> Sample response:
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 5. update:
>>>>>
>>>>>
>>>>> update particular "active" address of client
>>>>>
>>>>> PUT
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> sample request
>>>>>
>>>>> {
>>>>>
>>>>> is_active:false
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>> supported fields:
>>>>>
>>>>> address line fields,addresstypeid,is_active
>>>>>
>>>>>
>>>>>
>>>>> Regards,
>>>>>
>>>>> Nikhil
>>>>>
>>>>>
>
Re: Getting a problem in creating a client
Posted by MexinaM Daniel <me...@singo.co.tz>.
Dear Adi
I have understood you.
Thank you for the explanation.
Regards
Mexina.
On 07/14/2016 03:52 PM, Adi Raju wrote:
> Max length for account no is 20 characters.
> When you configure it to have a prefix of office name and length of office name is more than 20 char, it gets truncated. Thus for all the successive clients account number generated would be same, which violates the uniqueness of that field.
>
> When someone wants to use office name as prefix, I would assume they would have consciously used office names that are short. An account No with long office name as prefix doesn't make sense to me.
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 18:13
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Hi Adi
>
> The prefix that I configured before in "Account Number Preference" for CLIENT was "office-name" and when i changed to "client-type" i can create a client now.
>
> I don't know the reason but thank you for the help.
>
> Regards
> Mexina.
>
> On 07/14/2016 01:06 PM, Adi Raju wrote:
>> You might be giving duplicate value for external_id or mobile no.
>> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>>
>> Regards,
>> Adi
>>
>> -----Original Message-----
>> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
>> Sent: 14 July 2016 15:12
>> To: dev@fineract.incubator.apache.org
>> Subject: Re: Getting a problem in creating a client
>>
>> Sorry, small correction "Getting a problem in creating a client"
>>
>> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>>> Hi devs
>>>
>>> I have an urgent problem here please if you will be able to assist me.
>>> The maker checker in my installed mifos is enabled and now i am
>>> creating a client, the problem is on an approval, even the superuser
>>> can not approve, i was able to create and approve only the first
>>> client
>>>
>>> In maker checker tasks, in portfolio i have selected are:
>>>
>>> Close Center,
>>> Update Chartslab,
>>> Activate Client,
>>> Close Client,
>>> Reactivate Client,
>>> Reject Client,
>>> Withdraw Client,
>>> Create FloatingRate,
>>> Update FloatingRate,
>>> Close Group,
>>> RemoveSavingOfficer SavingAccount
>>> UpdateSavingOfficer SavingAccount,
>>> Create StaffImage,
>>> Delete StaffImage
>>>
>>> I have created a client with a user who is just a loan officer and
>>> wanted to check with a user with a role of superuser it fail to
>>> approve. I also tried to create a client by superuser and check it by
>>> another superuser, it did not work too.
>>>
>>> Is there another task that i forgot to select or there is the one
>>> that am not supposed to select?
>>>
>>> Thanks in advance.
>>> --
>>>
>>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>>> Hi Nikhil,
>>>>
>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> R\u0245\u0110\u0245\u042f, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>>
>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>
>>>>>
>>>>> As we have agreed in previous mail chain regarding adding of
>>>>> Address API as part of core product, I thought of completing its
>>>>> development prior to other dependent modules.
>>>>>
>>>>> I have come up with REST API docs for this module and wanted your
>>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>>> this is a pre-requisite for other modules. Please note that I have
>>>>> added an additional field 'is_active' to support address change of
>>>>> same type of address( and also to keep track of past address for
>>>>> audit purpose).
>>>>>
>>>>>
>>>>>
>>>>> 1. Create new address for client:
>>>>>
>>>>>
>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>> *Sample request:*
>>>>>
>>>>>
>>>>> POST address
>>>>>
>>>>> Content-Type: application/json Request Body:
>>>>>
>>>>> {
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":3,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> 4. Retrieve active address of particular type for specified
>>>>> clientid
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?com
>>>>> m
>>>>> and=active
>>>>>
>>>>>
>>>>>
>>>>> Sample response:
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 5. update:
>>>>>
>>>>>
>>>>> update particular "active" address of client
>>>>>
>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> sample request
>>>>>
>>>>> {
>>>>>
>>>>> is_active:false
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>> supported fields:
>>>>>
>>>>> address line fields,addresstypeid,is_active
>>>>>
>>>>>
>>>>>
>>>>> Regards,
>>>>>
>>>>> Nikhil
>>>>>
>>>>>
>
RE: Getting a problem in creating a client
Posted by Adi Raju <ad...@confluxtechnologies.com>.
Max length for account no is 20 characters.
When you configure it to have a prefix of office name and length of office name is more than 20 char, it gets truncated. Thus for all the successive clients account number generated would be same, which violates the uniqueness of that field.
When someone wants to use office name as prefix, I would assume they would have consciously used office names that are short. An account No with long office name as prefix doesn't make sense to me.
Regards,
Adi
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 18:13
To: dev@fineract.incubator.apache.org
Subject: Re: Getting a problem in creating a client
Hi Adi
The prefix that I configured before in "Account Number Preference" for CLIENT was "office-name" and when i changed to "client-type" i can create a client now.
I don't know the reason but thank you for the help.
Regards
Mexina.
On 07/14/2016 01:06 PM, Adi Raju wrote:
> You might be giving duplicate value for external_id or mobile no.
> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 15:12
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Sorry, small correction "Getting a problem in creating a client"
>
> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>> Hi devs
>>
>> I have an urgent problem here please if you will be able to assist me.
>> The maker checker in my installed mifos is enabled and now i am
>> creating a client, the problem is on an approval, even the superuser
>> can not approve, i was able to create and approve only the first
>> client
>>
>> In maker checker tasks, in portfolio i have selected are:
>>
>> Close Center,
>> Update Chartslab,
>> Activate Client,
>> Close Client,
>> Reactivate Client,
>> Reject Client,
>> Withdraw Client,
>> Create FloatingRate,
>> Update FloatingRate,
>> Close Group,
>> RemoveSavingOfficer SavingAccount
>> UpdateSavingOfficer SavingAccount,
>> Create StaffImage,
>> Delete StaffImage
>>
>> I have created a client with a user who is just a loan officer and
>> wanted to check with a user with a role of superuser it fail to
>> approve. I also tried to create a client by superuser and check it by
>> another superuser, it did not work too.
>>
>> Is there another task that i forgot to select or there is the one
>> that am not supposed to select?
>>
>> Thanks in advance.
>> --
>>
>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>> Hi Nikhil,
>>>
>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>
>>> Greets,
>>> Myrle
>>>
>>>
>>> *Myrle Krantz*
>>> Solutions Architect
>>> RɅĐɅЯ, The Mifos Initiative
>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>
>>>
>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>
>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>
>>>>
>>>> As we have agreed in previous mail chain regarding adding of
>>>> Address API as part of core product, I thought of completing its
>>>> development prior to other dependent modules.
>>>>
>>>> I have come up with REST API docs for this module and wanted your
>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>> this is a pre-requisite for other modules. Please note that I have
>>>> added an additional field 'is_active' to support address change of
>>>> same type of address( and also to keep track of past address for
>>>> audit purpose).
>>>>
>>>>
>>>>
>>>> 1. Create new address for client:
>>>>
>>>>
>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>> *Sample request:*
>>>>
>>>>
>>>> POST address
>>>>
>>>> Content-Type: application/json Request Body:
>>>>
>>>> {
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 2. Retrieve all addresses of all types for particular client:
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":3,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>> 3. Retreive all addresses of particular type for specified client
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> 4. Retrieve active address of particular type for specified
>>>> clientid
>>>>
>>>>
>>>> GET
>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?com
>>>> m
>>>> and=active
>>>>
>>>>
>>>>
>>>> Sample response:
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 5. update:
>>>>
>>>>
>>>> update particular "active" address of client
>>>>
>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> sample request
>>>>
>>>> {
>>>>
>>>> is_active:false
>>>>
>>>> }
>>>>
>>>>
>>>> supported fields:
>>>>
>>>> address line fields,addresstypeid,is_active
>>>>
>>>>
>>>>
>>>> Regards,
>>>>
>>>> Nikhil
>>>>
>>>>
>
Re: Getting a problem in creating a client
Posted by MexinaM Daniel <me...@singo.co.tz>.
Hi Adi
The prefix that I configured before in "Account Number Preference" for
CLIENT was "office-name" and when i changed to "client-type" i can
create a client now.
I don't know the reason but thank you for the help.
Regards
Mexina.
On 07/14/2016 01:06 PM, Adi Raju wrote:
> You might be giving duplicate value for external_id or mobile no.
> Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
>
> Regards,
> Adi
>
> -----Original Message-----
> From: MexinaM Daniel [mailto:mexina@singo.co.tz]
> Sent: 14 July 2016 15:12
> To: dev@fineract.incubator.apache.org
> Subject: Re: Getting a problem in creating a client
>
> Sorry, small correction "Getting a problem in creating a client"
>
> On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
>> Hi devs
>>
>> I have an urgent problem here please if you will be able to assist me.
>> The maker checker in my installed mifos is enabled and now i am
>> creating a client, the problem is on an approval, even the superuser
>> can not approve, i was able to create and approve only the first
>> client
>>
>> In maker checker tasks, in portfolio i have selected are:
>>
>> Close Center,
>> Update Chartslab,
>> Activate Client,
>> Close Client,
>> Reactivate Client,
>> Reject Client,
>> Withdraw Client,
>> Create FloatingRate,
>> Update FloatingRate,
>> Close Group,
>> RemoveSavingOfficer SavingAccount
>> UpdateSavingOfficer SavingAccount,
>> Create StaffImage,
>> Delete StaffImage
>>
>> I have created a client with a user who is just a loan officer and
>> wanted to check with a user with a role of superuser it fail to
>> approve. I also tried to create a client by superuser and check it by
>> another superuser, it did not work too.
>>
>> Is there another task that i forgot to select or there is the one that
>> am not supposed to select?
>>
>> Thanks in advance.
>> --
>>
>> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>>> Hi Nikhil,
>>>
>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>
>>> Greets,
>>> Myrle
>>>
>>>
>>> *Myrle Krantz*
>>> Solutions Architect
>>> R\u0245\u0110\u0245\u042f, The Mifos Initiative
>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>
>>>
>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>
>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>
>>>>
>>>> As we have agreed in previous mail chain regarding adding of Address
>>>> API as part of core product, I thought of completing its development
>>>> prior to other dependent modules.
>>>>
>>>> I have come up with REST API docs for this module and wanted your
>>>> feedback.Kindly provide your feedback as soon as possible, since
>>>> this is a pre-requisite for other modules. Please note that I have
>>>> added an additional field 'is_active' to support address change of
>>>> same type of address( and also to keep track of past address for
>>>> audit purpose).
>>>>
>>>>
>>>>
>>>> 1. Create new address for client:
>>>>
>>>>
>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>> *Sample request:*
>>>>
>>>>
>>>> POST address
>>>>
>>>> Content-Type: application/json Request Body:
>>>>
>>>> {
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 2. Retrieve all addresses of all types for particular client:
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":3,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>> 3. Retreive all addresses of particular type for specified client
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> 4. Retrieve active address of particular type for specified clientid
>>>>
>>>>
>>>> GET
>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?comm
>>>> and=active
>>>>
>>>>
>>>>
>>>> Sample response:
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 5. update:
>>>>
>>>>
>>>> update particular "active" address of client
>>>>
>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> sample request
>>>>
>>>> {
>>>>
>>>> is_active:false
>>>>
>>>> }
>>>>
>>>>
>>>> supported fields:
>>>>
>>>> address line fields,addresstypeid,is_active
>>>>
>>>>
>>>>
>>>> Regards,
>>>>
>>>> Nikhil
>>>>
>>>>
>
RE: Getting a problem in creating a client
Posted by Adi Raju <ad...@confluxtechnologies.com>.
You might be giving duplicate value for external_id or mobile no.
Alternatively, Have you configured any "Account Number Preferences" rules in Admin > System menu?
Regards,
Adi
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 15:12
To: dev@fineract.incubator.apache.org
Subject: Re: Getting a problem in creating a client
Sorry, small correction "Getting a problem in creating a client"
On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
> Hi devs
>
> I have an urgent problem here please if you will be able to assist me.
> The maker checker in my installed mifos is enabled and now i am
> creating a client, the problem is on an approval, even the superuser
> can not approve, i was able to create and approve only the first
> client
>
> In maker checker tasks, in portfolio i have selected are:
>
> Close Center,
> Update Chartslab,
> Activate Client,
> Close Client,
> Reactivate Client,
> Reject Client,
> Withdraw Client,
> Create FloatingRate,
> Update FloatingRate,
> Close Group,
> RemoveSavingOfficer SavingAccount
> UpdateSavingOfficer SavingAccount,
> Create StaffImage,
> Delete StaffImage
>
> I have created a client with a user who is just a loan officer and
> wanted to check with a user with a role of superuser it fail to
> approve. I also tried to create a client by superuser and check it by
> another superuser, it did not work too.
>
> Is there another task that i forgot to select or there is the one that
> am not supposed to select?
>
> Thanks in advance.
> --
>
> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>> Hi Nikhil,
>>
>> Is the country id the ISO-3166-1 country numeric identifier?
>>
>> Greets,
>> Myrle
>>
>>
>> *Myrle Krantz*
>> Solutions Architect
>> RɅĐɅЯ, The Mifos Initiative
>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>
>>
>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>
>>> Hello Markus,Myrle,Adi,Nazeer
>>>
>>>
>>> As we have agreed in previous mail chain regarding adding of Address
>>> API as part of core product, I thought of completing its development
>>> prior to other dependent modules.
>>>
>>> I have come up with REST API docs for this module and wanted your
>>> feedback.Kindly provide your feedback as soon as possible, since
>>> this is a pre-requisite for other modules. Please note that I have
>>> added an additional field 'is_active' to support address change of
>>> same type of address( and also to keep track of past address for
>>> audit purpose).
>>>
>>>
>>>
>>> 1. Create new address for client:
>>>
>>>
>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>> *Sample request:*
>>>
>>>
>>> POST address
>>>
>>> Content-Type: application/json Request Body:
>>>
>>> {
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> }
>>>
>>>
>>>
>>> 2. Retrieve all addresses of all types for particular client:
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":3,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>> 3. Retreive all addresses of particular type for specified client
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>>
>>>
>>>
>>> 4. Retrieve active address of particular type for specified clientid
>>>
>>>
>>> GET
>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?comm
>>> and=active
>>>
>>>
>>>
>>> Sample response:
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>>
>>>
>>> 5. update:
>>>
>>>
>>> update particular "active" address of client
>>>
>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> sample request
>>>
>>> {
>>>
>>> is_active:false
>>>
>>> }
>>>
>>>
>>> supported fields:
>>>
>>> address line fields,addresstypeid,is_active
>>>
>>>
>>>
>>> Regards,
>>>
>>> Nikhil
>>>
>>>
>
Re: Getting a problem in creating a client
Posted by MexinaM Daniel <me...@singo.co.tz>.
Sorry, small correction "Getting a problem in creating a client"
On 07/14/2016 12:36 PM, MexinaM Daniel wrote:
> Hi devs
>
> I have an urgent problem here please if you will be able to assist me.
> The maker checker in my installed mifos is enabled and now i am
> creating a client, the problem is on an approval, even the superuser
> can not approve, i was able to create and approve only the first client
>
> In maker checker tasks, in portfolio i have selected are:
>
> Close Center,
> Update Chartslab,
> Activate Client,
> Close Client,
> Reactivate Client,
> Reject Client,
> Withdraw Client,
> Create FloatingRate,
> Update FloatingRate,
> Close Group,
> RemoveSavingOfficer SavingAccount
> UpdateSavingOfficer SavingAccount,
> Create StaffImage,
> Delete StaffImage
>
> I have created a client with a user who is just a loan officer and
> wanted to check with a user with a role of superuser it fail to
> approve. I also tried to create a client by superuser and check it by
> another superuser, it did not work too.
>
> Is there another task that i forgot to select or there is the one that
> am not supposed to select?
>
> Thanks in advance.
> --
>
> On 07/04/2016 04:31 PM, Myrle Krantz wrote:
>> Hi Nikhil,
>>
>> Is the country id the ISO-3166-1 country numeric identifier?
>>
>> Greets,
>> Myrle
>>
>>
>> *Myrle Krantz*
>> Solutions Architect
>> R\u0245\u0110\u0245\u042f, The Mifos Initiative
>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>
>>
>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>
>>> Hello Markus,Myrle,Adi,Nazeer
>>>
>>>
>>> As we have agreed in previous mail chain regarding adding of Address
>>> API
>>> as part of core product, I thought of completing its development
>>> prior to
>>> other dependent modules.
>>>
>>> I have come up with REST API docs for this module and wanted your
>>> feedback.Kindly provide your feedback as soon as possible, since
>>> this is a
>>> pre-requisite for other modules. Please note that I have added an
>>> additional field 'is_active' to support address change of same type of
>>> address( and also to keep track of past address for audit purpose).
>>>
>>>
>>>
>>> 1. Create new address for client:
>>>
>>>
>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>> *Sample request:*
>>>
>>>
>>> POST address
>>>
>>> Content-Type: application/json Request Body:
>>>
>>> {
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> }
>>>
>>>
>>>
>>> 2. Retrieve all addresses of all types for particular client:
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":3,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>> 3. Retreive all addresses of particular type for specified client
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>>
>>>
>>>
>>> 4. Retrieve active address of particular type for specified clientid
>>>
>>>
>>> GET
>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>
>>>
>>>
>>> Sample response:
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>>
>>>
>>> 5. update:
>>>
>>>
>>> update particular "active" address of client
>>>
>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> sample request
>>>
>>> {
>>>
>>> is_active:false
>>>
>>> }
>>>
>>>
>>> supported fields:
>>>
>>> address line fields,addresstypeid,is_active
>>>
>>>
>>>
>>> Regards,
>>>
>>> Nikhil
>>>
>>>
>
RE: Getting a problem in creating a user
Posted by Adi Raju <ad...@confluxtechnologies.com>.
What is the error from the API? Http response?
Regards,
Adi
-----Original Message-----
From: MexinaM Daniel [mailto:mexina@singo.co.tz]
Sent: 14 July 2016 15:06
To: dev@fineract.incubator.apache.org
Subject: Getting a problem in creating a user
Hi devs
I have an urgent problem here please if you will be able to assist me.
The maker checker in my installed mifos is enabled and now i am creating a client, the problem is on an approval, even the superuser can not approve, i was able to create and approve only the first client
In maker checker tasks, in portfolio i have selected are:
Close Center,
Update Chartslab,
Activate Client,
Close Client,
Reactivate Client,
Reject Client,
Withdraw Client,
Create FloatingRate,
Update FloatingRate,
Close Group,
RemoveSavingOfficer SavingAccount
UpdateSavingOfficer SavingAccount,
Create StaffImage,
Delete StaffImage
I have created a client with a user who is just a loan officer and wanted to check with a user with a role of superuser it fail to approve.
I also tried to create a client by superuser and check it by another superuser, it did not work too.
Is there another task that i forgot to select or there is the one that am not supposed to select?
Thanks in advance.
--
On 07/04/2016 04:31 PM, Myrle Krantz wrote:
> Hi Nikhil,
>
> Is the country id the ISO-3166-1 country numeric identifier?
>
> Greets,
> Myrle
>
>
> *Myrle Krantz*
> Solutions Architect
> RɅĐɅЯ, The Mifos Initiative
> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>
>
> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hello Markus,Myrle,Adi,Nazeer
>>
>>
>> As we have agreed in previous mail chain regarding adding of Address
>> API as part of core product, I thought of completing its development
>> prior to other dependent modules.
>>
>> I have come up with REST API docs for this module and wanted your
>> feedback.Kindly provide your feedback as soon as possible, since
>> this is a pre-requisite for other modules. Please note that I have
>> added an additional field 'is_active' to support address change of
>> same type of address( and also to keep track of past address for audit purpose).
>>
>>
>>
>> 1. Create new address for client:
>>
>>
>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>
>> *Sample request:*
>>
>>
>> POST address
>>
>> Content-Type: application/json Request Body:
>>
>> {
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> }
>>
>>
>>
>> 2. Retrieve all addresses of all types for particular client:
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":3,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> }
>>
>> ]
>>
>>
>>
>> 3. Retreive all addresses of particular type for specified client
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> }
>>
>> ]
>>
>>
>>
>>
>>
>>
>> 4. Retrieve active address of particular type for specified clientid
>>
>>
>> GET
>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?comma
>> nd=active
>>
>>
>> Sample response:
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "40041",
>>
>> "is_active":1
>>
>> }
>>
>>
>>
>> 5. update:
>>
>>
>> update particular "active" address of client
>>
>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> sample request
>>
>> {
>>
>> is_active:false
>>
>> }
>>
>>
>> supported fields:
>>
>> address line fields,addresstypeid,is_active
>>
>>
>>
>> Regards,
>>
>> Nikhil
>>
>>
Getting a problem in creating a user
Posted by MexinaM Daniel <me...@singo.co.tz>.
Hi devs
I have an urgent problem here please if you will be able to assist me.
The maker checker in my installed mifos is enabled and now i am creating
a client, the problem is on an approval, even the superuser can not
approve, i was able to create and approve only the first client
In maker checker tasks, in portfolio i have selected are:
Close Center,
Update Chartslab,
Activate Client,
Close Client,
Reactivate Client,
Reject Client,
Withdraw Client,
Create FloatingRate,
Update FloatingRate,
Close Group,
RemoveSavingOfficer SavingAccount
UpdateSavingOfficer SavingAccount,
Create StaffImage,
Delete StaffImage
I have created a client with a user who is just a loan officer and
wanted to check with a user with a role of superuser it fail to approve.
I also tried to create a client by superuser and check it by another
superuser, it did not work too.
Is there another task that i forgot to select or there is the one that
am not supposed to select?
Thanks in advance.
--
On 07/04/2016 04:31 PM, Myrle Krantz wrote:
> Hi Nikhil,
>
> Is the country id the ISO-3166-1 country numeric identifier?
>
> Greets,
> Myrle
>
>
> *Myrle Krantz*
> Solutions Architect
> R\u0245\u0110\u0245\u042f, The Mifos Initiative
> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>
>
> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hello Markus,Myrle,Adi,Nazeer
>>
>>
>> As we have agreed in previous mail chain regarding adding of Address API
>> as part of core product, I thought of completing its development prior to
>> other dependent modules.
>>
>> I have come up with REST API docs for this module and wanted your
>> feedback.Kindly provide your feedback as soon as possible, since this is a
>> pre-requisite for other modules. Please note that I have added an
>> additional field 'is_active' to support address change of same type of
>> address( and also to keep track of past address for audit purpose).
>>
>>
>>
>> 1. Create new address for client:
>>
>>
>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>
>> *Sample request:*
>>
>>
>> POST address
>>
>> Content-Type: application/json Request Body:
>>
>> {
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> }
>>
>>
>>
>> 2. Retrieve all addresses of all types for particular client:
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":3,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> }
>>
>> ]
>>
>>
>>
>> 3. Retreive all addresses of particular type for specified client
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> }
>>
>> ]
>>
>>
>>
>>
>>
>>
>> 4. Retrieve active address of particular type for specified clientid
>>
>>
>> GET
>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>
>>
>> Sample response:
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "40041",
>>
>> "is_active":1
>>
>> }
>>
>>
>>
>> 5. update:
>>
>>
>> update particular "active" address of client
>>
>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> sample request
>>
>> {
>>
>> is_active:false
>>
>> }
>>
>>
>> supported fields:
>>
>> address line fields,addresstypeid,is_active
>>
>>
>>
>> Regards,
>>
>> Nikhil
>>
>>
Re: Address API docs
Posted by Nayan Ambali <na...@gmail.com>.
Myrle,
API consumer has to get the address template before sending create address,
this template ( GET client/address/template) will have the id of the
countries and states with country name and state name, I am in favor of
using the standard (ISO) for countries.
@Nikhil, either we can use code, code values for countries and state
otherwise we can have dedicated tables also.
Thanks
Nayan Ambali
Thanks and Regards,
Nayan Ambali
+91 9591996042
skype: nayangambali
On Tue, Jul 5, 2016 at 12:09 AM, Nikhil Pawar <ni...@gmail.com> wrote:
> Hello,
>
> Please find the Wiki link for this discussion:
>
> https://mifosforge.jira.com/wiki/display/projects/Technical+Description+of+Address+API
>
> The page consolidates the proposal.
>
> Also, I am proposing an additional change in existing client api,wherein
> if the address configuration is enabled, then creating client would require
> address field to be specified right at the onset
> Kindly provide your feedback on this part as well.
>
> Regards,
> Nikhil
>
> On Mon, Jul 4, 2016 at 10:10 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hi Myrle,
>>
>> We can follow GENC code, it is a US standard which identifies
>> Geopolitical entities within Countries.
>> Its description says it corresponds to ISO 3166-2.:
>> http://www.statoids.com/uin.html
>>
>>
>> Regards,
>> Nikhil
>>
>> On Mon, Jul 4, 2016 at 9:57 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>
>>> Thanks Nayan,
>>>
>>> I'm just trying to understand is all. Where do potential values for
>>> "state_province_id" come from?
>>>
>>> Greets,
>>> Myrle
>>>
>>>
>>>
>>> *Myrle Krantz*
>>> Solutions Architect
>>> RɅĐɅЯ, The Mifos Initiative
>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>
>>>
>>> On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com>
>>> wrote:
>>>
>>>> Dear Nikhil,
>>>>
>>>> It would be nice if you can document it in wiki and share the link here
>>>> :) as reference for discussion.
>>>>
>>>> Thanks
>>>> Nayan Ambali
>>>>
>>>>
>>>>
>>>> Thanks and Regards,
>>>> Nayan Ambali
>>>> +91 9591996042
>>>> skype: nayangambali
>>>>
>>>> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello Myrle,
>>>>>
>>>>> Thank you for your response.I did not take into account ISO
>>>>> identifiers for country_id field.
>>>>> However, now, as recommended by you, the code-code values would in
>>>>> accordance with ISO standard.
>>>>> Is there any thing else you would like to be in compliance with ISO?
>>>>>
>>>>> Regards,
>>>>> Nikhil
>>>>>
>>>>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org>
>>>>> wrote:
>>>>>
>>>>>> Hi Nikhil,
>>>>>>
>>>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>>>
>>>>>> Greets,
>>>>>> Myrle
>>>>>>
>>>>>>
>>>>>> *Myrle Krantz*
>>>>>> Solutions Architect
>>>>>> RɅĐɅЯ, The Mifos Initiative
>>>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>>>
>>>>>>
>>>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>>>
>>>>>>>
>>>>>>> As we have agreed in previous mail chain regarding adding of Address
>>>>>>> API as part of core product, I thought of completing its development prior
>>>>>>> to other dependent modules.
>>>>>>>
>>>>>>> I have come up with REST API docs for this module and wanted your
>>>>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>>>>> pre-requisite for other modules. Please note that I have added an
>>>>>>> additional field 'is_active' to support address change of same type of
>>>>>>> address( and also to keep track of past address for audit purpose).
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 1. Create new address for client:
>>>>>>>
>>>>>>>
>>>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>
>>>>>>> *Sample request:*
>>>>>>>
>>>>>>>
>>>>>>> POST address
>>>>>>>
>>>>>>> Content-Type: application/json Request Body:
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>>>
>>>>>>>
>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>
>>>>>>>
>>>>>>> *Sample response:*
>>>>>>>
>>>>>>>
>>>>>>> [
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":1,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> },
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":3,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "100 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 7",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":0
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>> ]
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>>>
>>>>>>>
>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>
>>>>>>> *Sample response:*
>>>>>>>
>>>>>>>
>>>>>>> [
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":0
>>>>>>>
>>>>>>> },
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "100 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 7",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>> ]
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 4. Retrieve active address of particular type for specified clientid
>>>>>>>
>>>>>>>
>>>>>>> GET
>>>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>>>>
>>>>>>>
>>>>>>> Sample response:
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":1,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 5. update:
>>>>>>>
>>>>>>>
>>>>>>> update particular "active" address of client
>>>>>>>
>>>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>
>>>>>>> sample request
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> is_active:false
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>> supported fields:
>>>>>>>
>>>>>>> address line fields,addresstypeid,is_active
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> Regards,
>>>>>>>
>>>>>>> Nikhil
>>>>>>>
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>
>
Re: [Mifos-developer] Address API docs
Posted by Nayan Ambali <na...@gmail.com>.
James,
I would say these are most relevant and sensible questions, and first phase
of address implementation scope is based on your suggestion of MVP first,
so keeping minimal required features.
My reply inlined
1. If we were to include an email address for the client in the client
table (I always say "customer"), would this belong as part of the Physical
Address? Or as part of the client/customer Identifier record? 1:1 or n:1?
>> In present address module scope, it it only the physical address will be
captured, I recommend Fineract should have similar module to capture
electronic communication address, like e-mail address, mobile number
2. Does Address extend the Client Identifier (
https://demo.openmf.org/api-docs/apiLive.htm#client_identifiers_create)
or it is somehow associated via another mechanism?
>> No, it does not, But we need to have mapping of address and the address
proof documents (identifiers). I want to understand why we need to extended
Client identifier to capture address?
Can clients have more than one address - e.g. business locations and home?
>> Yes, like communication, permanent, officer etc
3. If address fields are not applicable to person due to lack of postal
system coverage, could a mifos installation alternatively use one of the
more novel address schemes - e.g. "WhatThreeWords"?
Yes, address fields can be enabled, disabled and can be made mandatory and
each field can have its own regex for validation for each installation
(each tenant)
4. Unrelated to current concept of Physical Address, what if we want to
have a unique "address" assigned in the mifos domain (e.g. www.financeXYZ.co)
such that frank123@financeXYZ.co, is a unique account address in the
world. Is there a fixed location table field in Mifos for this? (Yes, I
am asking for a unique identifier address based on internet protocol in a
pre-defined place in the API.)
I am not clear on this question, by design address is not tightly mapped to
any entity, example there is address and same address can be mapped to the
customer address and customer's spouse address and also there is provision
to capture the lat and lang coordinates.
This design provides option to see overlapping addresses across the
customers.
In India government agencies are also trying for something similar, getting
house id for each house address.
Note: I have updated the document, please have look again at
https://mifosforge.jira.com/wiki/display/projects/Technical+Description+of+Address+API
Thanks and Regards,
Nayan Ambali
+91 9591996042
skype: nayangambali
On Tue, Jul 5, 2016 at 11:17 PM, James Dailey <ja...@gmail.com>
wrote:
> Hi
>
> Can I ask perhaps a few naive (and somewhat related) questions? :
>
> 1. If we were to include an email address for the client in the client
> table (I always say "customer"), would this belong as part of the Physical
> Address? Or as part of the client/customer Identifier record? 1:1 or n:1?
> 2. Does Address extend the Client Identifier (
> https://demo.openmf.org/api-docs/apiLive.htm#client_identifiers_create)
> or it is somehow associated via another mechanism? Can clients have more
> than one address - e.g. business locations and home?
> 3. If address fields are not applicable to person due to lack of postal
> system coverage, could a mifos installation alternatively use one of the
> more novel address schemes - e.g. "WhatThreeWords"?
> 4. Unrelated to current concept of Physical Address, what if we want to
> have a unique "address" assigned in the mifos domain (e.g.
> www.financeXYZ.co) such that frank123@financeXYZ.co, is a unique account
> address in the world. Is there a fixed location table field in Mifos for
> this? (Yes, I am asking for a unique identifier address based on internet
> protocol in a pre-defined place in the API.)
>
> - James
>
> On Mon, Jul 4, 2016 at 11:40 AM Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hello,
>>
>> Please find the Wiki link for this discussion:
>>
>> https://mifosforge.jira.com/wiki/display/projects/Technical+Description+of+Address+API
>>
>> The page consolidates the proposal.
>>
>> Also, I am proposing an additional change in existing client
>> api,wherein if the address configuration is enabled, then creating client
>> would require address field to be specified right at the onset
>> Kindly provide your feedback on this part as well.
>>
>> Regards,
>> Nikhil
>>
>> On Mon, Jul 4, 2016 at 10:10 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>
>>> Hi Myrle,
>>>
>>> We can follow GENC code, it is a US standard which identifies
>>> Geopolitical entities within Countries.
>>> Its description says it corresponds to ISO 3166-2.:
>>> http://www.statoids.com/uin.html
>>>
>>>
>>> Regards,
>>> Nikhil
>>>
>>> On Mon, Jul 4, 2016 at 9:57 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>>
>>>> Thanks Nayan,
>>>>
>>>> I'm just trying to understand is all. Where do potential values for
>>>> "state_province_id" come from?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> RɅĐɅЯ, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com>
>>>> wrote:
>>>>
>>>>> Dear Nikhil,
>>>>>
>>>>> It would be nice if you can document it in wiki and share the link
>>>>> here :) as reference for discussion.
>>>>>
>>>>> Thanks
>>>>> Nayan Ambali
>>>>>
>>>>>
>>>>>
>>>>> Thanks and Regards,
>>>>> Nayan Ambali
>>>>> +91 9591996042
>>>>> skype: nayangambali
>>>>>
>>>>> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hello Myrle,
>>>>>>
>>>>>> Thank you for your response.I did not take into account ISO
>>>>>> identifiers for country_id field.
>>>>>> However, now, as recommended by you, the code-code values would in
>>>>>> accordance with ISO standard.
>>>>>> Is there any thing else you would like to be in compliance with ISO?
>>>>>>
>>>>>> Regards,
>>>>>> Nikhil
>>>>>>
>>>>>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org>
>>>>>> wrote:
>>>>>>
>>>>>>> Hi Nikhil,
>>>>>>>
>>>>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>>>>
>>>>>>> Greets,
>>>>>>> Myrle
>>>>>>>
>>>>>>>
>>>>>>> *Myrle Krantz*
>>>>>>> Solutions Architect
>>>>>>> RɅĐɅЯ, The Mifos Initiative
>>>>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>>>>
>>>>>>>
>>>>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>>>>
>>>>>>>>
>>>>>>>> As we have agreed in previous mail chain regarding adding of
>>>>>>>> Address API as part of core product, I thought of completing its
>>>>>>>> development prior to other dependent modules.
>>>>>>>>
>>>>>>>> I have come up with REST API docs for this module and wanted your
>>>>>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>>>>>> pre-requisite for other modules. Please note that I have added an
>>>>>>>> additional field 'is_active' to support address change of same type of
>>>>>>>> address( and also to keep track of past address for audit purpose).
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> 1. Create new address for client:
>>>>>>>>
>>>>>>>>
>>>>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>>
>>>>>>>> *Sample request:*
>>>>>>>>
>>>>>>>>
>>>>>>>> POST address
>>>>>>>>
>>>>>>>> Content-Type: application/json Request Body:
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "507 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 5",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> }
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>>>>
>>>>>>>>
>>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>>
>>>>>>>>
>>>>>>>> *Sample response:*
>>>>>>>>
>>>>>>>>
>>>>>>>> [
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "clientId":1,
>>>>>>>>
>>>>>>>> "addressId":2,
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "507 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 5",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> "is_active":1
>>>>>>>>
>>>>>>>> },
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "clientId":2,
>>>>>>>>
>>>>>>>> "addressId":3,
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "100 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 7",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> "is_active":0
>>>>>>>>
>>>>>>>> }
>>>>>>>>
>>>>>>>> ]
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>>>>
>>>>>>>>
>>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>>
>>>>>>>> *Sample response:*
>>>>>>>>
>>>>>>>>
>>>>>>>> [
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "clientId":2,
>>>>>>>>
>>>>>>>> "addressId":2,
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "507 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 5",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> "is_active":0
>>>>>>>>
>>>>>>>> },
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "clientId":2,
>>>>>>>>
>>>>>>>> "addressId":2,
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "100 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 7",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> "is_active":1
>>>>>>>>
>>>>>>>> }
>>>>>>>>
>>>>>>>> ]
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> 4. Retrieve active address of particular type for specified clientid
>>>>>>>>
>>>>>>>>
>>>>>>>> GET
>>>>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>>>>>
>>>>>>>>
>>>>>>>> Sample response:
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> "clientId":1,
>>>>>>>>
>>>>>>>> "addressId":2,
>>>>>>>>
>>>>>>>> "address_type": 1,
>>>>>>>>
>>>>>>>> "street": "507 west street",
>>>>>>>>
>>>>>>>> "address_line_1": "apt no 5",
>>>>>>>>
>>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>>
>>>>>>>> "city":"Dallas",
>>>>>>>>
>>>>>>>> "state_province_id":1,
>>>>>>>>
>>>>>>>> "country_id":2,
>>>>>>>>
>>>>>>>> "postal_code":"40041",
>>>>>>>>
>>>>>>>> "40041",
>>>>>>>>
>>>>>>>> "is_active":1
>>>>>>>>
>>>>>>>> }
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> 5. update:
>>>>>>>>
>>>>>>>>
>>>>>>>> update particular "active" address of client
>>>>>>>>
>>>>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>>
>>>>>>>> sample request
>>>>>>>>
>>>>>>>> {
>>>>>>>>
>>>>>>>> is_active:false
>>>>>>>>
>>>>>>>> }
>>>>>>>>
>>>>>>>>
>>>>>>>> supported fields:
>>>>>>>>
>>>>>>>> address line fields,addresstypeid,is_active
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> Regards,
>>>>>>>>
>>>>>>>> Nikhil
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>
>> ------------------------------------------------------------------------------
>> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
>> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
>> present their vision of the future. This family event has something for
>> everyone, including kids. Get more information and register today.
>> http://sdm.link/attshapeMifos-developer mailing list
>> mifos-developer@lists.sourceforge.net
>> Unsubscribe or change settings at:
>> https://lists.sourceforge.net/lists/listinfo/mifos-developer
>
>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> Mifos-developer mailing list
> mifos-developer@lists.sourceforge.net
> Unsubscribe or change settings at:
> https://lists.sourceforge.net/lists/listinfo/mifos-developer
>
Re: [Mifos-developer] Address API docs
Posted by James Dailey <ja...@gmail.com>.
Hi
Can I ask perhaps a few naive (and somewhat related) questions? :
1. If we were to include an email address for the client in the client
table (I always say "customer"), would this belong as part of the Physical
Address? Or as part of the client/customer Identifier record? 1:1 or n:1?
2. Does Address extend the Client Identifier (
https://demo.openmf.org/api-docs/apiLive.htm#client_identifiers_create)
or it is somehow associated via another mechanism? Can clients have more
than one address - e.g. business locations and home?
3. If address fields are not applicable to person due to lack of postal
system coverage, could a mifos installation alternatively use one of the
more novel address schemes - e.g. "WhatThreeWords"?
4. Unrelated to current concept of Physical Address, what if we want to
have a unique "address" assigned in the mifos domain (e.g. www.financeXYZ.co)
such that frank123@financeXYZ.co, is a unique account address in the
world. Is there a fixed location table field in Mifos for this? (Yes, I
am asking for a unique identifier address based on internet protocol in a
pre-defined place in the API.)
- James
On Mon, Jul 4, 2016 at 11:40 AM Nikhil Pawar <ni...@gmail.com> wrote:
> Hello,
>
> Please find the Wiki link for this discussion:
>
> https://mifosforge.jira.com/wiki/display/projects/Technical+Description+of+Address+API
>
> The page consolidates the proposal.
>
> Also, I am proposing an additional change in existing client api,wherein
> if the address configuration is enabled, then creating client would require
> address field to be specified right at the onset
> Kindly provide your feedback on this part as well.
>
> Regards,
> Nikhil
>
> On Mon, Jul 4, 2016 at 10:10 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hi Myrle,
>>
>> We can follow GENC code, it is a US standard which identifies
>> Geopolitical entities within Countries.
>> Its description says it corresponds to ISO 3166-2.:
>> http://www.statoids.com/uin.html
>>
>>
>> Regards,
>> Nikhil
>>
>> On Mon, Jul 4, 2016 at 9:57 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>
>>> Thanks Nayan,
>>>
>>> I'm just trying to understand is all. Where do potential values for
>>> "state_province_id" come from?
>>>
>>> Greets,
>>> Myrle
>>>
>>>
>>>
>>> *Myrle Krantz*
>>> Solutions Architect
>>> RɅĐɅЯ, The Mifos Initiative
>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>
>>>
>>> On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com>
>>> wrote:
>>>
>>>> Dear Nikhil,
>>>>
>>>> It would be nice if you can document it in wiki and share the link here
>>>> :) as reference for discussion.
>>>>
>>>> Thanks
>>>> Nayan Ambali
>>>>
>>>>
>>>>
>>>> Thanks and Regards,
>>>> Nayan Ambali
>>>> +91 9591996042
>>>> skype: nayangambali
>>>>
>>>> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello Myrle,
>>>>>
>>>>> Thank you for your response.I did not take into account ISO
>>>>> identifiers for country_id field.
>>>>> However, now, as recommended by you, the code-code values would in
>>>>> accordance with ISO standard.
>>>>> Is there any thing else you would like to be in compliance with ISO?
>>>>>
>>>>> Regards,
>>>>> Nikhil
>>>>>
>>>>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org>
>>>>> wrote:
>>>>>
>>>>>> Hi Nikhil,
>>>>>>
>>>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>>>
>>>>>> Greets,
>>>>>> Myrle
>>>>>>
>>>>>>
>>>>>> *Myrle Krantz*
>>>>>> Solutions Architect
>>>>>> RɅĐɅЯ, The Mifos Initiative
>>>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>>>
>>>>>>
>>>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>>>
>>>>>>>
>>>>>>> As we have agreed in previous mail chain regarding adding of Address
>>>>>>> API as part of core product, I thought of completing its development prior
>>>>>>> to other dependent modules.
>>>>>>>
>>>>>>> I have come up with REST API docs for this module and wanted your
>>>>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>>>>> pre-requisite for other modules. Please note that I have added an
>>>>>>> additional field 'is_active' to support address change of same type of
>>>>>>> address( and also to keep track of past address for audit purpose).
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 1. Create new address for client:
>>>>>>>
>>>>>>>
>>>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>
>>>>>>> *Sample request:*
>>>>>>>
>>>>>>>
>>>>>>> POST address
>>>>>>>
>>>>>>> Content-Type: application/json Request Body:
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>>>
>>>>>>>
>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>>
>>>>>>>
>>>>>>> *Sample response:*
>>>>>>>
>>>>>>>
>>>>>>> [
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":1,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> },
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":3,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "100 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 7",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":0
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>> ]
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>>>
>>>>>>>
>>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>
>>>>>>> *Sample response:*
>>>>>>>
>>>>>>>
>>>>>>> [
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":0
>>>>>>>
>>>>>>> },
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":2,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "100 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 7",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>> ]
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 4. Retrieve active address of particular type for specified clientid
>>>>>>>
>>>>>>>
>>>>>>> GET
>>>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>>>>
>>>>>>>
>>>>>>> Sample response:
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> "clientId":1,
>>>>>>>
>>>>>>> "addressId":2,
>>>>>>>
>>>>>>> "address_type": 1,
>>>>>>>
>>>>>>> "street": "507 west street",
>>>>>>>
>>>>>>> "address_line_1": "apt no 5",
>>>>>>>
>>>>>>> "address_line_2": "opposite to college park",
>>>>>>>
>>>>>>> "city":"Dallas",
>>>>>>>
>>>>>>> "state_province_id":1,
>>>>>>>
>>>>>>> "country_id":2,
>>>>>>>
>>>>>>> "postal_code":"40041",
>>>>>>>
>>>>>>> "40041",
>>>>>>>
>>>>>>> "is_active":1
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> 5. update:
>>>>>>>
>>>>>>>
>>>>>>> update particular "active" address of client
>>>>>>>
>>>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>>
>>>>>>> sample request
>>>>>>>
>>>>>>> {
>>>>>>>
>>>>>>> is_active:false
>>>>>>>
>>>>>>> }
>>>>>>>
>>>>>>>
>>>>>>> supported fields:
>>>>>>>
>>>>>>> address line fields,addresstypeid,is_active
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> Regards,
>>>>>>>
>>>>>>> Nikhil
>>>>>>>
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshapeMifos-developer mailing list
> mifos-developer@lists.sourceforge.net
> Unsubscribe or change settings at:
> https://lists.sourceforge.net/lists/listinfo/mifos-developer
Re: Address API docs
Posted by Nikhil Pawar <ni...@gmail.com>.
Hello,
Please find the Wiki link for this discussion:
https://mifosforge.jira.com/wiki/display/projects/Technical+Description+of+Address+API
The page consolidates the proposal.
Also, I am proposing an additional change in existing client api,wherein
if the address configuration is enabled, then creating client would require
address field to be specified right at the onset
Kindly provide your feedback on this part as well.
Regards,
Nikhil
On Mon, Jul 4, 2016 at 10:10 PM, Nikhil Pawar <ni...@gmail.com> wrote:
> Hi Myrle,
>
> We can follow GENC code, it is a US standard which identifies Geopolitical
> entities within Countries.
> Its description says it corresponds to ISO 3166-2.:
> http://www.statoids.com/uin.html
>
>
> Regards,
> Nikhil
>
> On Mon, Jul 4, 2016 at 9:57 PM, Myrle Krantz <mk...@mifos.org> wrote:
>
>> Thanks Nayan,
>>
>> I'm just trying to understand is all. Where do potential values for
>> "state_province_id" come from?
>>
>> Greets,
>> Myrle
>>
>>
>>
>> *Myrle Krantz*
>> Solutions Architect
>> RɅĐɅЯ, The Mifos Initiative
>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>
>>
>> On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com>
>> wrote:
>>
>>> Dear Nikhil,
>>>
>>> It would be nice if you can document it in wiki and share the link here
>>> :) as reference for discussion.
>>>
>>> Thanks
>>> Nayan Ambali
>>>
>>>
>>>
>>> Thanks and Regards,
>>> Nayan Ambali
>>> +91 9591996042
>>> skype: nayangambali
>>>
>>> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>
>>>> Hello Myrle,
>>>>
>>>> Thank you for your response.I did not take into account ISO identifiers
>>>> for country_id field.
>>>> However, now, as recommended by you, the code-code values would in
>>>> accordance with ISO standard.
>>>> Is there any thing else you would like to be in compliance with ISO?
>>>>
>>>> Regards,
>>>> Nikhil
>>>>
>>>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>>>
>>>>> Hi Nikhil,
>>>>>
>>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>>
>>>>> Greets,
>>>>> Myrle
>>>>>
>>>>>
>>>>> *Myrle Krantz*
>>>>> Solutions Architect
>>>>> RɅĐɅЯ, The Mifos Initiative
>>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>>
>>>>>
>>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>>
>>>>>>
>>>>>> As we have agreed in previous mail chain regarding adding of Address
>>>>>> API as part of core product, I thought of completing its development prior
>>>>>> to other dependent modules.
>>>>>>
>>>>>> I have come up with REST API docs for this module and wanted your
>>>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>>>> pre-requisite for other modules. Please note that I have added an
>>>>>> additional field 'is_active' to support address change of same type of
>>>>>> address( and also to keep track of past address for audit purpose).
>>>>>>
>>>>>>
>>>>>>
>>>>>> 1. Create new address for client:
>>>>>>
>>>>>>
>>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>
>>>>>> *Sample request:*
>>>>>>
>>>>>>
>>>>>> POST address
>>>>>>
>>>>>> Content-Type: application/json Request Body:
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "507 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 5",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> }
>>>>>>
>>>>>>
>>>>>>
>>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>>
>>>>>>
>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>>
>>>>>>
>>>>>> *Sample response:*
>>>>>>
>>>>>>
>>>>>> [
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "clientId":1,
>>>>>>
>>>>>> "addressId":2,
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "507 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 5",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> "is_active":1
>>>>>>
>>>>>> },
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "clientId":2,
>>>>>>
>>>>>> "addressId":3,
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "100 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 7",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> "is_active":0
>>>>>>
>>>>>> }
>>>>>>
>>>>>> ]
>>>>>>
>>>>>>
>>>>>>
>>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>>
>>>>>>
>>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>
>>>>>> *Sample response:*
>>>>>>
>>>>>>
>>>>>> [
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "clientId":2,
>>>>>>
>>>>>> "addressId":2,
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "507 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 5",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> "is_active":0
>>>>>>
>>>>>> },
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "clientId":2,
>>>>>>
>>>>>> "addressId":2,
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "100 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 7",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> "is_active":1
>>>>>>
>>>>>> }
>>>>>>
>>>>>> ]
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> 4. Retrieve active address of particular type for specified clientid
>>>>>>
>>>>>>
>>>>>> GET
>>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>>>
>>>>>>
>>>>>> Sample response:
>>>>>>
>>>>>> {
>>>>>>
>>>>>> "clientId":1,
>>>>>>
>>>>>> "addressId":2,
>>>>>>
>>>>>> "address_type": 1,
>>>>>>
>>>>>> "street": "507 west street",
>>>>>>
>>>>>> "address_line_1": "apt no 5",
>>>>>>
>>>>>> "address_line_2": "opposite to college park",
>>>>>>
>>>>>> "city":"Dallas",
>>>>>>
>>>>>> "state_province_id":1,
>>>>>>
>>>>>> "country_id":2,
>>>>>>
>>>>>> "postal_code":"40041",
>>>>>>
>>>>>> "40041",
>>>>>>
>>>>>> "is_active":1
>>>>>>
>>>>>> }
>>>>>>
>>>>>>
>>>>>>
>>>>>> 5. update:
>>>>>>
>>>>>>
>>>>>> update particular "active" address of client
>>>>>>
>>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>>
>>>>>> sample request
>>>>>>
>>>>>> {
>>>>>>
>>>>>> is_active:false
>>>>>>
>>>>>> }
>>>>>>
>>>>>>
>>>>>> supported fields:
>>>>>>
>>>>>> address line fields,addresstypeid,is_active
>>>>>>
>>>>>>
>>>>>>
>>>>>> Regards,
>>>>>>
>>>>>> Nikhil
>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>
>
Re: Address API docs
Posted by Nikhil Pawar <ni...@gmail.com>.
Hi Myrle,
We can follow GENC code, it is a US standard which identifies Geopolitical
entities within Countries.
Its description says it corresponds to ISO 3166-2.:
http://www.statoids.com/uin.html
Regards,
Nikhil
On Mon, Jul 4, 2016 at 9:57 PM, Myrle Krantz <mk...@mifos.org> wrote:
> Thanks Nayan,
>
> I'm just trying to understand is all. Where do potential values for
> "state_province_id" come from?
>
> Greets,
> Myrle
>
>
>
> *Myrle Krantz*
> Solutions Architect
> RɅĐɅЯ, The Mifos Initiative
> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>
>
> On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com>
> wrote:
>
>> Dear Nikhil,
>>
>> It would be nice if you can document it in wiki and share the link here
>> :) as reference for discussion.
>>
>> Thanks
>> Nayan Ambali
>>
>>
>>
>> Thanks and Regards,
>> Nayan Ambali
>> +91 9591996042
>> skype: nayangambali
>>
>> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>
>>> Hello Myrle,
>>>
>>> Thank you for your response.I did not take into account ISO identifiers
>>> for country_id field.
>>> However, now, as recommended by you, the code-code values would in
>>> accordance with ISO standard.
>>> Is there any thing else you would like to be in compliance with ISO?
>>>
>>> Regards,
>>> Nikhil
>>>
>>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>>
>>>> Hi Nikhil,
>>>>
>>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>>
>>>> Greets,
>>>> Myrle
>>>>
>>>>
>>>> *Myrle Krantz*
>>>> Solutions Architect
>>>> RɅĐɅЯ, The Mifos Initiative
>>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>>
>>>>
>>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>>
>>>>>
>>>>> As we have agreed in previous mail chain regarding adding of Address
>>>>> API as part of core product, I thought of completing its development prior
>>>>> to other dependent modules.
>>>>>
>>>>> I have come up with REST API docs for this module and wanted your
>>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>>> pre-requisite for other modules. Please note that I have added an
>>>>> additional field 'is_active' to support address change of same type of
>>>>> address( and also to keep track of past address for audit purpose).
>>>>>
>>>>>
>>>>>
>>>>> 1. Create new address for client:
>>>>>
>>>>>
>>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>> *Sample request:*
>>>>>
>>>>>
>>>>> POST address
>>>>>
>>>>> Content-Type: application/json Request Body:
>>>>>
>>>>> {
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 2. Retrieve all addresses of all types for particular client:
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>>
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":3,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>> 3. Retreive all addresses of particular type for specified client
>>>>>
>>>>>
>>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> *Sample response:*
>>>>>
>>>>>
>>>>> [
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":0
>>>>>
>>>>> },
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":2,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "100 west street",
>>>>>
>>>>> "address_line_1": "apt no 7",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>> ]
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> 4. Retrieve active address of particular type for specified clientid
>>>>>
>>>>>
>>>>> GET
>>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>>
>>>>>
>>>>> Sample response:
>>>>>
>>>>> {
>>>>>
>>>>> "clientId":1,
>>>>>
>>>>> "addressId":2,
>>>>>
>>>>> "address_type": 1,
>>>>>
>>>>> "street": "507 west street",
>>>>>
>>>>> "address_line_1": "apt no 5",
>>>>>
>>>>> "address_line_2": "opposite to college park",
>>>>>
>>>>> "city":"Dallas",
>>>>>
>>>>> "state_province_id":1,
>>>>>
>>>>> "country_id":2,
>>>>>
>>>>> "postal_code":"40041",
>>>>>
>>>>> "40041",
>>>>>
>>>>> "is_active":1
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>>
>>>>> 5. update:
>>>>>
>>>>>
>>>>> update particular "active" address of client
>>>>>
>>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>>
>>>>> sample request
>>>>>
>>>>> {
>>>>>
>>>>> is_active:false
>>>>>
>>>>> }
>>>>>
>>>>>
>>>>> supported fields:
>>>>>
>>>>> address line fields,addresstypeid,is_active
>>>>>
>>>>>
>>>>>
>>>>> Regards,
>>>>>
>>>>> Nikhil
>>>>>
>>>>>
>>>>
>>>
>>
>
Re: Address API docs
Posted by Myrle Krantz <mk...@mifos.org>.
Thanks Nayan,
I'm just trying to understand is all. Where do potential values for
"state_province_id" come from?
Greets,
Myrle
*Myrle Krantz*
Solutions Architect
RɅĐɅЯ, The Mifos Initiative
mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
<http://facebook.com/mifos> <http://www.twitter.com/mifos>
On Mon, Jul 4, 2016 at 4:16 PM, Nayan Ambali <na...@gmail.com> wrote:
> Dear Nikhil,
>
> It would be nice if you can document it in wiki and share the link here :)
> as reference for discussion.
>
> Thanks
> Nayan Ambali
>
>
>
> Thanks and Regards,
> Nayan Ambali
> +91 9591996042
> skype: nayangambali
>
> On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hello Myrle,
>>
>> Thank you for your response.I did not take into account ISO identifiers
>> for country_id field.
>> However, now, as recommended by you, the code-code values would in
>> accordance with ISO standard.
>> Is there any thing else you would like to be in compliance with ISO?
>>
>> Regards,
>> Nikhil
>>
>> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org> wrote:
>>
>>> Hi Nikhil,
>>>
>>> Is the country id the ISO-3166-1 country numeric identifier?
>>>
>>> Greets,
>>> Myrle
>>>
>>>
>>> *Myrle Krantz*
>>> Solutions Architect
>>> RɅĐɅЯ, The Mifos Initiative
>>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>>
>>>
>>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>>
>>>> Hello Markus,Myrle,Adi,Nazeer
>>>>
>>>>
>>>> As we have agreed in previous mail chain regarding adding of Address
>>>> API as part of core product, I thought of completing its development prior
>>>> to other dependent modules.
>>>>
>>>> I have come up with REST API docs for this module and wanted your
>>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>>> pre-requisite for other modules. Please note that I have added an
>>>> additional field 'is_active' to support address change of same type of
>>>> address( and also to keep track of past address for audit purpose).
>>>>
>>>>
>>>>
>>>> 1. Create new address for client:
>>>>
>>>>
>>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>> *Sample request:*
>>>>
>>>>
>>>> POST address
>>>>
>>>> Content-Type: application/json Request Body:
>>>>
>>>> {
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 2. Retrieve all addresses of all types for particular client:
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>>
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":3,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>> 3. Retreive all addresses of particular type for specified client
>>>>
>>>>
>>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> *Sample response:*
>>>>
>>>>
>>>> [
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":0
>>>>
>>>> },
>>>>
>>>> {
>>>>
>>>> "clientId":2,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "100 west street",
>>>>
>>>> "address_line_1": "apt no 7",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>> ]
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> 4. Retrieve active address of particular type for specified clientid
>>>>
>>>>
>>>> GET
>>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>>
>>>>
>>>> Sample response:
>>>>
>>>> {
>>>>
>>>> "clientId":1,
>>>>
>>>> "addressId":2,
>>>>
>>>> "address_type": 1,
>>>>
>>>> "street": "507 west street",
>>>>
>>>> "address_line_1": "apt no 5",
>>>>
>>>> "address_line_2": "opposite to college park",
>>>>
>>>> "city":"Dallas",
>>>>
>>>> "state_province_id":1,
>>>>
>>>> "country_id":2,
>>>>
>>>> "postal_code":"40041",
>>>>
>>>> "40041",
>>>>
>>>> "is_active":1
>>>>
>>>> }
>>>>
>>>>
>>>>
>>>> 5. update:
>>>>
>>>>
>>>> update particular "active" address of client
>>>>
>>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>>
>>>> sample request
>>>>
>>>> {
>>>>
>>>> is_active:false
>>>>
>>>> }
>>>>
>>>>
>>>> supported fields:
>>>>
>>>> address line fields,addresstypeid,is_active
>>>>
>>>>
>>>>
>>>> Regards,
>>>>
>>>> Nikhil
>>>>
>>>>
>>>
>>
>
Re: Address API docs
Posted by Nayan Ambali <na...@gmail.com>.
Dear Nikhil,
It would be nice if you can document it in wiki and share the link here :)
as reference for discussion.
Thanks
Nayan Ambali
Thanks and Regards,
Nayan Ambali
+91 9591996042
skype: nayangambali
On Mon, Jul 4, 2016 at 7:15 PM, Nikhil Pawar <ni...@gmail.com> wrote:
> Hello Myrle,
>
> Thank you for your response.I did not take into account ISO identifiers
> for country_id field.
> However, now, as recommended by you, the code-code values would in
> accordance with ISO standard.
> Is there any thing else you would like to be in compliance with ISO?
>
> Regards,
> Nikhil
>
> On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org> wrote:
>
>> Hi Nikhil,
>>
>> Is the country id the ISO-3166-1 country numeric identifier?
>>
>> Greets,
>> Myrle
>>
>>
>> *Myrle Krantz*
>> Solutions Architect
>> RɅĐɅЯ, The Mifos Initiative
>> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
>> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>>
>>
>> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>>
>>> Hello Markus,Myrle,Adi,Nazeer
>>>
>>>
>>> As we have agreed in previous mail chain regarding adding of Address API
>>> as part of core product, I thought of completing its development prior to
>>> other dependent modules.
>>>
>>> I have come up with REST API docs for this module and wanted your
>>> feedback.Kindly provide your feedback as soon as possible, since this is a
>>> pre-requisite for other modules. Please note that I have added an
>>> additional field 'is_active' to support address change of same type of
>>> address( and also to keep track of past address for audit purpose).
>>>
>>>
>>>
>>> 1. Create new address for client:
>>>
>>>
>>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>> *Sample request:*
>>>
>>>
>>> POST address
>>>
>>> Content-Type: application/json Request Body:
>>>
>>> {
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> }
>>>
>>>
>>>
>>> 2. Retrieve all addresses of all types for particular client:
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>>
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":3,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>> 3. Retreive all addresses of particular type for specified client
>>>
>>>
>>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> *Sample response:*
>>>
>>>
>>> [
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":0
>>>
>>> },
>>>
>>> {
>>>
>>> "clientId":2,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "100 west street",
>>>
>>> "address_line_1": "apt no 7",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>> ]
>>>
>>>
>>>
>>>
>>>
>>>
>>> 4. Retrieve active address of particular type for specified clientid
>>>
>>>
>>> GET
>>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>>
>>>
>>> Sample response:
>>>
>>> {
>>>
>>> "clientId":1,
>>>
>>> "addressId":2,
>>>
>>> "address_type": 1,
>>>
>>> "street": "507 west street",
>>>
>>> "address_line_1": "apt no 5",
>>>
>>> "address_line_2": "opposite to college park",
>>>
>>> "city":"Dallas",
>>>
>>> "state_province_id":1,
>>>
>>> "country_id":2,
>>>
>>> "postal_code":"40041",
>>>
>>> "40041",
>>>
>>> "is_active":1
>>>
>>> }
>>>
>>>
>>>
>>> 5. update:
>>>
>>>
>>> update particular "active" address of client
>>>
>>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>>
>>> sample request
>>>
>>> {
>>>
>>> is_active:false
>>>
>>> }
>>>
>>>
>>> supported fields:
>>>
>>> address line fields,addresstypeid,is_active
>>>
>>>
>>>
>>> Regards,
>>>
>>> Nikhil
>>>
>>>
>>
>
Re: Address API docs
Posted by Nikhil Pawar <ni...@gmail.com>.
Hello Myrle,
Thank you for your response.I did not take into account ISO identifiers for
country_id field.
However, now, as recommended by you, the code-code values would in
accordance with ISO standard.
Is there any thing else you would like to be in compliance with ISO?
Regards,
Nikhil
On Mon, Jul 4, 2016 at 7:01 PM, Myrle Krantz <mk...@mifos.org> wrote:
> Hi Nikhil,
>
> Is the country id the ISO-3166-1 country numeric identifier?
>
> Greets,
> Myrle
>
>
> *Myrle Krantz*
> Solutions Architect
> RɅĐɅЯ, The Mifos Initiative
> mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
> <http://facebook.com/mifos> <http://www.twitter.com/mifos>
>
>
> On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
>
>> Hello Markus,Myrle,Adi,Nazeer
>>
>>
>> As we have agreed in previous mail chain regarding adding of Address API
>> as part of core product, I thought of completing its development prior to
>> other dependent modules.
>>
>> I have come up with REST API docs for this module and wanted your
>> feedback.Kindly provide your feedback as soon as possible, since this is a
>> pre-requisite for other modules. Please note that I have added an
>> additional field 'is_active' to support address change of same type of
>> address( and also to keep track of past address for audit purpose).
>>
>>
>>
>> 1. Create new address for client:
>>
>>
>> POST https://DomainName/api/v1/clients/{clientid}/address/
>>
>> *Sample request:*
>>
>>
>> POST address
>>
>> Content-Type: application/json Request Body:
>>
>> {
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> }
>>
>>
>>
>> 2. Retrieve all addresses of all types for particular client:
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/
>>
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":3,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> }
>>
>> ]
>>
>>
>>
>> 3. Retreive all addresses of particular type for specified client
>>
>>
>> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> *Sample response:*
>>
>>
>> [
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":0
>>
>> },
>>
>> {
>>
>> "clientId":2,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "100 west street",
>>
>> "address_line_1": "apt no 7",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "is_active":1
>>
>> }
>>
>> ]
>>
>>
>>
>>
>>
>>
>> 4. Retrieve active address of particular type for specified clientid
>>
>>
>> GET
>> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>>
>>
>> Sample response:
>>
>> {
>>
>> "clientId":1,
>>
>> "addressId":2,
>>
>> "address_type": 1,
>>
>> "street": "507 west street",
>>
>> "address_line_1": "apt no 5",
>>
>> "address_line_2": "opposite to college park",
>>
>> "city":"Dallas",
>>
>> "state_province_id":1,
>>
>> "country_id":2,
>>
>> "postal_code":"40041",
>>
>> "40041",
>>
>> "is_active":1
>>
>> }
>>
>>
>>
>> 5. update:
>>
>>
>> update particular "active" address of client
>>
>> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>>
>> sample request
>>
>> {
>>
>> is_active:false
>>
>> }
>>
>>
>> supported fields:
>>
>> address line fields,addresstypeid,is_active
>>
>>
>>
>> Regards,
>>
>> Nikhil
>>
>>
>
Re: Address API docs
Posted by Myrle Krantz <mk...@mifos.org>.
Hi Nikhil,
Is the country id the ISO-3166-1 country numeric identifier?
Greets,
Myrle
*Myrle Krantz*
Solutions Architect
RɅĐɅЯ, The Mifos Initiative
mkrantz@mifos.org | Skype: mkrantz.mifos.org | http://mifos.org
<http://facebook.com/mifos> <http://www.twitter.com/mifos>
On Mon, Jul 4, 2016 at 2:55 PM, Nikhil Pawar <ni...@gmail.com> wrote:
> Hello Markus,Myrle,Adi,Nazeer
>
>
> As we have agreed in previous mail chain regarding adding of Address API
> as part of core product, I thought of completing its development prior to
> other dependent modules.
>
> I have come up with REST API docs for this module and wanted your
> feedback.Kindly provide your feedback as soon as possible, since this is a
> pre-requisite for other modules. Please note that I have added an
> additional field 'is_active' to support address change of same type of
> address( and also to keep track of past address for audit purpose).
>
>
>
> 1. Create new address for client:
>
>
> POST https://DomainName/api/v1/clients/{clientid}/address/
>
> *Sample request:*
>
>
> POST address
>
> Content-Type: application/json Request Body:
>
> {
>
> "address_type": 1,
>
> "street": "507 west street",
>
> "address_line_1": "apt no 5",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> }
>
>
>
> 2. Retrieve all addresses of all types for particular client:
>
>
> GET https://DomainName/api/v1/clients/{clientid}/address/
>
>
> *Sample response:*
>
>
> [
>
> {
>
> "clientId":1,
>
> "addressId":2,
>
> "address_type": 1,
>
> "street": "507 west street",
>
> "address_line_1": "apt no 5",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> "is_active":1
>
> },
>
> {
>
> "clientId":2,
>
> "addressId":3,
>
> "address_type": 1,
>
> "street": "100 west street",
>
> "address_line_1": "apt no 7",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> "is_active":0
>
> }
>
> ]
>
>
>
> 3. Retreive all addresses of particular type for specified client
>
>
> GET https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>
> *Sample response:*
>
>
> [
>
> {
>
> "clientId":2,
>
> "addressId":2,
>
> "address_type": 1,
>
> "street": "507 west street",
>
> "address_line_1": "apt no 5",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> "is_active":0
>
> },
>
> {
>
> "clientId":2,
>
> "addressId":2,
>
> "address_type": 1,
>
> "street": "100 west street",
>
> "address_line_1": "apt no 7",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> "is_active":1
>
> }
>
> ]
>
>
>
>
>
>
> 4. Retrieve active address of particular type for specified clientid
>
>
> GET
> https://DomainName/api/v1/clients/{clientid}/address/{addtypId}?command=active
>
>
> Sample response:
>
> {
>
> "clientId":1,
>
> "addressId":2,
>
> "address_type": 1,
>
> "street": "507 west street",
>
> "address_line_1": "apt no 5",
>
> "address_line_2": "opposite to college park",
>
> "city":"Dallas",
>
> "state_province_id":1,
>
> "country_id":2,
>
> "postal_code":"40041",
>
> "40041",
>
> "is_active":1
>
> }
>
>
>
> 5. update:
>
>
> update particular "active" address of client
>
> PUT https://DomainName/api/v1/clients/{clientid}/address/{addtypId}
>
> sample request
>
> {
>
> is_active:false
>
> }
>
>
> supported fields:
>
> address line fields,addresstypeid,is_active
>
>
>
> Regards,
>
> Nikhil
>
>