POST person/update?Token={Token}
Retrieve photo for specific person. Application privilege "View" for licensed agenda "Persons" required. Data may also be restricted by record permission "View" of agenda "Persons".Functionality may also be restricted by record permission "View Photo" of "Person permissions".
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
PersonUpdateReqName | Description | Type | Additional information |
---|---|---|---|
PersonId |
Unique identification of the person in the system |
string |
Required String length: inclusive between 0 and 100 |
Name |
The name of the person |
string |
String length: inclusive between 0 and 100 |
Surname |
The surname of the person |
string |
String length: inclusive between 0 and 100 |
OrganizationStructure |
The involvement of the person in the organization structure |
string |
String length: inclusive between 0 and 4000 |
Email address of the person |
string |
String length: inclusive between 0 and 200 |
|
LoginName |
Login name of the person. For Aktion.NEXT only |
string |
String length: inclusive between 0 and 100 |
IdentifierEntryCode |
Entry code of the person |
string |
Matching regular expression pattern: [0-9]+ String length: inclusive between 6 and 6 |
IdentifierCard1 |
First card identifier of the person |
string |
Matching regular expression pattern: [0-9a-fA-F]+ String length: inclusive between 0 and 20 |
IdentifierCard2 |
Another card identifier of the person. For Aktion.NEXT only |
string |
Matching regular expression pattern: [0-9a-fA-F]+ String length: inclusive between 0 and 20 |
Department |
Department. For Aktion CLOUD only |
string |
String length: inclusive between 0 and 100 |
EmployeePosition |
Employee position |
string |
String length: inclusive between 0 and 200 |
PhoneNumber |
Phone number of the person |
string |
String length: inclusive between 0 and 100 |
MobilPhoneNumber |
Mobile phone number of the person |
string |
String length: inclusive between 0 and 100 |
Desc |
The description of the person |
string |
String length: inclusive between 0 and 4000 |
DegreeInFrontName |
Academic degree in front of the name |
string |
String length: inclusive between 0 and 30 |
DegreeAfterName |
Academic degree after the name |
string |
String length: inclusive between 0 and 30 |
Sex |
Sex of the person. {Default value is 0 and the meaning is: 0 - undefined; 1 - male; 2 - female } |
integer |
Matching regular expression pattern: [0,1,2] |
PIN |
PIN code of the person |
string |
Matching regular expression pattern: [0-9]+ String length: inclusive between 4 and 4 |
UdsCollection |
The collection of available user defined columns of the agenda in the system:
|
Collection of UdsIn |
None. |
Request Formats
application/json
{"PersonId":"100200300","Name":"John","Surname":"Doo","OrganizationStructure":"Structure - Company - Office 1","Email":"John.Doo@speedy.com","LoginName":"John.Doo","IdentifierEntryCode":"693723","IdentifierCard1":"A1B2C3D4E5","IdentifierCard2":"B1C2D3E4F5","Department":"Department 1","EmployeePosition":"Salesman","PhoneNumber":null,"MobilPhoneNumber":null,"Desc":null,"DegreeInFrontName":null,"DegreeAfterName":null,"Sex":null,"PIN":"1234","UdsCollection":[{"SystemName":"a2s1","Value":"text in column"},{"SystemName":"a2s2","Value":"2022-01-26T05:55:22"},{"SystemName":"a2s3","Value":"1"}]}
application/xml
<Request> <PersonId>100200300</PersonId> <Name>John</Name> <Surname>Doo</Surname> <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure> <Email>John.Doo@speedy.com</Email> <LoginName>John.Doo</LoginName> <IdentifierEntryCode>693723</IdentifierEntryCode> <IdentifierCard1>A1B2C3D4E5</IdentifierCard1> <IdentifierCard2>B1C2D3E4F5</IdentifierCard2> <Department>Department 1</Department> <EmployeePosition>Salesman</EmployeePosition> <Sex d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" /> <PIN>1234</PIN> <UdsCollection> <UdsIn> <SystemName>a2s1</SystemName> <Value>text in column</Value> </UdsIn> <UdsIn> <SystemName>a2s2</SystemName> <Value>2022-01-26T05:55:22</Value> </UdsIn> <UdsIn> <SystemName>a2s3</SystemName> <Value>1</Value> </UdsIn> </UdsCollection> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 server refuses fo fulfill the request | 1101 | Application privilege View for licensed agenda Persons violated for person [{0}] |
403 server refuses fo fulfill the request | 2124 | Application privilege View for of agenda item Fingerprints of licensed agenda Persons violated for person [{0}] |
403 server refuses fo fulfill the request | 2126 | Record permission View of agenda Persons violated for [{0}] |
404 required resource does not exist on the server | 1100 | PersonId [{0}] not found |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
PersonGetPhotoRespName | Description | Type | Additional information |
---|---|---|---|
PersonId |
Unique identification of the person in the system |
string |
None. |
Photo |
Photo of the person |
Collection of byte |
None. |
Response Formats
application/json
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"100200300","Name":"John","Surname":"Doo","OrganizationStructure":"Structure - Company - Office 1","Email":"John.Doo@speedy.com","LoginName":"John.Doo","IdentifierEntryCode":"693723","IdentifierCard1":"A1B2C3D4E5","IdentifierCard2":"B1C2D3E4F5","Department":"Department 1","EmployeePosition":"Salesman","PhoneNumber":null,"MobilPhoneNumber":null,"Desc":null,"DegreeInFrontName":null,"DegreeAfterName":null,"Sex":null,"PIN":"1234","UdsCollection":[{"SystemName":"a2s1","Value":"text in column"},{"SystemName":"a2s2","Value":"2022-01-26T05:55:22"},{"SystemName":"a2s3","Value":"1"}]}}
application/xml
<Response> <Result> <Message>Processed with result: ExecOK</Message> <Code>0</Code> </Result> <Request> <PersonId>100200300</PersonId> <Name>John</Name> <Surname>Doo</Surname> <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure> <Email>John.Doo@speedy.com</Email> <LoginName>John.Doo</LoginName> <IdentifierEntryCode>693723</IdentifierEntryCode> <IdentifierCard1>A1B2C3D4E5</IdentifierCard1> <IdentifierCard2>B1C2D3E4F5</IdentifierCard2> <Department>Department 1</Department> <EmployeePosition>Salesman</EmployeePosition> <Sex d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" /> <PIN>1234</PIN> <UdsCollection> <UdsIn> <SystemName>a2s1</SystemName> <Value>text in column</Value> </UdsIn> <UdsIn> <SystemName>a2s2</SystemName> <Value>2022-01-26T05:55:22</Value> </UdsIn> <UdsIn> <SystemName>a2s3</SystemName> <Value>1</Value> </UdsIn> </UdsCollection> </Request> </Response>