API Details

Particulars Description
API Name Attribute Master
Method POST
URL https://portal.zinghr.com/2015/route/Attribute/GetAttributeMaster
Description
This API fetches company attribute master details as well as units
Input format
JSON
Output format
JSON



Input

Property Name Data Type Description Mandatory Remarks
SubscriptionName
string
Subscription name of the account
Yes
Max length = 10 characters
Token string Security check. To verify the account and request
Yes
Fromdate
string To fetch attribute changes from the date mentioned.
Date format: dd-mm-yyyy
Optional
If not mentioned then the current attribute details are returned
Todate
string To fetch attribute changes till the date mentioned
Date format: dd-mm-yyyy
Optional
If Fromdate is mentioned then Todate is mandatory



Response

Property Name Data Type Description
Message string Response message from the server
Code int Response code from the server
AttributeMaster
array List of Attribute Master



Response Code and Message

Code Message Remarks
1 Success
Successful API call
3 Invalid Token
The token passed in the API did not match the token in the system. Validate the token from the Setup Circle in ZingHR portal
4 Internal Server Error
The API execution faced an unexpected error
5 Invalid date format
Use date format as dd-mm-yyyy
6 Token expired
The token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal



Attribute Master Collection

Property Name Data Type Description
AttributeTypeId
int
Attribute ID
AttributeTypeCode
string
Attribute code
AttributeTypeDesc
string
Attribute description
AttributeFlag
string
Specifies whether the attribute is created or updated
Possible values: ‘ADD’ or ‘EDIT’
LastModified
string
Last date when the attribute was modified.
If the attribute was created this date will be the created date
CreatedDate
string
Date on which the attribute was created
UnitList
array List of Attribute Units



Attribute Unit Collection

Property Type Data Type Description
AttributeTypeUnitId
int
Attribute unit ID
AttributeTypeUnitCode
string
Attribute unit code
AttributeTypeUnitDesc
string
Attribute unit description