Om en BKP har fått en kundfråga (IsCustomer-request) och svarat ja, så har BKP:n behörighet till information om fullmakten.
Om en BKP har fått en kundfråga (IsCustomer-request) och svarat nej, så saknar BKP:n behörighet till information om fullmakten.
Men BKP:n kan ändra svaret på kundfrågan från nej till ja och får då behörighet till information om fullmakten.
Om en BKP inte har fått en kundfråga på en fullmakt så saknar BKP:n behörighet till information om fullmakten.
En BKP som har svarat ja på en kundfråga för en given fullmakt har en ”prenumeration” på den fullmakten. Fullmaktskollen skickar alltid meddelanden om förändringar till alla BKP:er som prenumererar på fullmakten. Exempel på förändringar är att fullmaktsgivaren återkallar fullmakten eller ändrar på fullmaktens giltighetstid.
Det finns ett antal metoder om kan användas för att
- Söka efter besvarade kundfrågor
- Ändra svar på en kundfråga
- Ändra ett svar på en kundfråga från nej till ja och få fullmakten pushad till det egna systemet
- Avsluta en prenumeration
1. Söka efter besvarade kundfrågor
POST /api/v1/POA/SearchCustomerResponse
Anropet innehåller antingen ett personnummer/organisationsnummer eller namnet på fullmaktsgivaren som sökbegrepp. Som tillägg kan resultatet begränsas till att bara returnera obesvarade kundfrågor. Antalet rader i resultatet kan begränsas och det går att ange i vilken ordning resultatet ska sorteras. Det finns ofta ingen anledning att begränsa antalet rader om sökningen görs på person- eller organisationsnummer eftersom antalet träffar borde bli ganska få.
Anropet innehåller
Element | Beskrivning |
---|---|
Count | Antal svar |
Filter | Söksträng |
HideAnsweredCustomerRequests | Göm besvarade kundfrågor från sökresultatet |
OrderBy | Sorteringsbegrepp |
Scope | Sökbegrepp |
Skip | Antalet rader som ska utelämnas |
SortDirection | Sorteringsordning |
Exempel på anrop
<POASearchCustomerResponseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
<Count>999</Count>
<Filter>196211262834</Filter>
<HideAnsweredCustomerRequests>false</HideAnsweredCustomerRequests>
<OrderBy>Status</OrderBy>
<Scope>RegistrationNumber</Scope>
<Skip>0</Skip>
<SortDirection>Descending</SortDirection>
</POASearchCustomerResponseRequest>
Exempel på svar
<POASearchCustomerResponseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
<Data>
<POAWithResponseListData>
<AgentName>Agent1</AgentName>
<CustomerRequestDate>2017-10-25T17:16:51.227</CustomerRequestDate>
<CustomerResponseDate>2020-05-26T19:00:17.66</CustomerResponseDate>
<IsCustomer>true</IsCustomer>
<Name>Test Persson</Name>
<Number>196211262834</Number>
<POACustomerResponseId>6750</POACustomerResponseId>
<POAId>d240913b-0c8b-4ec4-8f2d-5a2158bf1846</POAId>
<Status>Signed</Status>
<Type>InformationPrivate</Type>
<ValidFrom>2017-10-25T17:16:51.227</ValidFrom>
<Validity>UntilFurtherNotice</Validity>
</POAWithResponseListData>
<POAWithResponseListData>
<AgentName></AgentName>
<CustomerRequestDate>2020-08-05T14:28:36.567</CustomerRequestDate>
<CustomerResponseDate>2020-08-05T14:28:36.55</CustomerResponseDate>
<IsCustomer>false</IsCustomer>
<Name>Test Persson</Name>
<Number>196211262834</Number>
<POACustomerResponseId>6909</POACustomerResponseId>
<POAId>0fff518e-1a9a-45c9-93b6-a70f97b7cacb</POAId>
<Status>Unknown</Status>
<Type>Unknown</Type>
<Validity>Unknown</Validity>
</POAWithResponseListData>
</Data>
<Throttled>false</Throttled>
<TotalCount>2</TotalCount>
</POASearchCustomerResponseResponse>
I exemplet ovan så listas två kundfrågor, en som är besvarad med ”true” där informationen om fullmakten är synlig och en där kundfrågan har besvarats med ”false” där informationen om fullmakten saknas. I det senare fallet är BKP:n inte behörig att få information om fullmakten.
2. Ändra svar på en kundfråga
POST api/v1/PresenteeParty/SetIsCustomer
Svaret på kundfrågan kan ändras till ett ja-svar.
Anropet innehåller
Element | Beskrivning |
---|---|
IsCustomer | True eller False |
POAId | Fullmaktens unika identitet |
Exempel på anrop
<PresenteePartySetIsCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
<IsCustomer>true</IsCustomer>
<POAId>e37fb168-630b-47fd-bae9-f6ad5135b9af</POAId>
</PresenteePartySetIsCustomerRequest>
Exempel på svar
Anropet returnerar 204 No content
om det lyckas.
Eftersom svaret på kundfrågan har ändrats till ett ja-svar så är BKP:n nu behörig att få information om fullmakten och kan t ex hämta informationen om fullmakten med anropet GET api/v1/PresenteeParty/Get
3. Ändra svar på en kundfråga och få information om ev fullmakter
GET api/v1/PresenteeParty/SetIsCustomer
Genom att ange URL-parametrar kan anropet skicka person- eller organisationsnummer, true/false (svaret på kundfrågan) och true/false om information ska ”pushas” till det egna systemet.
Anropet innehåller
URL-parameter | Beskrivning |
---|---|
GrantorNumber | Fullmaktsgivarens person/organisationsnummer |
isCustomer | Svaret på kundfrågan (true eller false ) |
ResendValidPoas | true eller false som anger om informationen om fullmakten ska skickas |
Exempel på anrop
GET api/v1/PresenteeParty/SetIsCustomer?grantorNumber=190007069800&isCustomer=true&resendValidPoas=true
Exempel på svar
Anropet returnerar 204 No content
om det lyckas och ett PresenteePartyPOARequest
-meddelande skickas till mottagarens tjänst om resendValidPoas
är satt till true
Om det finns flera gällande fullmakter för fullmaktsgivaren så skickas samtliga fullmakter till BKP:n. Anropet kan även användas om det föreligger en prenumeration, alltså att svaret på kundfrågan tidigare har besvarats med true
.
4. Avsluta en prenumeration
POST api/v1/PresenteeParty/UnsubscribeCustomer
När ett kundförhållande mellan en BKP och en fullmaktsgivare upphör så kan BKP:n avsluta prenumerationen på alla kundens fullmakter, så att det inte längre skickas förändringsmeddelanden till BKP:n.
Exempel på anrop
<UnsubscribeCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
<RegistrationNo>196211262834</RegistrationNo>
</UnsubscribeCustomerRequest>
Anropet innehåller kundens person- eller organisationsnummer och ett lyckat anrop returnerar 204 No content