Sök koder och kontaktpersoner

Bakgrund

En fullmakt kan innehålla en eller flera koder och upp till två kontaktuppgifter med förnamn, efternamn och mailadress.

På en fullmakt går det att ange en kod för varje BKP som är ansluten till Fullmaktskollen. Vissa BKPer kräver att det ska finnas en kod angiven på fullmakten medan andra saknar det kravet. Fullmaktskollen känner inte till resp BKPs regelverk för koder eller hur en kod ska formateras. Fullmaktskollen skickar bara vidare den information som fullmaktshavaren anger på fullmakten till respektive BKP.

Samma sak gäller för kontaktuppgifter – vissa BKPer kan ha som krav att minst en kontaktuppgift ska framgå på fullmakten medan andra saknar krav på kontaktuppgifter. Det finns heller inga kontroller gällande kontaktuppgifter annat än att en mailadress måste vara formaterad som en mailadress, annars går fullmakten inte att registrera.

För att få en bättre kontroll på vilka koder och kontaktuppgifter som förekommer era fullmakter så finns det ett antal nya metoder som stöd för att söka och hämta fullmakter utifrån på kod och/eller kontaktuppgifter.

Det går att söka och lista följande:

Vilka fullmakter innehåller en viss kod?
Vilka fullmakter innehåller en viss kombination av kontaktuppgifter?
Vilka koder förekommer på de fullmakter som är skickad till en viss BKP?
Vilka unika kombinationer av kontaktuppgifter förekommer på våra fullmakter?

Därigenom går det att ta reda på vilka fullmakter som saknar eller innehåller en felaktig kod, eller vilka fullmakter som saknar eller innehåller felaktiga kontaktuppgifter.

Det är också användbart att använda metoderna vid byte av kontaktpersoner och/eller kod på en eller flera fullmakter. Byte av kod och/eller kontaktperson kan göras när som helst på en fullmakt utan att fullmaktsgivaren behöver godkänna ändringen. Metoderna kan kombineras med metoden Resend för att genomföra och meddela BKPer om bytet av koder/kontaktpersoner.

De nya metoderna är

api/v1/Agent/SearchCode
api/v1/Agent/ListUniqueCodes
api/v1/Agent/ListUniqueContacts
api/v1/Agent/SearchContact

och beskrivs nedan.

1. SearchCode

POST api/v1/Agent/SearchCode

Metoden listar de fullmakter som innehåller en angiven kod. Innehållet i responsen kan begränsas genom att ange identiteten på en BKP (PresenteeParty).

1. Request Information

1. URI Parameters

None

1. Body Parameters

Name	Description	Type	Notes
Code	Kod	string
PresenteePartyNumber	Identitet för en BKP	string	Valfritt
Skip	Antal fullmakter som ska uteslutas	integer
Take	Antal fullmakter som ska returneras	integer

1. Request Formats

text/xml, application/xml

1. Sample request

<CodeSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Code>12345</Code>
  <PresenteePartyNumber>161122334459</PresenteePartyNumber>
  <Skip>0</Skip>
  <Take>10000</Take>
</CodeSearchRequest>

1. Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

1. Response content

Name	Description	Type
Code	Kod	string
PresenteePartyName	Namnet på BKP	string
PresenteePartyNumber	Identitet för BKP	string
PoaId	Fullmaktens unika identitet	globally unique identifier
GrantorName	Fullmaktsgivarens namn	string
GrantorNumber	Fullmaktsgivarens person/organisationsnummer	string
ResponseCount	Antalet fullmakter i svaret	integer
Throttled	Svaret är begränsat	boolean
TotalCount	Antalet fullmakter mot motsvarar sökkriterierna	integer

1. Sample response

<CodeSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <CodeDetail>
    <PoaCodeDetail>
      <Code>12345</Code>
      <PresenteePartyName>BKP1</PresenteePartyName>
      <PresenteePartyNumber>161122334459</PresenteePartyNumber>
      <PoaDetails>
        <PoaId>51ca2e5b-f39a-4a33-92e8-c04a61aebbbf</PoaId>
        <GrantorName>Test Person</GrantorName>
        <GrantorNumber>197907099282</GrantorNumber>
      </PoaDetails>
    </PoaCodeDetail>
  </CodeDetail>
  <ResponseCount>1</ResponseCount>
  <Throttled>false</Throttled>
  <TotalCount>6</TotalCount>
</CodeSearchResponse>

2. ListUniqueCodes

POST api/v1/Agent/ListUniqueCodes

Metoden listar alla unika koder som förekommer eller har förekommit på fullmaktshavarens alla fullmakter för en angiven BKP.

2. Request Information

2. URI Parameters

None

2. Body Parameters

Name	Description	Type	Notes
PresenteePartyNumber	Identitet för en BKP	string

2. Request Formats

text/xml, application/xml

2. Sample request

<ListUniqueCodesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <PresenteePartyNumber>161122334459</PresenteePartyNumber>
</ListUniqueCodesRequest>

2. Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

2. Response content

Name	Description	Type	Notes
Code	Kod	string
TotalCount	Antal unika koder	integer

2. Sample response

<ListUniqueCodesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <UniqueCodes>
    <UniqueCodeDetails>
      <Code i:nil="true"/>
    </UniqueCodeDetails>
    <UniqueCodeDetails>
      <Code>kod_123</Code>
    </UniqueCodeDetails>
    <UniqueCodeDetails>
      <Code>11239</Code>
    </UniqueCodeDetails>
    <UniqueCodeDetails>
      <Code>123</Code>
    </UniqueCodeDetails>
 </UniqueCodes>
  <TotalCount>30</TotalCount>
</ListUniqueCodesResponse>

OBS! Tänk på att resultatet innehåller koder för alla fullmakter, även de som är avslutade. Resultatet innehåller också koder som tidigare har använts med som kan ha ändrats.

3. SearchContact

POST api/v1/Agent/SearchContact

Metoden söker efter fullmakter som innehåller angivna uppgifter.

3. Request Information

3. URI Parameters

None

3. Body Parameters

Name	Description	Type	Notes
Email	Mailadress i kontaktuppgiften	string	Kan utelämnas. Då sker sökning enbart på övriga parametrar. Om värdet saknar innehåll så söker metoden efter kontaktuppgifter som saknar mailadress.
FirstName	Förnamn i kontaktuppgiften	string	Kan utelämnas. Då sker sökning enbart på övriga parametrar. Om värdet saknar innehåll så söker metoden efter kontaktuppgifter som saknar förnamn .
LastName	Efternamn i kontaktuppgiften	string	Kan utelämnas. Då sker sökning enbart på övriga parametrar. Om värdet saknar innehåll så söker metoden efter kontaktuppgifter som saknar efternamn.
Skip	Antalet fullmakter som ska uteslutas	integer
Take	Antalet fullmakter som ska returneras	integer

3. Sample request

<ContactSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Email>test@testkonto.net</Email>
  <FirstName>Test</FirstName>
  <LastName>Person</LastName>
  <Skip>0</Skip>
  <Take>1000</Take>
</ContactSearchRequest>

3. Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

3. Response content

Name	Description	Type
FirstName	Förnamn i kontaktuppgiften	string
LastName	Efternamn i kontaktuppgiften	string
Email	Mailadress i kontaktuppgiften	string
ContactRole	Angiven som Kontakt1 eller Kontakt2	string
PoaId	Fullmaktens unika identitet	globally unique identifier
GrantorName	Fullmaktsgivarens namn	string
GrantorNumber	Fullmaktshavarens person/organisationsnummer	string
ResponseCount	Antal i svaret	integer
Throttled	Svaret är begränsat	boolean
TotalCount	Totalt antal	integer

3. Sample response

<ContactSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Contacts>
    <ContactDetails>
      <FirstName/>
      <LastName/>
      <Email>test@testkonto.net</Email>
      <ContactRole>Contact1</ContactRole>
      <PoaDetails>
        <PoaId>0fc2587d-d23d-40b5-b58b-41dd2f114bd5</PoaId>
        <GrantorName>Jan Långben</GrantorName>
        <GrantorNumber>196211262834</GrantorNumber>
      </PoaDetails>
    </ContactDetails>
 </Contacts>
 <ResponseCount>4</ResponseCount>
 <Throttled>false</Throttled>
 <TotalCount>4</TotalCount>
</ContactSearchResponse>

4. ListUniqueContacts

POST api/v1/Agent/ListUniqueContacts

Metoden söker efter alla unika kombinationer av angivna kontaktuppgifter på gällande fullmakter.

4. Request Information

4. URI Parameters

None

4. Body Parameters

Name	Description	Type	Notes
Skip	Antalet fullmakter som ska uteslutas	integer
Take	Antalet fullmakter som ska returneras	integer

4. Sample request

<ListUniqueContactsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Skip>0</Skip>
  <Take>10000</Take>
</ListUniqueContactsRequest>

4. Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

4. Response content

Name	Description	Type
FirstName	Förnamn i kontaktuppgiften	string
LastName	Efternamn i kontaktuppgiften	string
Email	Mailadress i kontaktuppgiften	string
ResponseCount	Antal svar	integer
Throttled	Svaret är begränsat	boolean
TotalCount	Totalt antal	integer

4. Sample response

<ListUniqueContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Contacts>
    <UniqueContactDetailsCombination>
      <FirstName i:nil="true"/>
      <LastName i:nil="true"/>
      <Email i:nil="true"/>
    </UniqueContactDetailsCombination>
    <UniqueContactDetailsCombination>
      <FirstName i:nil="true"/>
      <LastName i:nil="true"/>
      <Email>test@test.se</Email>
    </UniqueContactDetailsCombination>
  </Contacts>
  <ResponseCount>67</ResponseCount>
  <Throttled>true</Throttled>
  <TotalCount>67</TotalCount>
</ListUniqueContactsResponse>