POST person/create?Token={Token}
Create person in the system. Application privilege "New" for licensed agenda "Persons" required. Application privilege "Edit" for agenda item "Identifiers" of licensed agenda "Persons" required.
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
PersonCreateReqName | 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 |
Required String length: inclusive between 0 and 100 |
Surname |
The surname of the person |
string |
Required String length: inclusive between 0 and 100 |
OrganizationStructure |
The involvement of the person in the organization structure. This is mandatory parameter for non-cloud solution. Do not use for cloud solution. |
string |
None. |
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 |
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 100 |
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":0,"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>0</Sex> <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>
text/json
{ "PersonId": "sample string 1", "Name": "sample string 2", "Surname": "sample string 3", "OrganizationStructure": "sample string 4", "Email": "sample string 5", "LoginName": "sample string 6", "IdentifierEntryCode": "sample string 7", "IdentifierCard1": "sample string 8", "IdentifierCard2": "sample string 9", "Department": "sample string 10", "EmployeePosition": "sample string 11", "PhoneNumber": "sample string 12", "MobilPhoneNumber": "sample string 13", "Desc": "sample string 14", "DegreeInFrontName": "sample string 15", "DegreeAfterName": "sample string 16", "Sex": 17, "PIN": "sample string 18", "UdsCollection": [ { "SystemName": "sample string 1", "Value": "sample string 2" }, { "SystemName": "sample string 1", "Value": "sample string 2" } ] }
text/xml
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PersonId>sample string 1</PersonId> <Name>sample string 2</Name> <Surname>sample string 3</Surname> <OrganizationStructure>sample string 4</OrganizationStructure> <Email>sample string 5</Email> <LoginName>sample string 6</LoginName> <IdentifierEntryCode>sample string 7</IdentifierEntryCode> <IdentifierCard1>sample string 8</IdentifierCard1> <IdentifierCard2>sample string 9</IdentifierCard2> <Department>sample string 10</Department> <EmployeePosition>sample string 11</EmployeePosition> <PhoneNumber>sample string 12</PhoneNumber> <MobilPhoneNumber>sample string 13</MobilPhoneNumber> <Desc>sample string 14</Desc> <DegreeInFrontName>sample string 15</DegreeInFrontName> <DegreeAfterName>sample string 16</DegreeAfterName> <Sex>17</Sex> <PIN>sample string 18</PIN> <UdsCollection> <UdsIn> <SystemName>sample string 1</SystemName> <Value>sample string 2</Value> </UdsIn> <UdsIn> <SystemName>sample string 1</SystemName> <Value>sample string 2</Value> </UdsIn> </UdsCollection> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Processed with result: ExecOK |
201 request accepted | 1107 | Person created without identifier. Entry code constraint found |
201 request accepted | 1108 | Person created without identifier. Card 1 constraint found |
201 request accepted | 1109 | Person created without identifier. Card 2 constraint found |
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 | 1105 | Application privilege New for licensed agenda Persons violated for person [{0}] |
403 server refuses fo fulfill the request | 2123 | Application privilege Edit for of agenda item Identifiers of licensed agenda Persons violated for person [{0}] |
403 server refuses fo fulfill the request | 1014 | Uds column saving failed. Issue: [{0}] |
403 server refuses fo fulfill the request | 1 | Db operation failed, agenda missing priviliges |
403 server refuses fo fulfill the request | 2 | Db operation failed, record missing priviliges |
403 server refuses fo fulfill the request | 3 | Db operation failed, Record duplicity |
403 server refuses fo fulfill the request | 4 | Db operation failed, already changed by another user |
403 server refuses fo fulfill the request | 5 | Db operation failed, already deleted by another user |
403 server refuses fo fulfill the request | 6 | Db operation failed, database data consistence violation |
403 server refuses fo fulfill the request | 7 | Db operation failed, operation can not be executed because another problems occured |
403 server refuses fo fulfill the request | 8 | Db operation failed, licence violation |
403 server refuses fo fulfill the request | 1115 | Unique key PersonId {0} is not unique |
404 required resource does not exist on the server | 1106 | Create PersonId [{0}] failed |
404 required resource does not exist on the server | 1110 | Create PersonId [{0}] failed |
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
BaseRespOfPersonCreateReqName | Description | Type | Additional information |
---|---|---|---|
Result | RequestResult |
None. |
|
Request | PersonCreateReq |
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":0,"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>0</Sex> <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>
text/json
{ "Result": { "Message": "sample string 1", "Code": 2, "ModelStateErr": [ "sample string 1", "sample string 2" ] }, "Request": { "PersonId": "sample string 1", "Name": "sample string 2", "Surname": "sample string 3", "OrganizationStructure": "sample string 4", "Email": "sample string 5", "LoginName": "sample string 6", "IdentifierEntryCode": "sample string 7", "IdentifierCard1": "sample string 8", "IdentifierCard2": "sample string 9", "Department": "sample string 10", "EmployeePosition": "sample string 11", "PhoneNumber": "sample string 12", "MobilPhoneNumber": "sample string 13", "Desc": "sample string 14", "DegreeInFrontName": "sample string 15", "DegreeAfterName": "sample string 16", "Sex": 17, "PIN": "sample string 18", "UdsCollection": [ { "SystemName": "sample string 1", "Value": "sample string 2" }, { "SystemName": "sample string 1", "Value": "sample string 2" } ] } }
text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Result> <Message>sample string 1</Message> <Code>2</Code> <ModelStateErr> <string>sample string 1</string> <string>sample string 2</string> </ModelStateErr> </Result> <Request> <PersonId>sample string 1</PersonId> <Name>sample string 2</Name> <Surname>sample string 3</Surname> <OrganizationStructure>sample string 4</OrganizationStructure> <Email>sample string 5</Email> <LoginName>sample string 6</LoginName> <IdentifierEntryCode>sample string 7</IdentifierEntryCode> <IdentifierCard1>sample string 8</IdentifierCard1> <IdentifierCard2>sample string 9</IdentifierCard2> <Department>sample string 10</Department> <EmployeePosition>sample string 11</EmployeePosition> <PhoneNumber>sample string 12</PhoneNumber> <MobilPhoneNumber>sample string 13</MobilPhoneNumber> <Desc>sample string 14</Desc> <DegreeInFrontName>sample string 15</DegreeInFrontName> <DegreeAfterName>sample string 16</DegreeAfterName> <Sex>17</Sex> <PIN>sample string 18</PIN> <UdsCollection> <UdsIn> <SystemName>sample string 1</SystemName> <Value>sample string 2</Value> </UdsIn> <UdsIn> <SystemName>sample string 1</SystemName> <Value>sample string 2</Value> </UdsIn> </UdsCollection> </Request> </Response>