ApexERPHost

<back to all web services

SaveFrmObject

Requires Authentication
The following routes are available for this service:
PUT/Core/Frm/Objects
SaveFrmObject Parameters:
NameParameterData TypeRequiredDescription
FrmObjbodyFrmObjNo
FrmObj Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
ObjectTypeformint?No
HCodeformstringNo
ParentFormformstringNo
NoteformstringNo
DataSourceIdformGuid?No
IsDynamicformboolNo
CatIdformGuid?No
Visibilityformbool?No
ParamsformFormObjParamsNo
CopyCountformint?No
FormObjParams Parameters:
NameParameterData TypeRequiredDescription
ShowInMenuformbool?No
ImageformstringNo
LargeImageformstringNo
OrderIndexformint?No
ParentFormTypeformstringNo
SaveFrmObjectResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

PUT /Core/Frm/Objects HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveFrmObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services">
  <FrmObj>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <ObjectType>0</ObjectType>
    <HCode>String</HCode>
    <ParentForm>String</ParentForm>
    <Note>String</Note>
    <DataSourceId>00000000-0000-0000-0000-000000000000</DataSourceId>
    <IsDynamic>false</IsDynamic>
    <CatId>00000000-0000-0000-0000-000000000000</CatId>
    <Visibility>false</Visibility>
    <Params>
      <ShowInMenu>false</ShowInMenu>
      <Image>String</Image>
      <LargeImage>String</LargeImage>
      <OrderIndex>0</OrderIndex>
      <ParentFormType>String</ParentFormType>
    </Params>
    <CopyCount>0</CopyCount>
  </FrmObj>
</SaveFrmObject>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveFrmObjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveFrmObjectResponse>