Heimstaden External API for Partners

Introduction

Contact torbjorn.myrvang@heimstaden.com for more info about this API

Iceland

API	Description
GET IcelandMaxInfo/{partnerName}/{maxInfoRule}/{loggSessionRule}/{subSetType}/{subSetKey}/{maxInfoReturLevel}?maxRows={maxRows}&syncMieRule={syncMieRule}&subSetUnitsRule={subSetUnitsRule}&extraInfoEstate={extraInfoEstate}
GET IcelandMaxInfoMie/{partnerName}/{maxInfoRule}/{loggSessionRule}/{subSetType}/{subSetKey}/{maxInfoReturLevel}/{maxRows}/{syncMieRule}/{subSetUnitsRule}/{extraInfoEstate}
GET IcelandMaxInfo/{partnerName}/{maxInfoRule}?loggSessionRule={loggSessionRule}&subSetType={subSetType}&subSetKey={subSetKey}&maxInfoReturLevel={maxInfoReturLevel}&maxRows={maxRows}&syncMieRule={syncMieRule}&subSetUnitsRule={subSetUnitsRule}&extraInfoEstate={extraInfoEstate}
GET IcelandContracts/{partnerName}
GET IcelandImages/{partnerName}/{objectidApi}
GET IcelandPdf/{partnerName}/{rentalDealIdApi}
GET IcelandRentalObject/{partnerName}
GET IcelandImages/AttachmentContentDebugV2?dataSource={dataSource}&partnerName={partnerName}&userAndSessionId={userAndSessionId}&rentalDealIdApi={rentalDealIdApi}&attachmentMainType={attachmentMainType}&attachmentSubType={attachmentSubType}&attachmentIdApi={attachmentIdApi}
GET IcelandImages/AttachmentContentDebug?dataSource={dataSource}&partnerName={partnerName}&userAndSessionId={userAndSessionId}&rentalDealIdApi={rentalDealIdApi}&attachmentMainType={attachmentMainType}&attachmentSubType={attachmentSubType}&attachmentIdApi={attachmentIdApi}

Customer

