AlbaApi

<back to all web services

PostDocumentReq

The following routes are available for this service:
POST/documents

export class Members
{
    public homeUrl?: string;
    public success?: boolean;
    public isPensionSight?: boolean;

    public constructor(init?: Partial<Members>) { (Object as any).assign(this, init); }
}

export enum AuthenticationMethodType
{
    NemId = 'NemId',
    SSO = 'SSO',
    Common = 'Common',
    Single = 'Single',
}

export class PostDocumentReq
{
    public reference?: string;
    public languageIsoCode?: string;
    public countryIsoCode?: string;
    public clientUri?: string;
    public authenticationMethodType?: AuthenticationMethodType;
    public employeeGuid?: string;

    public constructor(init?: Partial<PostDocumentReq>) { (Object as any).assign(this, init); }
}

TypeScript PostDocumentReq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /documents HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostDocumentReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <AuthenticationMethodType>NemId</AuthenticationMethodType>
  <ClientUri>String</ClientUri>
  <CountryIsoCode>String</CountryIsoCode>
  <EmployeeGuid>00000000-0000-0000-0000-000000000000</EmployeeGuid>
  <LanguageIsoCode>String</LanguageIsoCode>
  <Reference>String</Reference>
</PostDocumentReq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Members xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
  <HomeUrl>String</HomeUrl>
  <IsPensionSight>false</IsPensionSight>
  <Success>false</Success>
</Members>