Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
API:t visar avtal kopplade till en anläggning.
Livscykelstatus
Under design
Lösningsbeskrivning
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Hantering av personuppgifter
Inga personuppgifter hanteras i tjänsten.
API specifikation
| Swagger ui | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| {"openapi":"3.0.1","info":{"title":"api-agreement","contact":{},"license":{"name":"MIT License","url":"https://opensource.org/licenses/MIT"},"version":"1.0"},"servers":[{"url":"http://
| ","description":"Generated server url"}],"tags":[{"name":"Agreement","description":"Agreement resources"}],"paths":{"/api-docs":{"get":{"tags":["API"],"summary":"OpenAPI","operationId":"getApiDocs","responses":{"200":{"description":"OK","content":{"application/yaml":{"schema":{"type":"string"}}}}},"x-auth-type":"None","x-throttling-tier":"Unlimited","x-wso2-mutual-ssl":"Optional"}},"/agreements/{category}/{facilityId}":{"get":{"tags":["Agreement"],"summary":"Get agreements by category and facility-id","operationId":"getAgreementsByCategoryAndFacilityId","parameters":[{"name":"category","in":"path","description":"Agreement category","required":true,"schema":{"type":"string","description":"Category model","enum":["COMMUNICATION","DISTRICT_HEATING","DISTRICT_COOLING","ELECTRICITY","ELECTRICITY_TRADE","WASTE_MANAGEMENT","WATER"]},"example":"ELECTRICITY"},{"name":"facilityId","in":"path","description":"Id for the facility","required":true,"schema":{"type":"string"},"example":1471222}],"responses":{"500":{"description":"Internal Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Problem"},{"$ref":"#/components/schemas/ConstraintViolationProblem"}]}},"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Problem"},{"$ref":"#/components/schemas/ConstraintViolationProblem"}]}}}},"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreementResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/AgreementResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}},"components":{"schemas":{"Problem":{"type":"object","properties":{"instance":{"type":"string","format":"uri"},"type":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"$ref":"#/components/schemas/StatusType"},"title":{"type":"string"},"detail":{"type":"string"}}},"StatusType":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"reasonPhrase":{"type":"string"}}},"ConstraintViolationProblem":{"type":"object","properties":{"cause":{"$ref":"#/components/schemas/ThrowableProblem"},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"type":{"type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/StatusType"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"title":{"type":"string"},"message":{"type":"string"},"instance":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"detail":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"ThrowableProblem":{"type":"object","properties":{"cause":{"$ref":"#/components/schemas/ThrowableProblem"},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"instance":{"type":"string","format":"uri"},"type":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"$ref":"#/components/schemas/StatusType"},"title":{"type":"string"},"detail":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"Violation":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}},"Agreement":{"type":"object","properties":{"agreementId":{"type":"string","description":"Agreement identifier","readOnly":true,"example":"223344-A"},"description":{"type":"string","description":"Description","readOnly":true,"example":"The master agreement"},"mainAgreement":{"type":"boolean","description":"Signal indicating whether the agreement is the main agreement or not","readOnly":true,"example":true},"binding":{"type":"boolean","description":"Signal indicating whether the agreement has a binding period or not","readOnly":true,"example":true},"bindingRule":{"type":"string","description":"Description of the binding rule in cases where the agreement has a binding period","nullable":true,"readOnly":true,"example":"12 mån bindning"},"fromDate":{"type":"string","description":"Start date of the agreement","format":"date","readOnly":true,"example":"2022-01-01"},"toDate":{"type":"string","description":"End date of the agreement","format":"date","readOnly":true,"example":"2022-12-31"}},"description":"Agreement model","readOnly":true},"AgreementResponse":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer identifier at the supplier of the agreement","readOnly":true,"example":"81471222"},"billingId":{"type":"string","description":"Billing identifier","readOnly":true,"example":"111222333"},"agreements":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Agreement"}}},"description":"Agreement response model"}},"securitySchemes":{}}}
| |||||||
Säkerhetsklassning
Säkerhetsklass <0, 1, 2, 3, 4>
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/API
För tekniska frågor: teamunmasked@sundsvall.se