POST person/createActivity?Token={Token}

Create person activity. Application privilege "Edit" for licensed agenda "Persons" required. Application privilege "Edit" for agenda item "Activities" of licensed agenda "Persons" required. Application privilege "New" of licensed agenda "Activities" required. Application privilege "View" of licensed agenda "Activity types" required. Functionality may also be restricted by record permission "Edit" of agenda "Person" and permision "View" of agenda "Activity types".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method disabled by configuration

URI Parameters

NameDescriptionTypeAdditional 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

PersonActivityCreateReq
NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system

 string

Required

String length: inclusive between 0 and 100
Activity

Person activity encapsulating object

 PersonActivity

Required

Request Formats

application/json

Sample: 
{"PersonId":"1023478","Activity":{"ActivityType":{"Title":"Activity A","Shortcut":"AA","Frequency":0,"Signed":0},"ValidFrom":"\/Date(1729202400000)\/","ValidTo":"\/Date(1729288800000)\/","Description":"Some description of this activity","Attachment":null}}

application/xml

Sample: 

<Request>
  <PersonId>1023478</PersonId>
  <Activity>
    <ActivityType>
      <Title>Activity A</Title>
      <Shortcut>AA</Shortcut>
      <Frequency>0</Frequency>
      <Signed>0</Signed>
    </ActivityType>
    <ValidFrom>2024-10-18T00:00:00+02:00</ValidFrom>
    <ValidTo>2024-10-19T00:00:00+02:00</ValidTo>
    <Description>Some description of this activity</Description>
  </Activity>
</Request>

text/json

Sample: 
{
  "PersonId": "sample string 1",
  "Activity": {
    "ActivityType": {
      "Title": "sample string 1",
      "Shortcut": "sample string 2",
      "Frequency": 3,
      "Signed": 4
    },
    "ValidFrom": "2024-10-18T13:27:45.9340814+02:00",
    "ValidTo": "2024-10-18T13:27:45.9340814+02:00",
    "Description": "sample string 1",
    "Attachment": {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Path": "sample string 3",
      "Data": "QEA="
    }
  }
}

text/xml

Sample: 
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>sample string 1</PersonId>
  <Activity>
    <ActivityType>
      <Title>sample string 1</Title>
      <Shortcut>sample string 2</Shortcut>
      <Frequency>3</Frequency>
      <Signed>4</Signed>
    </ActivityType>
    <ValidFrom>2024-10-18T13:27:45.9340814+02:00</ValidFrom>
    <ValidTo>2024-10-18T13:27:45.9340814+02:00</ValidTo>
    <Description>sample string 1</Description>
    <Attachment>
      <Name>sample string 1</Name>
      <Description>sample string 2</Description>
      <Path>sample string 3</Path>
      <Data>QEA=</Data>
    </Attachment>
  </Activity>
</Request>

Response Information

Response Codes

Http CodeError NumberDescription
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 1102 Application privilege Edit for licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 2122 Application privilege Edit for of agenda item Fingerprints of licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 1117 Create activity of type [{0}] for person [{1}] failed. Exception:{2}
403 server refuses fo fulfill the request 2129 Application privilege New of agenda Acivities violated for [all]
403 server refuses fo fulfill the request 2130 Application privilege View of agenda Activity types violated for [all]
403 server refuses fo fulfill the request 2131 Record permission View of agenda Activity types 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

BaseRespOfPersonActivityCreateReq
NameDescriptionTypeAdditional information
Result

RequestResult

None.
Request

PersonActivityCreateReq

None.

Response Formats

application/json

Sample: 
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"1023478","Activity":{"ActivityType":{"Title":"Activity A","Shortcut":"AA","Frequency":0,"Signed":0},"ValidFrom":"\/Date(1729202400000)\/","ValidTo":"\/Date(1729288800000)\/","Description":"Some description of this activity","Attachment":null}}}

application/xml

Sample: 

<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <PersonId>1023478</PersonId>
    <Activity>
      <ActivityType>
        <Title>Activity A</Title>
        <Shortcut>AA</Shortcut>
        <Frequency>0</Frequency>
        <Signed>0</Signed>
      </ActivityType>
      <ValidFrom>2024-10-18T00:00:00+02:00</ValidFrom>
      <ValidTo>2024-10-19T00:00:00+02:00</ValidTo>
      <Description>Some description of this activity</Description>
    </Activity>
  </Request>
</Response>

text/json

Sample: 
{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "PersonId": "sample string 1",
    "Activity": {
      "ActivityType": {
        "Title": "sample string 1",
        "Shortcut": "sample string 2",
        "Frequency": 3,
        "Signed": 4
      },
      "ValidFrom": "2024-10-18T13:27:45.9531161+02:00",
      "ValidTo": "2024-10-18T13:27:45.9531161+02:00",
      "Description": "sample string 1",
      "Attachment": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Path": "sample string 3",
        "Data": "QEA="
      }
    }
  }
}

text/xml

Sample: 
<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>
    <Activity>
      <ActivityType>
        <Title>sample string 1</Title>
        <Shortcut>sample string 2</Shortcut>
        <Frequency>3</Frequency>
        <Signed>4</Signed>
      </ActivityType>
      <ValidFrom>2024-10-18T13:27:45.9531161+02:00</ValidFrom>
      <ValidTo>2024-10-18T13:27:45.9531161+02:00</ValidTo>
      <Description>sample string 1</Description>
      <Attachment>
        <Name>sample string 1</Name>
        <Description>sample string 2</Description>
        <Path>sample string 3</Path>
        <Data>QEA=</Data>
      </Attachment>
    </Activity>
  </Request>
</Response>