AlbaApi

AdminAppReq

The following routes are available for this service:
All Verbs	/admin/app
All Verbs	/admin/app/{Country}
All Verbs	/admin/app/{Country}/{Lang}


export class SiteSection
{
    public route?: string;
    public public?: boolean;
    public parent?: string;
    public roles?: number;
    public hideFrom?: string[];
    public order?: number;

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

export class Entity implements IEntity
{
    public id?: string;

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

export class ListItem extends Entity
{
    public listId?: string;
    public country?: string;
    public relatedId?: string;
    public code?: string;
    public custom?: string;

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

export class Country
{
    public name?: string;
    public languages?: { [index: string]: string; };

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

export class Content extends Entity
{
    public section?: string;
    public itemId?: string;
    public itemCode?: string;
    public country?: string;
    public lang?: string;
    public app?: string;
    public companyId?: string;
    public company?: string;
    public elements?: { [index: string]: string; };

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

// @Flags()
export enum Roles
{
    None = 0,
    Employee = 1,
    Member = 2,
    Employer = 4,
    Broker = 8,
    Developer = 16,
    SysAdmin = 32,
}

export class User
{
    public roles?: Roles;

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

export class ScriptTracker extends Entity
{
    public sprint?: string;
    public country?: string;
    public language?: string;
    public section?: string;
    public itemCode?: string;
    public element?: string;
    public value?: string;
    public isFromMerge?: boolean;

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

export class Configuration extends Entity
{
    public category?: string;
    public countries?: { [index: string]: Country; };
    public listItems?: ListItem[];
    public listRelationships?: { [index: string]: string; };
    public sectionElements?: { [index: string]: string[]; };
    public siteStructure?: { [index: string]: SiteSection; };
    public version?: number;
    public createdBy?: string;
    public dateCreated?: string;
    public updatedBy?: string;
    public dateUpdated?: string;

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

export class AdminAppData
{
    public siteStructure?: { [index: string]: SiteSection; };
    public sectionElements?: { [index: string]: string[]; };
    public listRelationships?: { [index: string]: string; };
    public listItems?: ListItem[];
    public countries?: { [index: string]: Country; };
    public content?: Content[];
    public user?: User;
    public scriptTrackerRecords?: ScriptTracker[];
    public configurations?: Configuration[];

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

export class AdminAppReq
{
    public country?: string;
    public lang?: string;

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

TypeScript AdminAppReq 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 /admin/app HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AdminAppReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Country>String</Country>
  <Lang>String</Lang>
</AdminAppReq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AdminAppData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Application.DTOs">
  <Configurations xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model" i:nil="true" />
  <Content xmlns:d2p1="http://schemas.datacontract.org/2004/07/TasSyd.Model">
    <d2p1:Content>
      <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
      <d2p1:App>String</d2p1:App>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:CompanyId>String</d2p1:CompanyId>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Elements xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Elements>
      <d2p1:ItemCode>String</d2p1:ItemCode>
      <d2p1:ItemId>String</d2p1:ItemId>
      <d2p1:Lang>String</d2p1:Lang>
      <d2p1:Section>String</d2p1:Section>
    </d2p1:Content>
  </Content>
  <Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringCountryFNLs6TVB>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
        <d4p1:Languages>
          <d2p1:KeyValueOfstringstring>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:KeyValueOfstringstring>
        </d4p1:Languages>
        <d4p1:Name>String</d4p1:Name>
      </d2p1:Value>
    </d2p1:KeyValueOfstringCountryFNLs6TVB>
  </Countries>
  <ListItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <d2p1:ListItem>
      <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Custom>String</d2p1:Custom>
      <d2p1:ListId>String</d2p1:ListId>
      <d2p1:RelatedId>String</d2p1:RelatedId>
    </d2p1:ListItem>
  </ListItems>
  <ListRelationships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ListRelationships>
  <ScriptTrackerRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <d2p1:ScriptTracker>
      <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Element>String</d2p1:Element>
      <d2p1:IsFromMerge>false</d2p1:IsFromMerge>
      <d2p1:ItemCode>String</d2p1:ItemCode>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:Section>String</d2p1:Section>
      <d2p1:Sprint>String</d2p1:Sprint>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:ScriptTracker>
  </ScriptTrackerRecords>
  <SectionElements xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </SectionElements>
  <SiteStructure xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
        <d4p1:HideFrom>
          <d2p1:string>String</d2p1:string>
        </d4p1:HideFrom>
        <d4p1:Order>0</d4p1:Order>
        <d4p1:Parent>String</d4p1:Parent>
        <d4p1:Public>false</d4p1:Public>
        <d4p1:Roles>0</d4p1:Roles>
        <d4p1:Route>String</d4p1:Route>
      </d2p1:Value>
    </d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
  </SiteStructure>
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <d2p1:Roles>None</d2p1:Roles>
  </User>
</AdminAppData>