AlbaApi

<back to all web services

AdminAppReq

The following routes are available for this service:
All Verbs/admin/app
All Verbs/admin/app/{Country}
All Verbs/admin/app/{Country}/{Lang}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class AdminAppReq
    {
        public String country = null;
        public String lang = null;
        
        public String getCountry() { return country; }
        public AdminAppReq setCountry(String value) { this.country = value; return this; }
        public String getLang() { return lang; }
        public AdminAppReq setLang(String value) { this.lang = value; return this; }
    }

    public static class AdminAppData
    {
        public HashMap<String,SiteSection> siteStructure = null;
        public HashMap<String,ArrayList<String>> sectionElements = null;
        public HashMap<String,String> listRelationships = null;
        public ArrayList<ListItem> listItems = null;
        public HashMap<String,Country> countries = null;
        public ArrayList<Content> content = null;
        public User user = null;
        public ArrayList<ScriptTracker> scriptTrackerRecords = null;
        public ArrayList<Configuration> configurations = null;
        
        public HashMap<String,SiteSection> getSiteStructure() { return siteStructure; }
        public AdminAppData setSiteStructure(HashMap<String,SiteSection> value) { this.siteStructure = value; return this; }
        public HashMap<String,ArrayList<String>> getSectionElements() { return sectionElements; }
        public AdminAppData setSectionElements(HashMap<String,ArrayList<String>> value) { this.sectionElements = value; return this; }
        public HashMap<String,String> getListRelationships() { return listRelationships; }
        public AdminAppData setListRelationships(HashMap<String,String> value) { this.listRelationships = value; return this; }
        public ArrayList<ListItem> getListItems() { return listItems; }
        public AdminAppData setListItems(ArrayList<ListItem> value) { this.listItems = value; return this; }
        public HashMap<String,Country> getCountries() { return countries; }
        public AdminAppData setCountries(HashMap<String,Country> value) { this.countries = value; return this; }
        public ArrayList<Content> getContent() { return content; }
        public AdminAppData setContent(ArrayList<Content> value) { this.content = value; return this; }
        public User getUser() { return user; }
        public AdminAppData setUser(User value) { this.user = value; return this; }
        public ArrayList<ScriptTracker> getScriptTrackerRecords() { return scriptTrackerRecords; }
        public AdminAppData setScriptTrackerRecords(ArrayList<ScriptTracker> value) { this.scriptTrackerRecords = value; return this; }
        public ArrayList<Configuration> getConfigurations() { return configurations; }
        public AdminAppData setConfigurations(ArrayList<Configuration> value) { this.configurations = value; return this; }
    }

    public static class SiteSection
    {
        public String route = null;
        @SerializedName("public") public Boolean Public = null;
        public String parent = null;
        public Integer roles = null;
        public ArrayList<String> hideFrom = null;
        public Integer order = null;
        
        public String getRoute() { return route; }
        public SiteSection setRoute(String value) { this.route = value; return this; }
        public Boolean isPublic() { return Public; }
        public SiteSection setPublic(Boolean value) { this.Public = value; return this; }
        public String getParent() { return parent; }
        public SiteSection setParent(String value) { this.parent = value; return this; }
        public Integer getRoles() { return roles; }
        public SiteSection setRoles(Integer value) { this.roles = value; return this; }
        public ArrayList<String> getHideFrom() { return hideFrom; }
        public SiteSection setHideFrom(ArrayList<String> value) { this.hideFrom = value; return this; }
        public Integer getOrder() { return order; }
        public SiteSection setOrder(Integer value) { this.order = value; return this; }
    }

    public static class ListItem extends Entity
    {
        public String listId = null;
        public String country = null;
        public String relatedId = null;
        public String code = null;
        public String custom = null;
        
        public String getListId() { return listId; }
        public ListItem setListId(String value) { this.listId = value; return this; }
        public String getCountry() { return country; }
        public ListItem setCountry(String value) { this.country = value; return this; }
        public String getRelatedId() { return relatedId; }
        public ListItem setRelatedId(String value) { this.relatedId = value; return this; }
        public String getCode() { return code; }
        public ListItem setCode(String value) { this.code = value; return this; }
        public String getCustom() { return custom; }
        public ListItem setCustom(String value) { this.custom = value; return this; }
    }

    public static class Entity implements IEntity
    {
        public String id = null;
        
        public String getId() { return id; }
        public Entity setId(String value) { this.id = value; return this; }
    }

    public static class Country
    {
        public String name = null;
        public HashMap<String,String> languages = null;
        
        public String getName() { return name; }
        public Country setName(String value) { this.name = value; return this; }
        public HashMap<String,String> getLanguages() { return languages; }
        public Country setLanguages(HashMap<String,String> value) { this.languages = value; return this; }
    }

    public static class Content extends Entity
    {
        public String section = null;
        public String itemId = null;
        public String itemCode = null;
        public String country = null;
        public String lang = null;
        public String app = null;
        public String companyId = null;
        public String company = null;
        public HashMap<String,String> elements = null;
        
        public String getSection() { return section; }
        public Content setSection(String value) { this.section = value; return this; }
        public String getItemId() { return itemId; }
        public Content setItemId(String value) { this.itemId = value; return this; }
        public String getItemCode() { return itemCode; }
        public Content setItemCode(String value) { this.itemCode = value; return this; }
        public String getCountry() { return country; }
        public Content setCountry(String value) { this.country = value; return this; }
        public String getLang() { return lang; }
        public Content setLang(String value) { this.lang = value; return this; }
        public String getApp() { return app; }
        public Content setApp(String value) { this.app = value; return this; }
        public String getCompanyId() { return companyId; }
        public Content setCompanyId(String value) { this.companyId = value; return this; }
        public String getCompany() { return company; }
        public Content setCompany(String value) { this.company = value; return this; }
        public HashMap<String,String> getElements() { return elements; }
        public Content setElements(HashMap<String,String> value) { this.elements = value; return this; }
    }

    public static class User
    {
        public Roles roles = null;
        
        public Roles getRoles() { return roles; }
        public User setRoles(Roles value) { this.roles = value; return this; }
    }

    @Flags()
    public static enum Roles
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Employee(1),
        @SerializedName("2") Member(2),
        @SerializedName("4") Employer(4),
        @SerializedName("8") Broker(8),
        @SerializedName("16") Developer(16),
        @SerializedName("32") SysAdmin(32);

        private final int value;
        Roles(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class ScriptTracker extends Entity
    {
        public String sprint = null;
        public String country = null;
        public String language = null;
        public String section = null;
        public String itemCode = null;
        public String element = null;
        public String value = null;
        public Boolean isFromMerge = null;
        
        public String getSprint() { return sprint; }
        public ScriptTracker setSprint(String value) { this.sprint = value; return this; }
        public String getCountry() { return country; }
        public ScriptTracker setCountry(String value) { this.country = value; return this; }
        public String getLanguage() { return language; }
        public ScriptTracker setLanguage(String value) { this.language = value; return this; }
        public String getSection() { return section; }
        public ScriptTracker setSection(String value) { this.section = value; return this; }
        public String getItemCode() { return itemCode; }
        public ScriptTracker setItemCode(String value) { this.itemCode = value; return this; }
        public String getElement() { return element; }
        public ScriptTracker setElement(String value) { this.element = value; return this; }
        public String getValue() { return value; }
        public ScriptTracker setValue(String value) { this.value = value; return this; }
        public Boolean getIsFromMerge() { return isFromMerge; }
        public ScriptTracker setIsFromMerge(Boolean value) { this.isFromMerge = value; return this; }
    }

    public static class Configuration extends Entity
    {
        public String category = null;
        public HashMap<String,Country> countries = null;
        public ArrayList<ListItem> listItems = null;
        public HashMap<String,String> listRelationships = null;
        public HashMap<String,ArrayList<String>> sectionElements = null;
        public HashMap<String,SiteSection> siteStructure = null;
        public Integer version = null;
        public String createdBy = null;
        public Date dateCreated = null;
        public String updatedBy = null;
        public Date dateUpdated = null;
        
        public String getCategory() { return category; }
        public Configuration setCategory(String value) { this.category = value; return this; }
        public HashMap<String,Country> getCountries() { return countries; }
        public Configuration setCountries(HashMap<String,Country> value) { this.countries = value; return this; }
        public ArrayList<ListItem> getListItems() { return listItems; }
        public Configuration setListItems(ArrayList<ListItem> value) { this.listItems = value; return this; }
        public HashMap<String,String> getListRelationships() { return listRelationships; }
        public Configuration setListRelationships(HashMap<String,String> value) { this.listRelationships = value; return this; }
        public HashMap<String,ArrayList<String>> getSectionElements() { return sectionElements; }
        public Configuration setSectionElements(HashMap<String,ArrayList<String>> value) { this.sectionElements = value; return this; }
        public HashMap<String,SiteSection> getSiteStructure() { return siteStructure; }
        public Configuration setSiteStructure(HashMap<String,SiteSection> value) { this.siteStructure = value; return this; }
        public Integer getVersion() { return version; }
        public Configuration setVersion(Integer value) { this.version = value; return this; }
        public String getCreatedBy() { return createdBy; }
        public Configuration setCreatedBy(String value) { this.createdBy = value; return this; }
        public Date getDateCreated() { return dateCreated; }
        public Configuration setDateCreated(Date value) { this.dateCreated = value; return this; }
        public String getUpdatedBy() { return updatedBy; }
        public Configuration setUpdatedBy(String value) { this.updatedBy = value; return this; }
        public Date getDateUpdated() { return dateUpdated; }
        public Configuration setDateUpdated(Date value) { this.dateUpdated = value; return this; }
    }

}

Java 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>