API	Description
POST LoginCustomer/SyncAuthWithTrustedApiV3Beta/{loginRule}	No documentation available.
POST LoginCustomer/SyncAuthWithTrustedApiV2	No documentation available.
POST VerifyLogin/{validateRule}?hideExceptionLevel={hideExceptionLevel}	No documentation available.
POST VerifyLogin/{validateRule}/{hideExceptionLevel}	No documentation available.
POST LoginCustomer/SyncAuthWithTrustedApi	No documentation available.
GET Customer/GetMyCustomerInfo/{dataSource}/{partnerName}/{userAndSessionId}	No documentation available.
POST Customer/UpdateMyCustomerInfo/{dataSource}/{partnerName}/{userAndSessionId}/{customerOperation}	No documentation available.
GET Customer/RentalDetails/{dataSource}/{partnerName}/{userAndSessionId}?customerIdApi={customerIdApi}&objectIdApi={objectIdApi}&rentalDealIdApi={rentalDealIdApi}&languagePrefered={languagePrefered}	Deals/contracts relevant for this customer in THIS SELECTED rental object - If the customer for the moment rents several apartments/properties then one CustomerRentalHead must be fetched for each property - If extra rental objects like parkingarea or a storage is included in the total agreement, then such related sub-contracts is returned within the rentalDealsListApi
GET Customer/RentalDetails/{dataSource}/{partnerName}/{userAndSessionId}/{customerIdApi}?objectIdApi={objectIdApi}&rentalDealIdApi={rentalDealIdApi}&languagePrefered={languagePrefered}	Deals/contracts relevant for this customer in THIS SELECTED rental object - If the customer for the moment rents several apartments/properties then one CustomerRentalHead must be fetched for each property - If extra rental objects like parkingarea or a storage is included in the total agreement, then such related sub-contracts is returned within the rentalDealsListApi
GET Customer/RentalDetails/{dataSource}/{partnerName}/{userAndSessionId}/{customerIdApi}/{objectIdApi}/{rentalDealIdApi}/{languagePrefered}	Deals/contracts relevant for this customer in THIS SELECTED rental object - If the customer for the moment rents several apartments/properties then one CustomerRentalHead must be fetched for each property - If extra rental objects like parkingarea or a storage is included in the total agreement, then such related sub-contracts is returned within the rentalDealsListApi
POST Customer/MyContractStatus/{dataSource}/{partnerName}/{userAndSessionId}	No documentation available.
GET Customer/Attachments/{dataSource}/{partnerName}/{userAndSessionId}/{attachmentFilter}/{objectIdApi}/{rentalDealIdApi}	No documentation available.
GET Customer/Attachments/{dataSource}/{partnerName}/{userAndSessionId}/{attachmentFilter}/{objectIdApi}?rentalDealIdApi={rentalDealIdApi}	No documentation available.
GET Customer/AttachmentContent/{dataSource}/{partnerName}/{userAndSessionId}/{rentalDealIdApi}/{attachmentMainType}/{attachmentSubType}/{attachmentIdApi}	No documentation available.
GET Customer/AttachmentContent/{dataSource}/{partnerName}/{userAndSessionId}/{rentalDealIdApi}/{attachmentMainType}?attachmentSubType={attachmentSubType}&attachmentIdApi={attachmentIdApi}	No documentation available.
GET Customer/AttachmentContentHtml/{dataSource}/{partnerName}/{userAndSessionId}/{rentalDealIdApi}/{attachmentMainType}/{attachmentSubType}/{attachmentIdApi}	No documentation available.
GET Customer/Invoices/{dataSource}/{partnerName}/{invoiceFilter}/{userAndSessionId}?customerIdApi={customerIdApi}&rentalDealIdApi={rentalDealIdApi}&rowLimit={rowLimit}&rowOffset={rowOffset}&newInvoicesDaysLimit={newInvoicesDaysLimit}	No documentation available.
GET Customer/Invoices/{dataSource}/{partnerName}/{invoiceFilter}/{userAndSessionId}/{customerIdApi}?rentalDealIdApi={rentalDealIdApi}&rowLimit={rowLimit}&rowOffset={rowOffset}&newInvoicesDaysLimit={newInvoicesDaysLimit}	No documentation available.
GET Customer/Invoices/{dataSource}/{partnerName}/{invoiceFilter}/{userAndSessionId}/{customerIdApi}/{rentalDealIdApi}?rowLimit={rowLimit}&rowOffset={rowOffset}&newInvoicesDaysLimit={newInvoicesDaysLimit}	No documentation available.
GET Booking/AllPending/{dataSource}/{partnerName}/{userAndSessionId}/{bookingType}?rentalDealIdApi={rentalDealIdApi}&searchOption={searchOption}
GET Booking/ThisRentalDeal/{dataSource}/{partnerName}/{userAndSessionId}/{bookingType}/{rentalDealIdApi}/{searchOption}
PUT Booking/Update/{dataSource}/{partnerName}/{userAndSessionId}	No documentation available.
POST api/Customer?dataSource={dataSource}&partnerName={partnerName}&invoiceFilter={invoiceFilter}&userAndSessionId={userAndSessionId}&customerIdApi={customerIdApi}&rentalDealIdApi={rentalDealIdApi}&rowLimit={rowLimit}&rowOffset={rowOffset}&newInvoicesDaysLimit={newInvoicesDaysLimit}	No documentation available.

MyWork

API	Description
POST Customer/AlphaSearch/{dataSource}/{partnerName}/{userAndSessionId}	Using POST instead of GET because get-with-body not supported by all frameworks
POST Ticket/Create/{dataSource}/{partnerName}/{userAndSessionId}/{testOrProdMode}	No documentation available.
POST Ticket/SyncMie/{dataSource}/{partnerName}/{userAndSessionId}/{testOrProdMode}/{syncMieRule}	No documentation available.

Admin

Scheduled jobs for sync of HeimApi Midleware database

API	Description
GET SyncXanoScheduledJob/{dataSource}/{partnerName}/{syncMieRule}/{extraInfoEstate}/{xanoRules}/{loggSessionRule}/{mainCompanyId}/{subSetUnitsRule}/{subSetType}/{subSetKey}/{maxRows}/{extraInfoLease}
POST SyncXano/{dataSource}/{partnerName}/{syncMieXanoRule}/{extraInfoEstate}/{xanoRules}/{loggSessionRule}/{mainCompanyId}/{subSetUnitsRule}/{subSetType}/{subSetKey}/{maxRows}/{extraInfoLease}	Nattjobb : http://localhost:8076/SyncMieScheduledJob/4700/PROD-MIE/10/0/100/201/0/-/-1
GET MieSyncHealthCheck/{dataSource}/{partnerName}/{subSetType}/{syncMieRule}
POST CreateApiJwtToken/{userAndSessionId}/{partnerName}/{tokenSubType}/{tokenExpireDays}/{tokenExpireMinutes}
GET ScheduledJobDenmark/{userAndSessionId}/{partnerName}/{minutesLimit}	Jobben tar ca. 10 minutter
GET ScheduledJobIceland/{userAndSessionId}/{partnerName}/{minutesLimit}
GET SyncStatusXano/{dataSource}/{minutes}/{filter}
GET JsonCompare	No documentation available.
POST XanoSwaggerDocSave/{filePrefix}
GET RestApiStatus/{extra_check}
GET RestApiStatusSweden
GET RestApiStatusDenmark
GET LoggerReset/{logglevel}/{userAndSessionId}
GET RestApiStatusV2/{dataSource}/{partnerName}/{userAndSessionId}/{healthCheckLevel}/{healthCheckOptions}
POST VerifiedAPI/SendKonvolutt	No documentation available.
GET VerifiedAPI/GetSignedDocumentURL/{envelopeId}	No documentation available.
POST VerifiedAPI/AbortEnvelope/{envelopeId}/{documentId}	No documentation available.
PUT VerifiedAPI/AddTags/{envelopeId}/{documentId}	No documentation available.
GET VerifiedAPI/GetEnvelope/{envelopeId}	No documentation available.
GET VerifiedAPI/GetEnvelopeStatus/{envelopeId}	No documentation available.
GET VerifiedAPI/GetSignURL/{envelopeId}/{recipientId}	No documentation available.
GET VerifiedAPI/GetRecipients/{envelopeId}	No documentation available.

Denmark

API	Description
GET DenmarkSyncAll/{dataSource}/{partnerName}/{maxInfoRule}/{loggSessionRule}?subSetType={subSetType}&subSetKey={subSetKey}&subSetKeyMax={subSetKeyMax}&syncRules={syncRules}&syncMieRule={syncMieRule}&subSetUnitsRule={subSetUnitsRule}&maxRows={maxRows}&maxInfoReturLevel={maxInfoReturLevel}
GET DenmarkSyncAll/{dataSource}/{partnerName}/{maxInfoRule}/{loggSessionRule}/{subSetType}/{subSetKey}/{subSetKeyMax}?syncRules={syncRules}&syncMieRule={syncMieRule}&subSetUnitsRule={subSetUnitsRule}&maxRows={maxRows}&maxInfoReturLevel={maxInfoReturLevel}
GET DenmarkSyncAllMie/{dataSource}/{partnerName}/{maxInfoRule}/{loggSessionRule}/{subSetType}/{subSetKey}/{subSetKeyMax}/{maxRows}/{syncMieRule}/{subSetUnitsRule}?syncRules={syncRules}&maxInfoReturLevel={maxInfoReturLevel}
GET DenmarkHomePageBuildings/{dataSource}/{partnerName}/{loggSessionRule}?subSetType={subSetType}&subSetKey={subSetKey}&subSetKeyMax={subSetKeyMax}
GET DenmarkHomePageBuildings/{dataSource}/{partnerName}/{loggSessionRule}/{subSetType}/{subSetKey}/{subSetKeyMax}

Rental

