Virksomhedsordning.AidService (Version 1, 2025-1)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetAidAllocation (POST /Aid/GetAidAllocation)
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | GetCaseElementRequest |
| 1 |
|
- activeOrganisationHeader | ActiveOrganisationHeaderType |
| 0 - 1 |
|
- requestUserMetadataHeader | RequestUserMetadataType |
| 0 - 1 |
|
- getCaseElementRequestType | GetCaseElementRequestType |
| 0 - 1 |
|
- - caseElementIdentifier | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | AidAllocationResponse |
| 1 |
|
- aidAllocationResponseType | AidAllocationResponseType |
| 0 - 1 |
|
- - caseElementIdentifier | uuid |
| 1 |
|
- - caseElementFlowState | CaseElementFlowStateType |
| 1 |
|
- - - jobOfferStatusIdentifier |
| 0 - 1 |
| |
- - - jobAllocationStatusIdentifier |
| 0 - 1 |
| |
- - - vitasCaseId | string | Length: 1-20 | 1 |
|
- - - vitasUrl | string | Length: 1-4000 | 1 |
|
- - - obtainedByExternalOperator | boolean |
| 1 |
|
- - - externalOperator | CompanyIdentifierType |
| 0 - 1 |
|
- - - - cvRnumberIdentifier | string | MinLength: 1 | 1 |
|
- - - - productionUnitIdentifier | string | MinLength: 1 | 1 |
|
- - - responsibleCaseworker | CaseworkerType |
| 0 - 1 |
|
- - - - responsibleCaseworkerName | PersonNavnDto |
| 1 |
|
- - - - - fornavn | string | Length: 1-50 | 1 |
|
- - - - - mellemnavn | string | Length: 0-40 | 0 - 1 |
|
- - - - - efternavn | string | Length: 1-40 | 1 |
|
- - - - responsibleCaseworkerMail | string |
| 0 - 1 |
|
- - - decisionDate | date-time |
| 0 - 1 |
|
- - companyCaseHandling | CompanyCaseHandlingType |
| 0 - 1 |
|
- - - companySigner | string |
| 0 - 1 |
|
- - - companySignerDateTime | date-time |
| 0 - 1 |
|
- - caseworkerCaseHandling | CaseWorkerCaseHandlingType |
| 0 - 1 |
|
- - - signer | string |
| 0 - 1 |
|
- - - signerDateTime | date-time |
| 0 - 1 |
|
- - company | CompanyType |
| 0 - 1 |
|
- - - companyIdentifier | CompanyIdentifierType |
| 1 |
|
- - - - cvRnumberIdentifier | string | MinLength: 1 | 1 |
|
- - - - productionUnitIdentifier | string | MinLength: 1 | 1 |
|
- - - companyName | string | Length: 1-1200 | 1 |
|
- - - companyPhoneNumber | string | Length: 3-21 | 1 |
|
- - - companyAddress | AdresseDto |
| 1 |
|
- - - - vejnavn | string | Length: 1-40 | 1 |
|
- - - - forkortetVejnavn | string | Length: 1-20 | 0 - 1 |
|
- - - - husnummer | string | MinLength: 1 | 1 |
|
- - - - etage | string |
| 0 - 1 |
|
- - - - sidedoer | string | MaxLength: 4 | 0 - 1 |
|
- - - - bygningNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - bynavn | string | Length: 1-20 | 1 |
|
- - - - distriktNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - postboksnummer | int32 | MinInclusive: 1 | 0 - 1 |
|
- - - - postnummer | string | Pattern: [0-9]{4} | 0 - 1 | Postnummer |
- - - - landekode | string | Pattern: [A-Z]{2} | 0 - 1 | Landekode (ISO 3166-1 alfa-2). |
- - - companyInformation | string | Length: 1-16000 | 0 - 1 |
|
- - - workplaceAddress | AdresseDto |
| 0 - 1 |
|
- - - - vejnavn | string | Length: 1-40 | 1 |
|
- - - - forkortetVejnavn | string | Length: 1-20 | 0 - 1 |
|
- - - - husnummer | string | MinLength: 1 | 1 |
|
- - - - etage | string |
| 0 - 1 |
|
- - - - sidedoer | string | MaxLength: 4 | 0 - 1 |
|
- - - - bygningNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - bynavn | string | Length: 1-20 | 1 |
|
- - - - distriktNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - postboksnummer | int32 | MinInclusive: 1 | 0 - 1 |
|
- - - - postnummer | string | Pattern: [0-9]{4} | 0 - 1 | Postnummer |
- - - - landekode | string | Pattern: [A-Z]{2} | 0 - 1 | Landekode (ISO 3166-1 alfa-2). |
- - - companyResponsible | CompanyResponsibleType |
| 1 |
|
- - - - companyResponsibleName | PersonNavnDto |
| 1 |
|
- - - - - fornavn | string | Length: 1-50 | 1 |
|
- - - - - mellemnavn | string | Length: 0-40 | 0 - 1 |
|
- - - - - efternavn | string | Length: 1-40 | 1 |
|
- - - - companyResponsiblePhoneNumber | string | Length: 1-20 | 1 |
|
- - - - companyResponsibleEmailAddress | string | MinLength: 1 | 1 |
|
- - - workplaceResponsible | WorkPlaceResponsibleType |
| 0 - 1 |
|
- - - - companyResponsibleName | PersonNavnDto |
| 1 |
|
- - - - - fornavn | string | Length: 1-50 | 1 |
|
- - - - - mellemnavn | string | Length: 0-40 | 0 - 1 |
|
- - - - - efternavn | string | Length: 1-40 | 1 |
|
- - - - companyResponsiblePhoneNumber | string | Length: 1-20 | 0 - 1 |
|
- - - - companyResponsibleEmailAddress | string |
| 0 - 1 |
|
- - citizen | PersonType |
| 0 - 1 |
|
- - - personCivilRegistrationIdentifier | string |
| 0 - 1 |
|
- - - personName | PersonNavnDto |
| 1 |
|
- - - - fornavn | string | Length: 1-50 | 1 |
|
- - - - mellemnavn | string | Length: 0-40 | 0 - 1 |
|
- - - - efternavn | string | Length: 1-40 | 1 |
|
- - - personPhoneNumber | string | Length: 1-20 | 0 - 1 |
|
- - - personEmailAddress | string |
| 0 - 1 |
|
- - - personAddress | AdresseDto |
| 0 - 1 |
|
- - - - vejnavn | string | Length: 1-40 | 1 |
|
- - - - forkortetVejnavn | string | Length: 1-20 | 0 - 1 |
|
- - - - husnummer | string | MinLength: 1 | 1 |
|
- - - - etage | string |
| 0 - 1 |
|
- - - - sidedoer | string | MaxLength: 4 | 0 - 1 |
|
- - - - bygningNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - bynavn | string | Length: 1-20 | 1 |
|
- - - - distriktNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - postboksnummer | int32 | MinInclusive: 1 | 0 - 1 |
|
- - - - postnummer | string | Pattern: [0-9]{4} | 0 - 1 | Postnummer |
- - - - landekode | string | Pattern: [A-Z]{2} | 0 - 1 | Landekode (ISO 3166-1 alfa-2). |
- - jobCenter | JobCenterType |
| 0 - 1 |
|
- - - jobCenterCode | string | MinLength: 1 | 1 |
|
- - - jobCenterName | string | MinLength: 1 | 1 |
|
- - - jobCenterAddress | AdresseDto |
| 1 |
|
- - - - vejnavn | string | Length: 1-40 | 1 |
|
- - - - forkortetVejnavn | string | Length: 1-20 | 0 - 1 |
|
- - - - husnummer | string | MinLength: 1 | 1 |
|
- - - - etage | string |
| 0 - 1 |
|
- - - - sidedoer | string | MaxLength: 4 | 0 - 1 |
|
- - - - bygningNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - bynavn | string | Length: 1-20 | 1 |
|
- - - - distriktNavn | string | Length: 1-34 | 0 - 1 |
|
- - - - postboksnummer | int32 | MinInclusive: 1 | 0 - 1 |
|
- - - - postnummer | string | Pattern: [0-9]{4} | 0 - 1 | Postnummer |
- - - - landekode | string | Pattern: [A-Z]{2} | 0 - 1 | Landekode (ISO 3166-1 alfa-2). |
- - - jobCenterContactPerson | ResponsiblePersonType |
| 0 - 1 |
|
- - - - responsiblePersonName | PersonNavnDto |
| 1 |
|
- - - - - fornavn | string | Length: 1-50 | 1 |
|
- - - - - mellemnavn | string | Length: 0-40 | 0 - 1 |
|
- - - - - efternavn | string | Length: 1-40 | 1 |
|
- - - - responsiblePersonPhoneNumber | string | Length: 1-20 | 0 - 1 |
|
- - - - responsiblePersonEmailAddress | string |
| 0 - 1 |
|
- - aid | AidType |
| 0 - 1 |
|
- - - disabilityDescription | string | Length: 1-4000 | 1 |
|
- - - involvedAuthority | string | Length: 1-4000 | 0 - 1 |
|
- - - teachingResource | TeachingResourceType |
| 0 - 1 |
|
- - - - itEquipment | boolean |
| 0 - 1 |
|
- - - - other | boolean |
| 0 - 1 |
|
- - - workingTools | WorkingToolsType |
| 0 - 1 |
|
- - - - workingToolsIT | boolean |
| 0 - 1 |
|
- - - - workingToolsOther | boolean |
| 0 - 1 |
|
- - - officeDecor | OfficeDecorType |
| 0 - 1 |
|
- - - - minorAvailabilitySolutions | boolean |
| 0 - 1 |
|
- - - - other | boolean |
| 0 - 1 |
|
- - - declarationIndicator | boolean |
| 0 - 1 |
|
- - - declarationReference | string | Length: 1-256 | 0 - 1 |
|
- - - aidOwnershipIdentifier |
| 1 |
| |
- - - maxPrice | double |
| 0 - 1 |
|
- - - startDateTime | date-time |
| 1 |
|
- - - endDateTime | date-time |
| 1 |
|
- - - providedByJobcenter | boolean |
| 1 |
|
- - - returnAidToJobcenter | boolean |
| 1 |
|
- - - payByInvoice | boolean |
| 1 |
|
- - - eanNumber | string |
| 0 - 1 |
|
- - - comment | string |
| 0 - 1 |
|
- - - originalEndDateTime | date-time |
| 0 - 1 |
|
Fejlkoder
Ingen fejlkoder
IsAlive (GET /Aid/IsAlive)
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | ActionResult`1 |
| 1 |
|
- result | ActionResult |
| 0 - 1 |
|
- value | IsAliveResponse |
| 0 - 1 |
|
- - isAliveResponseType | IsAliveResponseType |
| 0 - 1 |
|
- - - isAlive | boolean |
| 0 - 1 |
|
Fejlkoder
Ingen fejlkoder