Attribute Master API

Modified on Thu, 07 Jan 2021 at 09:46 AM

API Details

ParticularsDescription
API NameAttribute Master
MethodPOST
URLhttps://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 NameData TypeDescriptionMandatoryRemarks
SubscriptionName
string
Subscription name of the account
Yes
Max length = 10 characters
TokenstringSecurity check. To verify the account and request
Yes
Fromdate
stringTo fetch attribute changes from the date mentioned.
Date format: dd-mm-yyyy
Optional
If not mentioned then the current attribute details are returned
Todate
stringTo fetch attribute changes till the date mentioned
Date format: dd-mm-yyyy
Optional
If Fromdate is mentioned then Todate is mandatory



Response

Property NameData TypeDescription
MessagestringResponse message from the server
CodeintResponse code from the server
AttributeMaster
arrayList of Attribute Master



Response Code and Message

CodeMessageRemarks
1Success
Successful API call
3Invalid 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
4Internal Server Error
The API execution faced an unexpected error
5Invalid date format
Use date format as dd-mm-yyyy
6Token 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 NameData TypeDescription
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
arrayList of Attribute Units



Attribute Unit Collection

Property TypeData TypeDescription
AttributeTypeUnitId
int
Attribute unit ID
AttributeTypeUnitCode
string
Attribute unit code
AttributeTypeUnitDesc
string
Attribute unit description


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article