POST api/v1/POA/Search

Sök ut en delmängd av fullmaktsbeståndet. Använd "List" för att iterera över hela beståndet. Fullmaktshavare kan söka på fullmakter de själva äger, BKP:er kan söka på signerade fullmakter där en kundfråga ställts eller ska ställas till dem.

Allowed Roles

BKP
Fullmaktshavare

Request Information

POASearchRequest

Name	Description	Type	Additional information
Count	Max antal result som ska hämtas.	integer	Required
Filter	Den textsträng som filtreringen ska matchas mot.	string	String length: inclusive between 0 and 255
HideAnsweredCustomerRequests	Används av BKP:er för att dölja fullmakter vars portvaktsfråga har besvarats.	boolean	Required
HideExpiredAndRecalled	Dölj fullmakter som har gått ut, återkallats (av fullmaktsgivaren) eller inaktiverats (av fullmaktshavaren).	boolean	Required
OrderBy	Anger vilken egenskap sökresultatet ska sorteras efter.	POASearchOrderBy	Required
Scope	Anger egenskap på en fullmakt som filteringen matchas mot.	POASearchFilterScope	Required
Skip	Antal resultat som ska hoppas över.	integer	Required
SortDirection	Anger om sökresultatet ska sorteras i stigande eller fallande ordning.	POASearchDirection	Required
IntervalStartDate	Startdatum (UTC) för intervall för att dölja fullmakter som inte finns inom intervallet. Se även SearchBySignedAt.	date	None.
IntervalEndDate	Slutdatum (UTC) för intervall för att dölja fullmakter som inte finns inom intervallet. Se även SearchBySignedAt.	date	None.
HidePrivatePOAs	Dölj individfullmakter.	boolean	Required
HideOrganizationPOAs	Dölj organisationsfullmakter.	boolean	Required
HideInformationPOAs	Dölj informationsfullmakter.	boolean	Required
HideMaintenancePOAs	Dölj förmedlingsfullmakter.	boolean	Required
HideUnsignedPOAs	Dölj fullmakter som är osignerade (av fullmaktsgivaren).	boolean	Required
HidePartiallySignedPOAs	Dölj fullmakter som är delvis signerade (av fullmaktsgivaren).	boolean	Required
HideSignedPOAs	Dölj fullmakter som har signerats (av fullmaktsgivaren).	boolean	Required
HideRecalledPOAs	Dölj fullmakter som har återkallats (av fullmaktsgivaren).	boolean	Required
HideDisabledPOAs	Dölj fullmakter som är inaktiverade (av fullmaktshavaren).	boolean	Required
HideExpiredPOAs	Dölj fullmakter som har gått ut.	boolean	Required
SearchBySignedAt	Väljer om IntervalStartDate och IntervalEndDate ska gälla signeringsdatum eller giltig från (default).	boolean	None.
Validity	Alla oavsett om slutdatum eller ej	POAValidityType	None.
ExpiresStartDate	Startdatum (UTC) för intervall för fullmakter som går ut inom intervallet.	date	None.
ExpiresEndDate	Slutdatum (UTC) för intervall för fullmakter som går ut inom intervallet.	date	None.
IncludeOrganizationNumber	Villkor som används för att visa eller dölja organisationsnummer.	boolean	None.
IncludeCode	Villkor som används för att visa eller dölja förmedlarkod.	boolean	None.
ModifiedFrom	Används för att filtrera fullmakter baserat på datum för senaste ändringen.	date	None.
ModifiedTo	Används för att filtrera fullmakter baserat på datum för senaste ändringen.	date	None.

Request Formats

application/xml, text/xml

Sample:

<POASearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Count>1</Count>
  <Filter>Anders</Filter>
  <HideAnsweredCustomerRequests>true</HideAnsweredCustomerRequests>
  <HideExpiredAndRecalled>true</HideExpiredAndRecalled>
  <OrderBy>ValidFrom</OrderBy>
  <Scope>Name</Scope>
  <Skip>5</Skip>
  <SortDirection>Ascending</SortDirection>
  <IntervalStartDate i:nil="true" />
  <IntervalEndDate i:nil="true" />
  <HidePrivatePOAs>false</HidePrivatePOAs>
  <HideOrganizationPOAs>false</HideOrganizationPOAs>
  <HideInformationPOAs>false</HideInformationPOAs>
  <HideMaintenancePOAs>false</HideMaintenancePOAs>
  <HideUnsignedPOAs>false</HideUnsignedPOAs>
  <HidePartiallySignedPOAs>false</HidePartiallySignedPOAs>
  <HideSignedPOAs>false</HideSignedPOAs>
  <HideRecalledPOAs>false</HideRecalledPOAs>
  <HideDisabledPOAs>false</HideDisabledPOAs>
  <HideExpiredPOAs>false</HideExpiredPOAs>
  <SearchBySignedAt i:nil="true" />
  <Validity i:nil="true" />
  <ExpiresStartDate i:nil="true" />
  <ExpiresEndDate i:nil="true" />
  <IncludeOrganizationNumber>false</IncludeOrganizationNumber>
  <IncludeCode>false</IncludeCode>
  <ModifiedFrom i:nil="true" />
  <ModifiedTo i:nil="true" />
</POASearchRequest>

Response Information

Resource Description

En lista över fullmakter som matchar sökkriteriet.

POASearchResponse

Name	Description	Type	Additional information
Data	Information om funna fullmakter.	Collection of POAListData	Required
Throttled	Anger om sökfrågan ger träff på för många resultat. I dessa fall behöver en mer specifik sökfråga ställas för att kunna lista alla fullmakter.	boolean	Required
TotalCount	Det totala antalet fullmakter som går att läsa ut för angiven sökfråga.	integer	Required

Response Formats

application/xml, text/xml

Sample:

<POASearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
  <Data>
    <POAListData>
      <AgentName i:nil="true" />
      <Name i:nil="true" />
      <Number i:nil="true" />
      <POAId>edd1a2ac-73f0-4617-a8d7-fe57b67e64b3</POAId>
      <Status>Signed</Status>
      <Type>InformationPrivate</Type>
      <ValidFrom>2015-01-01T00:00:00</ValidFrom>
      <Validity>Timespan</Validity>
      <ValidTo>2015-01-02T22:59:59</ValidTo>
    </POAListData>
    <POAListData>
      <AgentName i:nil="true" />
      <Name i:nil="true" />
      <Number i:nil="true" />
      <POAId>7d2a724d-55c0-4667-acc8-afaa04fef50c</POAId>
      <Status>Recalled</Status>
      <Type>MaintenanceOrganization</Type>
      <ValidFrom>2015-01-01T00:00:00</ValidFrom>
      <Validity>UntilFurtherNotice</Validity>
    </POAListData>
  </Data>
  <Throttled>false</Throttled>
  <TotalCount>32</TotalCount>
</POASearchResponse>

Other Responses

401 Unauthorized

400 Bad Request

ERRPOASRC0002: Invalid organization number or civic registration number.
ERRPOASRC0003: The Count field must be greater than 0.
ERRPOASRC0004: You can't do a search with just IntervalEndDate
ERRPOASRC0005: At least one of HidePrivatePOAs or HideOrganizationPOAs must be false to get a search result.
ERRPOASRC0006: At least one of HideInformationPOAs or HideMaintenancePOAs must be false to get a search result.
ERRPOASRC0007: At least one status needs to be shown to get a search result.
ERRPOASRC0008: IntervalStartDate must be earlier or same as IntervalEndDate.
ERRPOASRC0009: Invalid amount of numbers, needs to be 6 or 8
GENERR0005: Argument {0} cannot be null.