API	Description
GET ObjectAttachments/{dataSource}/{partnerName}/{objectIdApi}	All attachments for one rental object Mostly JPG images and floor plan, but also PDF and Links The first image in the list is the main picture to be used
GET ObjectAttachmentsAuth/{dataSource}/{partnerName}/{objectIdApi}
GET ObjectInfo/{dataSource}/{partnerName}/{objectIdApi}	Get one rental object with all rental info except attachments
GET ObjectInfoAuth/{dataSource}/{partnerName}/{objectIdApi}
GET BuildingObjects/{dataSource}/{partnerName}/{buildingKey}?objectSearchRule={objectSearchRule}
GET BuildingObjects/{dataSource}/{partnerName}/{buildingKey}/{objectSearchRule}
GET ObjectsMaxInfo/{dataSource}/{partnerName}/{loggSessionRule}	Only relevant for Netherland
GET ObjectsPublishedSelected/{dataSource}/{partnerName}/{subSetType}?subSetKey={subSetKey}	Get a list of selected rental objetcts published now or have been published earlier. The result fields are simular to the ObjectInfo method but a few elements can be skipped due to performance, see the explanation of objectDetailLevel See parameter subSetType / subSetKey for search criterias.
GET ObjectsPublishedSelected/{dataSource}/{partnerName}/{subSetType}/{subSetKey}	Get a list of selected rental objetcts published now or have been published earlier. The result fields are simular to the ObjectInfo method but a few elements can be skipped due to performance, see the explanation of objectDetailLevel See parameter subSetType / subSetKey for search criterias.
GET ObjectsPublishedSelectedAuth/{dataSource}/{partnerName}/{subSetType}?subSetKey={subSetKey}
GET ObjectsPublishedSelectedAuth/{dataSource}/{partnerName}/{subSetType}/{subSetKey}
GET ObjectsPublishedAllAuth/{dataSource}/{partnerName}	Get a list of all rental objetcts published now or have been published earlier. The result fields are simular to the ObjectInfo method but a few elements are skipped due to performance, see the explanation of objectDetailLevel Use ObjectsPublishedSelected if you want a limmited selection instead of all published objects. For Netherlands do use ObjectsMaxInfo instead
GET ObjectsPublishedAll/{dataSource}/{partnerName}
GET Areas/{dataSource}/{partnerName}	Get a list of all areas including higher level areagroups
GET AreasAuth/{dataSource}/{partnerName}
GET EstatesAndBuildings/{dataSource}/{partnerName}	Get a list of all estates and buildings Estate is the main level and building is the sublevel, but some items is both levels (an estate with only one building)
GET EstatesAndBuildingsAuth/{dataSource}/{partnerName}
GET MasterApiProxy/HealtCheck/{rule}	No documentation available.
PUT MasterApiProxy/SjekklisteLinjeV3/{sjekklisteHode_key}/{sjekkpunkt_key}/{sjekklisteId}/{sjekkpunkt_sub_key}/{userAndSessionId}	No documentation available.
PUT MasterApiProxy/SjekklisteHodeKomplett/{ref_type}/{ref_key}/{sjekklisteId}/{rundeNr}/{userAndSessionId}/{kodeOgHusnr}/{LeilighetsNr}/{steg}?hideExceptionLevel={hideExceptionLevel}&conStringRegel={conStringRegel}&tilgangSokType={tilgangSokType}
PUT MasterApiProxy/SjekklisteHodeV2/{ref_type}/{ref_key}/{sjekklisteId}/{rundeNr}/{userAndSessionId}?steg={steg}&kodeOgHusnr={kodeOgHusnr}&LeilighetsNr={LeilighetsNr}&hideExceptionLevel={hideExceptionLevel}&conStringRegel={conStringRegel}&tilgangSokType={tilgangSokType}
PUT MasterApiProxy/SjekklisteHodeFromApi/{ref_type}/{ref_key}/{sjekklisteId}/{rundeNr}/{userAndSessionId}/{steg}/{hideExceptionLevel}/{conStringRegel}/{tilgangSokType}?kodeOgHusnr={kodeOgHusnr}&LeilighetsNr={LeilighetsNr}
PUT MasterApiProxy/SjekklisteHode/{ref_type}/{ref_key}/{sjekklisteId}/{rundeNr}?userAndSessionId={userAndSessionId}&steg={steg}&kodeOgHusnr={kodeOgHusnr}&LeilighetsNr={LeilighetsNr}&hideExceptionLevel={hideExceptionLevel}&conStringRegel={conStringRegel}&tilgangSokType={tilgangSokType}
GET LeieObjektUtleieStatus/{userAndSessionId}/{kodeOgHusnr}?midlewareRule={midlewareRule}&timeoutSec={timeoutSec}
GET LeieObjektUtleieToMidlelayer/{userAndSessionId}/{kodeOgHusnr}