Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Employee ID

string

Required

Body Parameters

None.

Response Information

Resource Description

ReturnUserNicknameResponse

ReturnUserNicknameResponse
NameDescriptionTypeAdditional information
Header

Return User Nickname Response message header.

ResponseHeader

None.

Body

Return User Nickname Response message body.

ReturnUserNicknameResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

string

None.

StatusCode

Status code

ResponseStatus

None.

Status

Status

string

None.

ErrorId

Error id

string

None.

Response Body Description

ReturnUserNicknameResponseBody
NameDescriptionTypeAdditional information
UserId

User ID

string

None.

UserNickname

Middle Name / Nickname

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "UserId": "User01",
    "UserNickname": "A"
  }
}

application/xml, text/xml

Sample:
<ReturnUserNicknameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User">
  <Body>
    <UserId>User01</UserId>
    <UserNickname>A</UserNickname>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId i:nil="true" />
    <d2p1:Message></d2p1:Message>
    <d2p1:Status>Ok</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</ReturnUserNicknameResponse>

© 2025 Sargent and Greenleaf